EdgeTypeLoader class. More...
Instance Methods | |
| (id) | - init |
| Creates a new instance. | |
| (void) | - run |
| See the TypeLoader class Run method. More... | |
| (void) | - runTwoPhases |
| See the TypeLoader class RunTwoPhases method. More... | |
| (void) | - runNPhases: |
| See the TypeLoader class RunNPhases method. More... | |
| (void) | - setHeadAttribute: |
| Sets the attribute that will be used to find the head of the edge. More... | |
| (void) | - setHeadPosition: |
| Sets the position of the head attribute in the source data. More... | |
| (void) | - setTailAttribute: |
| Sets the attribute that will be used to find the tail of the edge. More... | |
| (void) | - setTailPosition: |
| Sets the position of the tail attribute in the source data. More... | |
| (void) | - setTailMEP: |
| Sets the flag to create missing tail nodes when loading nodes or edges. More... | |
| (void) | - setHeadMEP: |
| Sets the flag to create missing head nodes when loading nodes or edges. More... | |
| (void) | - setLogError: |
| Sets a log error file. More... | |
| (void) | - setLogOff |
| Truns off all the error reporting. More... | |
| (void) | - registerListener: |
| Registers a new listener. More... | |
| (void) | - setRowReader: |
| Sets the input data source. More... | |
| (void) | - setGraph: |
| Sets the graph where the data will be loaded. More... | |
| (void) | - setLocale: |
| Sets the locale that will be used to read the data. More... | |
| (void) | - setType: |
| Sets the type to be loaded. More... | |
| (void) | - setAttributes: |
| Sets the list of Attributes. More... | |
| (void) | - setAttributePositions: |
| Sets the list of attribute positions. More... | |
| (void) | - setTimestampFormat: |
| Sets a specific timestamp format. More... | |
| (void) | - setFrequency: |
| Sets the frequency of listener notification. More... | |
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.
Method Documentation
| - (void) registerListener: | (STSTypeLoaderListener *) | tel |
Registers a new listener.
- Parameters
-
tel TypeLoaderListener to be registered.
| - (void) run |
See the TypeLoader class Run method.
- Exceptions
-
System.ApplicationException null System.IO.IOException null
Implements STSTypeLoader.
| - (void) runNPhases: | (int) | partitions |
See the TypeLoader class RunNPhases method.
- Parameters
-
partitions null
- Exceptions
-
System.ApplicationException null System.IO.IOException null
Implements STSTypeLoader.
| - (void) runTwoPhases |
See the TypeLoader class RunTwoPhases method.
- Exceptions
-
System.ApplicationException null System.IO.IOException null
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) 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
| - (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.IOException If 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) 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
| - (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:
- Sparksee.h
