SparkseeNet  5.1.0
Public Member Functions | List of all members
com.sparsity.sparksee.io.NodeTypeExporter Class Reference

NodeTypeExporter class. More...

Inheritance diagram for com.sparsity.sparksee.io.NodeTypeExporter:
Inheritance graph
Collaboration diagram for com.sparsity.sparksee.io.NodeTypeExporter:
Collaboration graph

Public Member Functions

 NodeTypeExporter (com.sparsity.sparksee.io.RowWriter rowWriter, com.sparsity.sparksee.gdb.Graph graph, int type, com.sparsity.sparksee.gdb.AttributeList attrs)
 Creates a new instance. More...
 
void SetRowWriter (com.sparsity.sparksee.io.RowWriter rw)
 Sets the output data destination. More...
 
void SetFrequency (int freq)
 Sets the frequency of listener notification. More...
 
void Register (com.sparsity.sparksee.io.TypeExporterListener tel)
 Registers a new listener. More...
 
void Run () throws System.IO.IOException, System.ApplicationException
 See the TypeExporter class Run method. More...
 
void SetGraph (com.sparsity.sparksee.gdb.Graph graph)
 Sets the graph that will be exported. More...
 
void SetHeader (bool header)
 Sets the presence of a header row. More...
 
void SetType (int type)
 Sets the type to be exported. More...
 
 NodeTypeExporter ()
 Creates a new instance.
 
void SetAttributes (com.sparsity.sparksee.gdb.AttributeList attrs)
 Sets the list of Attributes. More...
 

Detailed Description

NodeTypeExporter class.

Specific TypeExporter implementation for node types.

Check out the 'Data export' section in the SPARKSEE User Manual for more details on this.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

com.sparsity.sparksee.io.NodeTypeExporter.NodeTypeExporter ( com.sparsity.sparksee.io.RowWriter  rowWriter,
com.sparsity.sparksee.gdb.Graph  graph,
int  type,
com.sparsity.sparksee.gdb.AttributeList  attrs 
)

Creates a new instance.

Parameters
rowWriter[in] Output RowWriter.
graph[in] Graph.
type[in] Type identifier.
attrs[in] Attribute identifiers to be exported.

Member Function Documentation

void com.sparsity.sparksee.io.NodeTypeExporter.Register ( com.sparsity.sparksee.io.TypeExporterListener  tel)

Registers a new listener.

Parameters
tel[in] TypeExporterListener to be registered.
void com.sparsity.sparksee.io.NodeTypeExporter.Run ( ) throws System.IO.IOException, System.ApplicationException

See the TypeExporter class Run method.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull
void com.sparsity.sparksee.io.NodeTypeExporter.SetAttributes ( com.sparsity.sparksee.gdb.AttributeList  attrs)

Sets the list of Attributes.

Parameters
attrs[in] Attribute identifiers to be exported
void com.sparsity.sparksee.io.NodeTypeExporter.SetFrequency ( int  freq)

Sets the frequency of listener notification.

Parameters
freq[in] Frequency in number of rows managed to notify progress to all listeners
void com.sparsity.sparksee.io.NodeTypeExporter.SetGraph ( com.sparsity.sparksee.gdb.Graph  graph)

Sets the graph that will be exported.

Parameters
graph[in] Graph.
void com.sparsity.sparksee.io.NodeTypeExporter.SetHeader ( bool  header)

Sets the presence of a header row.

Parameters
header[in] If TRUE, a header row is dumped with the name of the attributes.
void com.sparsity.sparksee.io.NodeTypeExporter.SetRowWriter ( com.sparsity.sparksee.io.RowWriter  rw)

Sets the output data destination.

Parameters
rw[in] Input RowWriter.
void com.sparsity.sparksee.io.NodeTypeExporter.SetType ( int  type)

Sets the type to be exported.

Parameters
type[in] Type identifier.