SparkseePython3 6.1.0
sparksee.NodeTypeLoader Class Reference

NodeTypeLoader class. More...

Inheritance diagram for sparksee.NodeTypeLoader:
Inheritance graph
Collaboration diagram for sparksee.NodeTypeLoader:
Collaboration graph

Public Member Functions

 run (self)
 See the TypeLoader class Run method.
 set_log_error (self, path)
 Sets a log error file.
 set_type (self, type)
 Sets the type to be loaded.
 set_locale (self, locale_str)
 Sets the locale that will be used to read the data.
 set_timestamp_format (self, timestamp_format)
 Sets a specific timestamp format.
 set_attributes (self, attrs)
 Sets the list of Attributes.
 __init__ (self)
 Creates a new instance.
 register (self, tel)
 Registers a new listener.
 set_frequency (self, freq)
 Sets the frequency of listener notification.
 __init__ (self, row_reader, graph, type, attrs, attrs_pos)
 Creates a new instance.
 run_two_phases (self)
 See the TypeLoader class RunTwoPhases method.
 set_row_reader (self, rr)
 Sets the input data source.
 set_attribute_positions (self, attrs_pos)
 Sets the list of attribute positions.
 set_graph (self, graph)
 Sets the graph where the data will be loaded.
 run_n_phases (self, partitions)
 See the TypeLoader class RunNPhases method.
 set_log_off (self)
 Truns off all the error reporting.

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

Constructor & Destructor Documentation

◆ __init__()

sparksee.NodeTypeLoader.__init__ ( self,
row_reader,
graph,
type,
attrs,
attrs_pos )

Creates a new instance.

Parameters
row_reader[in] Input RowReader.
graph[in] Graph.
type[in] Type identifier.
attrs[in] Attribute identifiers to be loaded.
attrs_pos[in] Attribute positions (column index >=0).

Member Function Documentation

◆ register()

sparksee.NodeTypeLoader.register ( self,
tel )

Registers a new listener.

Parameters
telTypeLoaderListener to be registered.

Reimplemented from sparksee.TypeLoader.

◆ run()

sparksee.NodeTypeLoader.run ( self)

See the TypeLoader class Run method.

ErrorFor other issues

Exceptions
RuntimeErrornull
IOErrorIf bad things happen using to the RowReader.

Reimplemented from sparksee.TypeLoader.

◆ run_n_phases()

sparksee.NodeTypeLoader.run_n_phases ( self,
partitions )

See the TypeLoader class RunNPhases method.

ErrorFor other issues

Parameters
partitionsnull
Exceptions
RuntimeErrornull
IOErrorIf bad things happen using to the RowReader.

Reimplemented from sparksee.TypeLoader.

◆ run_two_phases()

sparksee.NodeTypeLoader.run_two_phases ( self)

See the TypeLoader class RunTwoPhases method.

ErrorFor other issues

Exceptions
RuntimeErrornull
IOErrorIf bad things happen using to the RowReader.

Reimplemented from sparksee.TypeLoader.

◆ set_attribute_positions()

sparksee.NodeTypeLoader.set_attribute_positions ( self,
attrs_pos )

Sets the list of attribute positions.

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

Reimplemented from sparksee.TypeLoader.

◆ set_attributes()

sparksee.NodeTypeLoader.set_attributes ( self,
attrs )

Sets the list of Attributes.

Parameters
attrs[in] Attribute identifiers to be loaded

Reimplemented from sparksee.TypeLoader.

◆ set_frequency()

sparksee.NodeTypeLoader.set_frequency ( self,
freq )

Sets the frequency of listener notification.

Parameters
freq[in] Frequency in number of rows managed to notify progress to all listeners

Reimplemented from sparksee.TypeLoader.

◆ set_graph()

sparksee.NodeTypeLoader.set_graph ( self,
graph )

Sets the graph where the data will be loaded.

Parameters
graph[in] Graph.

Reimplemented from sparksee.TypeLoader.

◆ set_locale()

sparksee.NodeTypeLoader.set_locale ( self,
locale_str )

Sets the locale that will be used to read the data.

It should match the locale used in the rowreader.

Parameters
locale_str[in] The locale string for the read data. See CSVReader.

Reimplemented from sparksee.TypeLoader.

◆ set_log_error()

sparksee.NodeTypeLoader.set_log_error ( self,
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
IOErrorIf bad things happen opening the file.

Reimplemented from sparksee.TypeLoader.

◆ set_log_off()

sparksee.NodeTypeLoader.set_log_off ( self)

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.

Reimplemented from sparksee.TypeLoader.

◆ set_row_reader()

sparksee.NodeTypeLoader.set_row_reader ( self,
rr )

Sets the input data source.

Parameters
rr[in] Input RowReader.

Reimplemented from sparksee.TypeLoader.

◆ set_timestamp_format()

sparksee.NodeTypeLoader.set_timestamp_format ( self,
timestamp_format )

Sets a specific timestamp format.

Parameters
timestamp_format[in] A string with the timestamp format definition.

Reimplemented from sparksee.TypeLoader.

◆ set_type()

sparksee.NodeTypeLoader.set_type ( self,
type )

Sets the type to be loaded.

Parameters
type[in] Type identifier.

Reimplemented from sparksee.TypeLoader.