sparksee.EdgeTypeExporter Class Reference

EdgeTypeExporter class. More...

Inheritance diagram for sparksee.EdgeTypeExporter:

Collaboration diagram for sparksee.EdgeTypeExporter:

Public Member Functions
	run (self)
	See the TypeExporter class Run method.
	set_type (self, type)
	Sets the type to be exported.
	set_head_position (self, pos)
	Sets the position (index column) of the head attribute in the exported data.
	set_attributes (self, attrs)
	Sets the list of Attributes.
	set_frequency (self, freq)
	Sets the frequency of listener notification.
	set_head_attribute (self, attr)
	Sets the attribute that will be used to get the value to be dumped for the head of the edge.
	set_tail_attribute (self, attr)
	Sets the attribute that will be used to get the value to be dumped for the tail of the edge.
	set_tail_position (self, pos)
	Sets the position (index column) of the tail attribute in the exported data.
	__init__ (self)
	Creates a new instance.
	set_header (self, header)
	Sets the presence of a header row.
	set_row_writer (self, rw)
	Sets the output data destination.
	set_graph (self, graph)
	Sets the graph that will be exported.
	__init__ (self, row_writer, graph, type, attrs, h_pos, t_pos, h_attr, t_attr)
	Creates a new instance.
	register (self, tel)
	Registers a new listener.

Detailed Description

EdgeTypeExporter class.

Specific TypeExporter implementation for edge types.

Check out the 'Data export' section in the SPARKSEE User Manual for more details on this.

Author

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

Constructor & Destructor Documentation

__init__()

sparksee.EdgeTypeExporter.__init__	(		self,
			row_writer,
			graph,
			type,
			attrs,
			h_pos,
			t_pos,
			h_attr,
			t_attr )

Creates a new instance.

Parameters

row_writer	[in] Output RowWriter.
graph	[in] Graph.
type	[in] Type identifier.
attrs	[in] Attribute identifiers to be exported.
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 to get the value to be dumped for the head.
t_attr	[in] The attribute identifier to get the value to be dumped for the tail.

Member Function Documentation

register()

sparksee.EdgeTypeExporter.register	(		self,
			tel )

Registers a new listener.

Parameters

tel	[in] TypeExporterListener to be registered.

Reimplemented from sparksee.TypeExporter.

run()

sparksee.EdgeTypeExporter.run

(

self

)

See the TypeExporter class Run method.

WrongArgumentErrorIn case of bad settings ErrorFor other issues

Exceptions

RuntimeError	null
ValueError	null
IOError	If bad things happen writting to the RowWriter.

Reimplemented from sparksee.TypeExporter.

set_attributes()

sparksee.EdgeTypeExporter.set_attributes	(		self,
			attrs )

Sets the list of Attributes.

Parameters

attrs

[in] Attribute identifiers to be exported

Reimplemented from sparksee.TypeExporter.

set_frequency()

sparksee.EdgeTypeExporter.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.TypeExporter.

set_graph()

sparksee.EdgeTypeExporter.set_graph	(		self,
			graph )

Sets the graph that will be exported.

Parameters

graph

[in] Graph.

Reimplemented from sparksee.TypeExporter.

set_head_attribute()

sparksee.EdgeTypeExporter.set_head_attribute	(		self,
			attr )

Sets the attribute that will be used to get the value to be dumped for the head of the edge.

Parameters

attr	[in] Head Attribute

set_head_position()

sparksee.EdgeTypeExporter.set_head_position	(		self,
			pos )

Sets the position (index column) of the head attribute in the exported data.

Parameters

pos	[in] Head position

set_header()

sparksee.EdgeTypeExporter.set_header	(		self,
			header )

Sets the presence of a header row.

Parameters

header

[in] If TRUE, a header row is dumped with the name of the attributes.

Reimplemented from sparksee.TypeExporter.

set_row_writer()

sparksee.EdgeTypeExporter.set_row_writer	(		self,
			rw )

Sets the output data destination.

Parameters

rw	[in] Input RowWriter.

Reimplemented from sparksee.TypeExporter.

set_tail_attribute()

sparksee.EdgeTypeExporter.set_tail_attribute	(		self,
			attr )

Sets the attribute that will be used to get the value to be dumped for the tail of the edge.

Parameters

attr	[in] Tail Attribute

set_tail_position()

sparksee.EdgeTypeExporter.set_tail_position	(		self,
			pos )

Sets the position (index column) of the tail attribute in the exported data.

Parameters

pos	[in] Tail position

set_type()

sparksee.EdgeTypeExporter.set_type	(		self,
			type )

Sets the type to be exported.

Parameters

type	[in] Type identifier.

Reimplemented from sparksee.TypeExporter.