Sparksee  5.2.0
STSNodeTypeExporter Class Reference

NodeTypeExporter class. More...

Inheritance diagram for STSNodeTypeExporter:
Inheritance graph
Collaboration diagram for STSNodeTypeExporter:
Collaboration graph

Instance Methods

(id) - init
 Creates a new instance.
 
(id) - initWithRowWriter:graph:type:attrs:
 Creates a new instance.
 
(void) - run
 See the TypeExporter class Run method.
 
(void) - registerListener:
 Registers a new listener.
 
(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

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

Method Documentation

- (id) initWithRowWriter: (STSRowWriter *)  rowWriter
graph: (STSGraph *)  graph
type: (int)  type
attrs: (STSAttributeList *)  attrs 

Creates a new instance.

Parameters
rowWriter[in] Output RowWriter.
graph[in] Graph.
type[in] Type identifier.
attrs[in] Attribute identifiers to be exported.
- (void) registerListener: (STSTypeExporterListener *)  tel

Registers a new listener.

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

See the TypeExporter class Run method.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implements STSTypeExporter.

- (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: