sparksee.NodeTypeExporter Class Reference

NodeTypeExporter class. More...

Inheritance diagram for sparksee.NodeTypeExporter:

Collaboration diagram for sparksee.NodeTypeExporter:

Public Member Functions
	__init__ (self)
	Creates a new instance.
	run (self)
	See the TypeExporter class Run method.
	__init__ (self, row_writer, graph, type, attrs)
	Creates a new instance.
	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

NodeTypeExporter class.

Specific TypeExporter implementation for node 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.NodeTypeExporter.__init__	(		self,
			row_writer,
			graph,
			type,
			attrs )

Creates a new instance.

Parameters

row_writer	[in] Output RowWriter.
graph	[in] Graph.
type	[in] Type identifier.
attrs	[in] Attribute identifiers to be exported.

Member Function Documentation

register()

sparksee.NodeTypeExporter.register	(		self,
			tel )

Registers a new listener.

Parameters

tel	[in] TypeExporterListener to be registered.

Reimplemented from sparksee.TypeExporter.

run()

sparksee.NodeTypeExporter.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.NodeTypeExporter.set_attributes	(		self,
			attrs )

Sets the list of Attributes.

Parameters

attrs

[in] Attribute identifiers to be exported

Reimplemented from sparksee.TypeExporter.

set_frequency()

sparksee.NodeTypeExporter.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.NodeTypeExporter.set_graph	(		self,
			graph )

Sets the graph that will be exported.

Parameters

graph

[in] Graph.

Reimplemented from sparksee.TypeExporter.

set_header()

sparksee.NodeTypeExporter.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.NodeTypeExporter.set_row_writer	(		self,
			rw )

Sets the output data destination.

Parameters

rw	[in] Input RowWriter.

Reimplemented from sparksee.TypeExporter.

set_type()

sparksee.NodeTypeExporter.set_type	(		self,
			type )

Sets the type to be exported.

Parameters

type	[in] Type identifier.

Reimplemented from sparksee.TypeExporter.