sparksee.EdgeTypeExporter Class Reference

EdgeTypeExporter class. More...

Inheritance diagram for sparksee.EdgeTypeExporter:

Collaboration diagram for sparksee.EdgeTypeExporter:

Public Member Functions
def	run (self)
	See the TypeExporter class Run method. More...
def	set_type (self, type)
	Sets the type to be exported. More...
def	set_head_position (self, pos)
	Sets the position (index column) of the head attribute in the exported data. More...
def	set_attributes (self, attrs)
	Sets the list of Attributes. More...
def	set_frequency (self, freq)
	Sets the frequency of listener notification. More...
def	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. More...
def	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. More...
def	set_tail_position (self, pos)
	Sets the position (index column) of the tail attribute in the exported data. More...
def	__init__ (self)
	Creates a new instance.
def	set_header (self, header)
	Sets the presence of a header row. More...
def	set_row_writer (self, rw)
	Sets the output data destination. More...
def	set_graph (self, graph)
	Sets the graph that will be exported. More...
def	__init__ (self, row_writer, graph, type, attrs, h_pos, t_pos, h_attr, t_attr)
	Creates a new instance. More...
def	register (self, tel)
	Registers a new listener. More...

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

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

References sparksee.EdgeTypeExporter.__init__().

Member Function Documentation

def sparksee.EdgeTypeExporter.register	(		self,
			tel
	)

Registers a new listener.

Parameters

tel	[in] TypeExporterListener to be registered.

def sparksee.EdgeTypeExporter.run

(

self

)

See the TypeExporter class Run method.

Exceptions

RuntimeError	null
IOError	null

def sparksee.EdgeTypeExporter.set_attributes	(		self,
			attrs
	)

Sets the list of Attributes.

Parameters

attrs

[in] Attribute identifiers to be exported

def 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

def sparksee.EdgeTypeExporter.set_graph	(		self,
			graph
	)

Sets the graph that will be exported.

Parameters

graph

[in] Graph.

def 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

def 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

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

def sparksee.EdgeTypeExporter.set_row_writer	(		self,
			rw
	)

Sets the output data destination.

Parameters

rw	[in] Input RowWriter.

def 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

def 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

def sparksee.EdgeTypeExporter.set_type	(		self,
			type
	)

Sets the type to be exported.

Parameters

type	[in] Type identifier.