Inheritance diagram for sparksee.EdgeTypeLoader:

Collaboration diagram for sparksee.EdgeTypeLoader:

Public Member Functions
def	run (self)
	See the TypeLoader class Run method. More...

def	set_log_error (self, path)
	Sets a log error file. More...

def	set_type (self, type)
	Sets the type to be loaded. More...

def	set_head_position (self, pos)
	Sets the position of the head attribute in the source data. More...

def	set_locale (self, locale_str)
	Sets the locale that will be used to read the data. More...

def	set_timestamp_format (self, timestamp_format)
	Sets a specific timestamp format. More...

def	set_attributes (self, attrs)
	Sets the list of Attributes. More...

def	__init__ (self)
	Creates a new instance.

def	register (self, tel)
	Registers a new listener. More...

def	__init__ (self, row_reader, graph, type, attrs, attrs_pos, h_pos, t_pos, h_attr, t_attr, head_mep, tail_mep)
	Creates a new instance. More...

def	set_frequency (self, freq)
	Sets the frequency of listener notification. More...

def	run_two_phases (self)
	See the TypeLoader class RunTwoPhases method. More...

def	set_head_attribute (self, attr)
	Sets the attribute that will be used to find the head of the edge. More...

def	set_tail_attribute (self, attr)
	Sets the attribute that will be used to find the tail of the edge. More...

def	set_tail_position (self, pos)
	Sets the position of the tail attribute in the source data. More...

def	set_row_reader (self, rr)
	Sets the input data source. More...

def	set_tail_mep (self, mep)
	Sets the flag to create missing tail nodes when loading nodes or edges. More...

def	set_attribute_positions (self, attrs_pos)
	Sets the list of attribute positions. More...

def	set_graph (self, graph)
	Sets the graph where the data will be loaded. More...

def	run_n_phases (self, partitions)
	See the TypeLoader class RunNPhases method. More...

def	set_head_mep (self, mep)
	Sets the flag to create missing head nodes when loading nodes or edges. More...

def	set_log_off (self)
	Truns off all the error reporting. 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.

Author: Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

def sparksee.EdgeTypeLoader.__init__	(	self,
		row_reader,
		graph,
		type,
		attrs,
		attrs_pos,
		h_pos,
		t_pos,
		h_attr,
		t_attr,
		head_mep,
		tail_mep
	)

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). to all listeners.
h_pos	[in] The position (index column) for the head value.
t_pos	[in] The position (index column) for the tail value.
h_attr	[in] The attribute identifier for the head.
t_attr	[in] The attribute identifier for the tail.
head_mep	[in] The MissingEndpoint policy for the head nodes
tail_mep	[in] The MissingEndpoint policy for the tail nodes

References sparksee.EdgeTypeLoader.__init__().

Member Function Documentation

def sparksee.EdgeTypeLoader.register	(	self,
		tel
	)

Registers a new listener.

Parameters

tel	TypeLoaderListener to be registered.

def sparksee.EdgeTypeLoader.run ( self )

See the TypeLoader class Run method.

Exceptions

RuntimeError	null
IOError	null

def sparksee.EdgeTypeLoader.run_n_phases	(	self,
		partitions
	)

See the TypeLoader class RunNPhases method.

Parameters

partitions null

Exceptions

RuntimeError	null
IOError	null

def sparksee.EdgeTypeLoader.run_two_phases ( self )

See the TypeLoader class RunTwoPhases method.

Exceptions

RuntimeError	null
IOError	null

def sparksee.EdgeTypeLoader.set_attribute_positions	(	self,
		attrs_pos
	)

Sets the list of attribute positions.

Parameters

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

def sparksee.EdgeTypeLoader.set_attributes	(	self,
		attrs
	)

Sets the list of Attributes.

Parameters

attrs [in] Attribute identifiers to be loaded

def sparksee.EdgeTypeLoader.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

def sparksee.EdgeTypeLoader.set_graph	(	self,
		graph
	)

Sets the graph where the data will be loaded.

Parameters

graph [in] Graph.

def sparksee.EdgeTypeLoader.set_head_attribute	(	self,
		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

def sparksee.EdgeTypeLoader.set_head_mep	(	self,
		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

def sparksee.EdgeTypeLoader.set_head_position	(	self,
		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

def sparksee.EdgeTypeLoader.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.

def sparksee.EdgeTypeLoader.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

IOError If bad things happen opening the file.

def sparksee.EdgeTypeLoader.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.

def sparksee.EdgeTypeLoader.set_row_reader	(	self,
		rr
	)

Sets the input data source.

Parameters

rr	[in] Input RowReader.

def sparksee.EdgeTypeLoader.set_tail_attribute	(	self,
		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

def sparksee.EdgeTypeLoader.set_tail_mep	(	self,
		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

def sparksee.EdgeTypeLoader.set_tail_position	(	self,
		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

def sparksee.EdgeTypeLoader.set_timestamp_format	(	self,
		timestamp_format
	)

Sets a specific timestamp format.

Parameters

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

def sparksee.EdgeTypeLoader.set_type	(	self,
		type
	)

Sets the type to be loaded.

Parameters

type	[in] Type identifier.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation