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

Base TypeExporter class. More...

Inheritance diagram for com.sparsity.sparksee.io.TypeExporter:
Inheritance graph

Public Member Functions

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 Run () throws System.IO.IOException, System.ApplicationException
 Runs export process. More...
 
void Register (com.sparsity.sparksee.io.TypeExporterListener tel)
 Registers a new listener. More...
 
void SetType (int t)
 Sets the type to be exported. More...
 
void SetHeader (bool header)
 Sets the presence of a header row. More...
 
void SetGraph (com.sparsity.sparksee.gdb.Graph g)
 Sets the graph that will be exported. More...
 
void SetAttributes (com.sparsity.sparksee.gdb.AttributeList attrs)
 Sets the list of Attributes. More...
 

Detailed Description

Base TypeExporter class.

Base class to export a node or edge type from a graph using a RowWriter.

TypeExporterListener can be registered to receive information about the progress of the export process by means of TypeExporterEvent. The default frequency of notification to listeners is 100000.

By default no header row is created.

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

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

Member Function Documentation

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

Registers a new listener.

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

Runs export process.

Exceptions
System.IO.IOExceptionIf bad things happen writing to the RowWriter.
System.ApplicationExceptionnull
void com.sparsity.sparksee.io.TypeExporter.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.TypeExporter.SetFrequency ( int  freq)

Sets the frequency of listener notification.

freq [in] Frequency in number of rows managed to notify progress to all listeners

Parameters
freqnull
void com.sparsity.sparksee.io.TypeExporter.SetGraph ( com.sparsity.sparksee.gdb.Graph  g)

Sets the graph that will be exported.

Parameters
g[in] Graph.
void com.sparsity.sparksee.io.TypeExporter.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.TypeExporter.SetRowWriter ( com.sparsity.sparksee.io.RowWriter  rw)

Sets the output data destination.

rr[in] Input RowWriter.

Parameters
rwnull
void com.sparsity.sparksee.io.TypeExporter.SetType ( int  t)

Sets the type to be exported.

Parameters
t[in] Type identifier.