Sparksee  5.2.0
STSTypeLoader Class Reference

Base TypeLoader class. More...

Inheritance diagram for STSTypeLoader:
Inheritance graph
Collaboration diagram for STSTypeLoader:
Collaboration graph

Instance Methods

(void) - setLogError:
 Sets a log error file.
 
(void) - setLogOff
 Truns off all the error reporting.
 
(void) - registerListener:
 Registers a new listener.
 
(void) - run
 Run the loader.
 
(void) - runTwoPhases
 Run the loader for two phases loading.
 
(void) - runNPhases:
 Run the loader for N phases loading.
 
(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

Base TypeLoader class.

Base class to load a node or edge type from a graph using a RowReader.

TypeLoaderListener can be registered to receive information about the progress of the load process by means of TypeLoaderEvent. The default frequency of notification to listeners is 100000.

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

- (void) registerListener: (STSTypeLoaderListener *)  tel

Registers a new listener.

Parameters
telTypeLoaderListener to be registered.
- (void) run

Run the loader.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implemented in STSEdgeTypeLoader, and STSNodeTypeLoader.

- (void) runNPhases: (int)  partitions

Run the loader for N phases loading.

Firstly load all objects (and create them if necessary) and secondly loads all the attributes. But in this case, attributes are loaded one by one. This way, if there are three attributes, then 4 traverses are necessary.

Working on this mode it is necessary to build a temporary file.

Parameters
partitions[in] Number of horizontal partitions to perform the load.
Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implemented in STSEdgeTypeLoader, and STSNodeTypeLoader.

- (void) runTwoPhases

Run the loader for two phases loading.

Firstly load all objects (and create them if necessary) and secondly loads all the attributes.

Working on this mode it is necessary to build a temporary file.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull

Implemented in STSEdgeTypeLoader, and STSNodeTypeLoader.

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