sparksee.TypeExporter Class Reference

Base TypeExporter class. More...

Inheritance diagram for sparksee.TypeExporter:

Inheritance graph

List of all members.

Public Member Functions

def set_row_writer
 Sets the output data destination.
def set_frequency
 Sets the frequency of listener notification.
def run
 Runs export process.
def register
 Registers a new listener.
def set_graph
 Sets the graph that will be exported.
def set_header
 Sets the presence of a header row.
def set_type
 Sets the type to be exported.
def set_attributes
 Sets the list of Attributes.


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

def sparksee.TypeExporter.set_row_writer (   self,
  rw 
)

Sets the output data destination.

Parameters:
rw [in] Input RowWriter.

Reimplemented in sparksee.NodeTypeExporter, and sparksee.EdgeTypeExporter.

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

def sparksee.TypeExporter.run (   self  ) 

Runs export process.

Exceptions:
IOError If bad things happen writing to the RowWriter.
RuntimeError null

Reimplemented in sparksee.NodeTypeExporter, and sparksee.EdgeTypeExporter.

def sparksee.TypeExporter.register (   self,
  tel 
)

Registers a new listener.

Parameters:
tel [in] TypeExporterListener to be registered.

Reimplemented in sparksee.NodeTypeExporter, and sparksee.EdgeTypeExporter.

def sparksee.TypeExporter.set_graph (   self,
  graph 
)

Sets the graph that will be exported.

Parameters:
graph [in] Graph.

Reimplemented in sparksee.NodeTypeExporter, and sparksee.EdgeTypeExporter.

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

def sparksee.TypeExporter.set_type (   self,
  type 
)

Sets the type to be exported.

Parameters:
type [in] Type identifier.

Reimplemented in sparksee.NodeTypeExporter, and sparksee.EdgeTypeExporter.

def sparksee.TypeExporter.set_attributes (   self,
  attrs 
)

Sets the list of Attributes.

Parameters:
attrs [in] Attribute identifiers to be exported

Reimplemented in sparksee.NodeTypeExporter, and sparksee.EdgeTypeExporter.


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