EdgeTypeLoader class. More...

#include <Sparksee.h>

Inheritance diagram for STSEdgeTypeLoader:

Collaboration diagram for STSEdgeTypeLoader:

Instance Methods
(id)	- init
	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)	- setTailMEP:
	Sets the flag to create missing tail nodes when loading nodes or edges.
(void)	- setHeadMEP:
	Sets the flag to create missing head nodes when loading nodes or edges.
(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

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

◆ setHeadAttribute:

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

◆ setHeadMEP:

- (void) setHeadMEP: (enum STSMissingEndpoint) mep

Sets the flag to create missing head nodes when loading nodes or edges.

flagTrue if the nodes need to be created. False otherwise

Parameters

mep null

◆ setHeadPosition:

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

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

◆ setTailAttribute:

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

◆ setTailMEP:

- (void) setTailMEP: (enum STSMissingEndpoint) mep

Sets the flag to create missing tail nodes when loading nodes or edges.

flagTrue if the nodes need to be created. False otherwise

Parameters

mep null

◆ setTailPosition:

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

◆ 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

Instance Methods

Detailed Description

Method Documentation

◆ registerListener:

◆ run

◆ runNPhases:

◆ runTwoPhases

◆ setAttributePositions:

◆ setAttributes:

◆ setFrequency:

◆ setGraph:

◆ setHeadAttribute:

◆ setHeadMEP:

◆ setHeadPosition:

◆ setLocale:

◆ setLogError:

◆ setLogOff

◆ setRowReader:

◆ setTailAttribute:

◆ setTailMEP:

◆ setTailPosition:

◆ setTimestampFormat:

◆ setType: