sparksee.EdgeTypeExporter Class Reference

EdgeTypeExporter class. More...

Inheritance diagram for sparksee.EdgeTypeExporter:

Inheritance graph
Collaboration diagram for sparksee.EdgeTypeExporter:

Collaboration graph

List of all members.

Public Member Functions

def set_tail_attribute
 Sets the attribute that will be used to get the value to be dumped for the tail of the edge.
def set_frequency
 Sets the frequency of listener notification.
def set_head_attribute
 Sets the attribute that will be used to get the value to be dumped for the head of the edge.
def set_type
 Sets the type to be exported.
def set_tail_position
 Sets the position (index column) of the tail attribute in the exported data.
def __init__
 Creates a new instance.
def set_row_writer
 Sets the output data destination.
def register
 Registers a new listener.
def run
 See the TypeExporter class Run method.
def __init__
 Creates a new instance.
def set_graph
 Sets the graph that will be exported.
def set_header
 Sets the presence of a header row.
def set_head_position
 Sets the position (index column) of the head attribute in the exported data.
def set_attributes
 Sets the list of Attributes.


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

Member Function Documentation

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

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_type (   self,
  type 
)

Sets the type to be exported.

Parameters:
type [in] Type identifier.

Reimplemented from sparksee.TypeExporter.

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.__init__ (   self,
  rowWriter,
  graph,
  type,
  attrs,
  hPos,
  tPos,
  hAttr,
  tAttr 
)

Creates a new instance.

Parameters:
rowWriter [in] Output RowWriter.
graph [in] Graph.
type [in] Type identifier.
attrs [in] Attribute identifiers to be exported.
hPos [in] The position (index column) for the head value.
tPos [in] The position (index column) for the tail value.
hAttr [in] The attribute identifier to get the value to be dumped for the head.
tAttr [in] The attribute identifier to get the value to be dumped for the tail.

def sparksee.EdgeTypeExporter.set_row_writer (   self,
  rw 
)

Sets the output data destination.

Parameters:
rw [in] Input RowWriter.

Reimplemented from sparksee.TypeExporter.

def sparksee.EdgeTypeExporter.register (   self,
  tel 
)

Registers a new listener.

Parameters:
tel [in] TypeExporterListener to be registered.

Reimplemented from sparksee.TypeExporter.

def sparksee.EdgeTypeExporter.run (   self  ) 

See the TypeExporter class Run method.

Exceptions:
IOError null
RuntimeError null

Reimplemented from sparksee.TypeExporter.

def sparksee.EdgeTypeExporter.set_graph (   self,
  graph 
)

Sets the graph that will be exported.

Parameters:
graph [in] Graph.

Reimplemented from sparksee.TypeExporter.

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.

Reimplemented from sparksee.TypeExporter.

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_attributes (   self,
  attrs 
)

Sets the list of Attributes.

Parameters:
attrs [in] Attribute identifiers to be exported

Reimplemented from sparksee.TypeExporter.


Generated on Fri Sep 12 13:39:51 2014 for SparkseePython by  doxygen 1.5.6