Sparksee  5.2.0
STSTypeExporter Class Reference

Base TypeExporter class. More...

Inheritance diagram for STSTypeExporter:
Inheritance graph
Collaboration diagram for STSTypeExporter:
Collaboration graph

Instance Methods

(void) - registerListener:
 Registers a new listener.
 
(void) - run
 Runs export process.
 
(void) - setRowWriter:
 Sets the output data destination.
 
(void) - setGraph:
 Sets the graph that will be exported.
 
(void) - setType:
 Sets the type to be exported.
 
(void) - setAttributes:
 Sets the list of Attributes.
 
(void) - setFrequency:
 Sets the frequency of listener notification.
 
(void) - setHeader:
 Sets the presence of a header row.
 

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

Method Documentation

- (void) registerListener: (STSTypeExporterListener *)  tel

Registers a new listener.

Parameters
tel[in] TypeExporterListener to be registered.
- (void) run

Runs export process.

Exceptions
System.IO.IOExceptionIf bad things happen writing to the RowWriter.
System.ApplicationExceptionnull

Implemented in STSEdgeTypeExporter, and STSNodeTypeExporter.

- (void) setAttributes: (STSAttributeList *)  attrs

Sets the list of Attributes.

Parameters
attrs[in] Attribute identifiers to be exported
- (void) 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) setGraph: (STSGraph *)  graph

Sets the graph that will be exported.

Parameters
graph[in] Graph.
- (void) 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) setRowWriter: (STSRowWriter *)  rw

Sets the output data destination.

Parameters
rw[in] Input RowWriter.
- (void) setType: (int)  type

Sets the type to be exported.

Parameters
type[in] Type identifier.

The documentation for this class was generated from the following file: