DexNet 4.7.0
Public Member Functions
com::sparsity::dex::io::TypeExporter Class Reference

Base TypeExporter class. More...

Inheritance diagram for com::sparsity::dex::io::TypeExporter:
Inheritance graph

List of all members.

Public Member Functions

void SetRowWriter (com.sparsity.dex.io.RowWriter rw)
 Sets the output data destination.
void Run () throws System.IO.IOException, System.ApplicationException
 Runs export process.
void Register (com.sparsity.dex.io.TypeExporterListener tel)
 Registers a new listener.
void SetHeader (bool header)
 Sets the presence of a header row.
void SetFrequency (int freq)
 Sets the frequency of listener notification.
void SetAttributes (com.sparsity.dex.gdb.AttributeList attrs)
 Sets the list of Attributes.
void SetGraph (com.sparsity.dex.gdb.Graph g)
 Sets the graph that will be exported.
void SetType (int t)
 Sets the type to be exported.

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.

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

Member Function Documentation

void com::sparsity::dex::io::TypeExporter::Register ( com.sparsity.dex.io.TypeExporterListener  tel)

Registers a new listener.

Parameters:
tel[in] TypeExporterListener to be registered.

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::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

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::io::TypeExporter::SetAttributes ( com.sparsity.dex.gdb.AttributeList  attrs)

Sets the list of Attributes.

Parameters:
attrs[in] Attribute identifiers to be exported

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::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

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::io::TypeExporter::SetGraph ( com.sparsity.dex.gdb.Graph  g)

Sets the graph that will be exported.

Parameters:
g[in] Graph.

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::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.

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::io::TypeExporter::SetRowWriter ( com.sparsity.dex.io.RowWriter  rw)

Sets the output data destination.

rr[in] Input RowWriter.

Parameters:
rwnull

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.

void com::sparsity::dex::io::TypeExporter::SetType ( int  t)

Sets the type to be exported.

Parameters:
t[in] Type identifier.

Reimplemented in com::sparsity::dex::io::EdgeTypeExporter, and com::sparsity::dex::io::NodeTypeExporter.