STSNodeTypeLoader Class Reference

NodeTypeLoader class. More...

#include <Sparksee.h>

Inheritance diagram for STSNodeTypeLoader:

Collaboration diagram for STSNodeTypeLoader:

Instance Methods
(id)	- init
	Creates a new instance.
(id)	- initWithRowReader:graph:type:attrs:attrsPos:
	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)	- 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

NodeTypeLoader class.

Specific TypeLoader implementation for node 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

initWithRowReader:graph:type:attrs:attrsPos:

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

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).

registerListener:

- (void) registerListener:

(STSTypeLoaderListener *)

tel

Registers a new listener.

Parameters

tel	TypeLoaderListener to be registered.

run

- (void) run

See the TypeLoader class Run method.

ErrorFor other issues

Exceptions

System.ApplicationException	null
System.IO.IOException	If bad things happen using to the RowReader.

Implements STSTypeLoader.

References run.

Referenced by run.

runNPhases:

- (void) runNPhases:

(int)

partitions

See the TypeLoader class RunNPhases method.

ErrorFor other issues

Parameters

partitions

null

Exceptions

System.ApplicationException	null
System.IO.IOException	If bad things happen using to the RowReader.

Implements STSTypeLoader.

runTwoPhases

- (void) runTwoPhases

See the TypeLoader class RunTwoPhases method.

ErrorFor other issues

Exceptions

System.ApplicationException	null
System.IO.IOException	If bad things happen using to the RowReader.

Implements STSTypeLoader.

References runTwoPhases.

Referenced by runTwoPhases.

setAttributePositions:

- (void) setAttributePositions:

(STSInt32List *)

attrsPos

Sets the list of attribute positions.

Parameters

attrsPos

[in] Attribute positions (column index >=0).

setAttributes:

- (void) setAttributes:

(STSAttributeList *)

attrs

Sets the list of Attributes.

Parameters

attrs

[in] Attribute identifiers to be loaded

setFrequency:

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

setGraph:

- (void) setGraph:

(STSGraph *)

graph

Sets the graph where the data will be loaded.

Parameters

graph

[in] Graph.

setLocale:

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

setLogError:

- (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.IOException

If bad things happen opening the file.

setLogOff

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

References setLogOff.

Referenced by setLogOff.

setRowReader:

- (void) setRowReader:

(STSRowReader *)

rr

Sets the input data source.

Parameters

rr	[in] Input RowReader.

setTimestampFormat:

- (void) setTimestampFormat:

(NSString *)

timestampFormat

Sets a specific timestamp format.

Parameters

timestampFormat

[in] A string with the timestamp format definition.

setType:

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

• Sparksee.h