Sparksee  5.2.0
STSEdgeTypeLoader Class Reference

EdgeTypeLoader class. More...

Inheritance diagram for STSEdgeTypeLoader:
Inheritance graph
Collaboration diagram for STSEdgeTypeLoader:
Collaboration graph

Instance Methods

(id) - init
 Creates a new instance.
 
(id) - initWithRowReader:graph:type:attrs:attrsPos:hPos:tPos:hAttr:tAttr:
 Creates a new instance.
 
(void) - run
 See the TypeLoader class Run method.
 
(void) - runTwoPhases
 See the TypeLoader class RunTwoPhases method.
 
(void) - runNPhases:
 See the TypeLoader class RunNPhases method.
 
(void) - setHeadAttribute:
 Sets the attribute that will be used to find the head of the edge.
 
(void) - setHeadPosition:
 Sets the position of the head attribute in the source data.
 
(void) - setTailAttribute:
 Sets the attribute that will be used to find the tail of the edge.
 
(void) - setTailPosition:
 Sets the position of the tail attribute in the source data.
 
(void) - setLogError:
 Sets a log error file.
 
(void) - setLogOff
 Truns off all the error reporting.
 
(void) - registerListener:
 Registers a new listener.
 
(void) - setRowReader:
 Sets the input data source.
 
(void) - setGraph:
 Sets the graph where the data will be loaded.
 
(void) - setLocale:
 Sets the locale that will be used to read the data.
 
(void) - setType:
 Sets the type to be loaded.
 
(void) - setAttributes:
 Sets the list of Attributes.
 
(void) - setAttributePositions:
 Sets the list of attribute positions.
 
(void) - setTimestampFormat:
 Sets a specific timestamp format.
 
(void) - setFrequency:
 Sets the frequency of listener notification.
 

Detailed Description

EdgeTypeLoader class.

Specific TypeLoader implementation for edge types.

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

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

Method Documentation

- (id) initWithRowReader: (STSRowReader *)  rowReader
graph: (STSGraph *)  graph
type: (int)  type
attrs: (STSAttributeList *)  attrs
attrsPos: (STSInt32List *)  attrsPos
hPos: (int)  hPos
tPos: (int)  tPos
hAttr: (int)  hAttr
tAttr: (int)  tAttr 

Creates a new instance.

Parameters
rowReader[in] Input RowReader.
graph[in] Graph.
type[in] Type identifier.
attrs[in] Attribute identifiers to be loaded.
attrsPos[in] Attribute positions (column index >=0). to all listeners.
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 for the head.
tAttr[in] The attribute identifier for the tail.
- (void) registerListener: (STSTypeLoaderListener *)  tel

Registers a new listener.

Parameters
telTypeLoaderListener to be registered.
- (void) run

See the TypeLoader class Run method.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implements STSTypeLoader.

- (void) runNPhases: (int)  partitions

See the TypeLoader class RunNPhases method.

Parameters
partitionsnull
Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implements STSTypeLoader.

- (void) runTwoPhases

See the TypeLoader class RunTwoPhases method.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implements STSTypeLoader.

- (void) setAttributePositions: (STSInt32List *)  attrsPos

Sets the list of attribute positions.

Parameters
attrsPos[in] Attribute positions (column index >=0).
- (void) setAttributes: (STSAttributeList *)  attrs

Sets the list of Attributes.

Parameters
attrs[in] Attribute identifiers to be loaded
- (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 where the data will be loaded.

Parameters
graph[in] Graph.
- (void) setHeadAttribute: (int)  attr

Sets the attribute that will be used to find the head of the edge.

This method is protected because only the Edge loaders should have it.

Parameters
attr[in] Head Attribute
- (void) setHeadPosition: (int)  pos

Sets the position of the head attribute in the source data.

This method is protected because only the Edge loaders should have it.

Parameters
pos[in] Head position
- (void) setLocale: (NSString *)  localeStr

Sets the locale that will be used to read the data.

It should match the locale used in the rowreader.

Parameters
localeStr[in] The locale string for the read data. See CSVReader.
- (void) setLogError: (NSString *)  path

Sets a log error file.

By default errors are thrown as a exception and the load process ends. If a log file is set, errors are logged there and the load process does not stop.

Parameters
path[in] The path to the error log file.
Exceptions
System.IO.IOExceptionIf bad things happen opening the file.
- (void) setLogOff

Truns off all the error reporting.

The log file will not be created and no exceptions for invalid data will be thrown. If you just want to turn off the logs, but abort at the first error what you should do is not call this method and not set a logError file.

- (void) setRowReader: (STSRowReader *)  rr

Sets the input data source.

Parameters
rr[in] Input RowReader.
- (void) setTailAttribute: (int)  attr

Sets the attribute that will be used to find the tail of the edge.

This method is protected because only the Edge loaders should have it.

Parameters
attr[in] Tail Attribute
- (void) setTailPosition: (int)  pos

Sets the position of the tail attribute in the source data.

This method is protected because only the Edge loaders should have it.

Parameters
pos[in] Tail position
- (void) setTimestampFormat: (NSString *)  timestampFormat

Sets a specific timestamp format.

Parameters
timestampFormat[in] A string with the timestamp format definition.
- (void) setType: (int)  type

Sets the type to be loaded.

Parameters
type[in] Type identifier.

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