sparksee.TypeExporter Class Reference

Base TypeExporter class. More...

Inheritance diagram for sparksee.TypeExporter:

Public Member Functions
	run (self)
	Runs export process.
	set_type (self, type)
	Sets the type to be exported.
	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.
	register (self, tel)
	Registers a new listener.
	set_attributes (self, attrs)
	Sets the list of Attributes.
	set_frequency (self, freq)
	Sets the frequency of listener notification.

Detailed Description

Base TypeExporter class.

Base class to export a node or edge type from a graph using a RowWriter.

TypeExporterListener can be registered to receive information about the progress of the export process by means of TypeExporterEvent. The default frequency of notification to listeners is 100000.

By default no header row is created.

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

Author

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

Member Function Documentation

register()

sparksee.TypeExporter.register	(		self,
			tel )

Registers a new listener.

Parameters

tel	[in] TypeExporterListener to be registered.

Reimplemented in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

run()

sparksee.TypeExporter.run

(

self

)

Runs export process.

WrongArgumentErrorIn case of bad settings ErrorFor other issues

Exceptions

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

Reimplemented in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

set_attributes()

sparksee.TypeExporter.set_attributes	(		self,
			attrs )

Sets the list of Attributes.

Parameters

attrs

[in] Attribute identifiers to be exported

Reimplemented in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

set_frequency()

sparksee.TypeExporter.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 in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

set_graph()

sparksee.TypeExporter.set_graph	(		self,
			graph )

Sets the graph that will be exported.

Parameters

graph

[in] Graph.

Reimplemented in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

set_header()

sparksee.TypeExporter.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 in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

set_row_writer()

sparksee.TypeExporter.set_row_writer	(		self,
			rw )

Sets the output data destination.

Parameters

rw	[in] Input RowWriter.

Reimplemented in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.

set_type()

sparksee.TypeExporter.set_type	(		self,
			type )

Sets the type to be exported.

Parameters

type	[in] Type identifier.

Reimplemented in sparksee.EdgeTypeExporter, and sparksee.NodeTypeExporter.