SparkseeNet  5.2.0
Public Member Functions | List of all members
com.sparsity.sparksee.io.TypeLoader Class Reference

Base TypeLoader class. More...

Inheritance diagram for com.sparsity.sparksee.io.TypeLoader:
Inheritance graph

Public Member Functions

void RunTwoPhases () throws System.IO.IOException, System.ApplicationException
 Run the loader for two phases loading. More...
 
void RunNPhases (int partitions) throws System.IO.IOException, System.ApplicationException
 Run the loader for N phases loading. More...
 
void SetFrequency (int freq)
 Sets the frequency of listener notification. More...
 
void SetLogOff ()
 Truns off all the error reporting. More...
 
void Run () throws System.IO.IOException, System.ApplicationException
 Run the loader. More...
 
void SetLogError (System.String path) throws System.IO.IOException
 Sets a log error file. More...
 
void SetType (int type)
 Sets the type to be loaded. More...
 
void SetRowReader (com.sparsity.sparksee.io.RowReader rr)
 Sets the input data source. More...
 
void SetAttributePositions (com.sparsity.sparksee.gdb.Int32List attrsPos)
 Sets the list of attribute positions. More...
 
void Register (com.sparsity.sparksee.io.TypeLoaderListener tel)
 Registers a new listener. More...
 
void SetLocale (System.String localeStr)
 Sets the locale that will be used to read the data. More...
 
void SetGraph (com.sparsity.sparksee.gdb.Graph graph)
 Sets the graph where the data will be loaded. More...
 
void SetTimestampFormat (System.String timestampFormat)
 Sets a specific timestamp format. More...
 
void SetAttributes (com.sparsity.sparksee.gdb.AttributeList attrs)
 Sets the list of Attributes. More...
 

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

Member Function Documentation

void com.sparsity.sparksee.io.TypeLoader.Register ( com.sparsity.sparksee.io.TypeLoaderListener  tel)

Registers a new listener.

Parameters
telTypeLoaderListener to be registered.
void com.sparsity.sparksee.io.TypeLoader.Run ( ) throws System.IO.IOException, System.ApplicationException

Run the loader.

Exceptions
System.IO.IOExceptionnull
System.ApplicationExceptionnull
void com.sparsity.sparksee.io.TypeLoader.RunNPhases ( int  partitions) throws System.IO.IOException, System.ApplicationException

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
void com.sparsity.sparksee.io.TypeLoader.RunTwoPhases ( ) throws System.IO.IOException, System.ApplicationException

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
void com.sparsity.sparksee.io.TypeLoader.SetAttributePositions ( com.sparsity.sparksee.gdb.Int32List  attrsPos)

Sets the list of attribute positions.

Parameters
attrsPos[in] Attribute positions (column index >=0).
void com.sparsity.sparksee.io.TypeLoader.SetAttributes ( com.sparsity.sparksee.gdb.AttributeList  attrs)

Sets the list of Attributes.

Parameters
attrs[in] Attribute identifiers to be loaded
void com.sparsity.sparksee.io.TypeLoader.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 com.sparsity.sparksee.io.TypeLoader.SetGraph ( com.sparsity.sparksee.gdb.Graph  graph)

Sets the graph where the data will be loaded.

Parameters
graph[in] Graph.
void com.sparsity.sparksee.io.TypeLoader.SetLocale ( System.String  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 com.sparsity.sparksee.io.TypeLoader.SetLogError ( System.String  path) throws System.IO.IOException

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 com.sparsity.sparksee.io.TypeLoader.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 com.sparsity.sparksee.io.TypeLoader.SetRowReader ( com.sparsity.sparksee.io.RowReader  rr)

Sets the input data source.

Parameters
rr[in] Input RowReader.
void com.sparsity.sparksee.io.TypeLoader.SetTimestampFormat ( System.String  timestampFormat)

Sets a specific timestamp format.

Parameters
timestampFormat[in] A string with the timestamp format definition.
void com.sparsity.sparksee.io.TypeLoader.SetType ( int  type)

Sets the type to be loaded.

Parameters
type[in] Type identifier.