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

EdgeTypeExporter class. More...

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

Public Member Functions

void SetTailAttribute (int attr)
 Sets the attribute that will be used to get the value to be dumped for the tail of the edge. More...
 
void SetFrequency (int freq)
 Sets the frequency of listener notification. More...
 
void SetType (int t)
 Sets the type to be exported. More...
 
void SetHeadAttribute (int attr)
 Sets the attribute that will be used to get the value to be dumped for the head of the edge. More...
 
 EdgeTypeExporter (com.sparsity.sparksee.io.RowWriter rw, com.sparsity.sparksee.gdb.Graph g, int t, com.sparsity.sparksee.gdb.AttributeList attrs, int hPos, int tPos, int hAttr, int tAttr)
 Creates a new instance. More...
 
void SetTailPosition (int pos)
 Sets the position (index column) of the tail attribute in the exported data. More...
 
void SetGraph (com.sparsity.sparksee.gdb.Graph g)
 Sets the graph that will be exported. More...
 
void SetRowWriter (com.sparsity.sparksee.io.RowWriter rw)
 Sets the output data destination. 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...
 
 EdgeTypeExporter ()
 Creates a new instance.
 
void SetHeader (bool header)
 Sets the presence of a header row. More...
 
void SetHeadPosition (int pos)
 Sets the position (index column) of the head attribute in the exported data. More...
 
void SetAttributes (com.sparsity.sparksee.gdb.AttributeList attrs)
 Sets the list of Attributes. More...
 

Detailed Description

EdgeTypeExporter class.

Specific TypeExporter implementation for edge 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.EdgeTypeExporter.EdgeTypeExporter ( com.sparsity.sparksee.io.RowWriter  rw,
com.sparsity.sparksee.gdb.Graph  g,
int  t,
com.sparsity.sparksee.gdb.AttributeList  attrs,
int  hPos,
int  tPos,
int  hAttr,
int  tAttr 
)

Creates a new instance.

Parameters
rw[in] Output RowWriter.
g[in] Graph.
t[in] Type identifier.
attrs[in] Attribute identifiers to be exported.
hPos[in] The position (index column) for the head value.
tPos[in] The position (index column) for the tail value.
hAttr[in] The attribute identifier to get the value to be dumped for the head.
tAttr[in] The attribute identifier to get the value to be dumped for the tail.

Member Function Documentation

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

Registers a new listener.

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

See the TypeExporter class Run method.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull
void com.sparsity.sparksee.io.EdgeTypeExporter.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.EdgeTypeExporter.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.EdgeTypeExporter.SetGraph ( com.sparsity.sparksee.gdb.Graph  g)

Sets the graph that will be exported.

Parameters
g[in] Graph.
void com.sparsity.sparksee.io.EdgeTypeExporter.SetHeadAttribute ( int  attr)

Sets the attribute that will be used to get the value to be dumped for the head of the edge.

Parameters
attr[in] Head Attribute
void com.sparsity.sparksee.io.EdgeTypeExporter.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.EdgeTypeExporter.SetHeadPosition ( int  pos)

Sets the position (index column) of the head attribute in the exported data.

Parameters
pos[in] Head position
void com.sparsity.sparksee.io.EdgeTypeExporter.SetRowWriter ( com.sparsity.sparksee.io.RowWriter  rw)

Sets the output data destination.

rr[in] Input RowWriter.

Parameters
rwnull
void com.sparsity.sparksee.io.EdgeTypeExporter.SetTailAttribute ( int  attr)

Sets the attribute that will be used to get the value to be dumped for the tail of the edge.

Parameters
attr[in] Tail Attribute
void com.sparsity.sparksee.io.EdgeTypeExporter.SetTailPosition ( int  pos)

Sets the position (index column) of the tail attribute in the exported data.

Parameters
pos[in] Tail position
void com.sparsity.sparksee.io.EdgeTypeExporter.SetType ( int  t)

Sets the type to be exported.

Parameters
t[in] Type identifier.