SparkseePython  6.0.2
Public Member Functions | List of all members
sparksee.NodeTypeExporter Class Reference

NodeTypeExporter class. More...

Inheritance diagram for sparksee.NodeTypeExporter:
Inheritance graph
Collaboration diagram for sparksee.NodeTypeExporter:
Collaboration graph

Public Member Functions

def __init__ (self)
 Creates a new instance.
 
def run (self)
 See the TypeExporter class Run method. More...
 
def __init__ (self, row_writer, graph, type, attrs)
 Creates a new instance. More...
 
def set_type (self, type)
 Sets the type to be exported. More...
 
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 register (self, tel)
 Registers a new listener. More...
 
def set_attributes (self, attrs)
 Sets the list of Attributes. More...
 
def set_frequency (self, freq)
 Sets the frequency of listener notification. More...
 

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

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

References sparksee.NodeTypeExporter.__init__().

Member Function Documentation

def sparksee.NodeTypeExporter.register (   self,
  tel 
)

Registers a new listener.

Parameters
tel[in] TypeExporterListener to be registered.
def sparksee.NodeTypeExporter.run (   self)

See the TypeExporter class Run method.

Exceptions
RuntimeErrornull
IOErrornull
def sparksee.NodeTypeExporter.set_attributes (   self,
  attrs 
)

Sets the list of Attributes.

Parameters
attrs[in] Attribute identifiers to be exported
def 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
def sparksee.NodeTypeExporter.set_graph (   self,
  graph 
)

Sets the graph that will be exported.

Parameters
graph[in] Graph.
def 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.
def sparksee.NodeTypeExporter.set_row_writer (   self,
  rw 
)

Sets the output data destination.

Parameters
rw[in] Input RowWriter.
def sparksee.NodeTypeExporter.set_type (   self,
  type 
)

Sets the type to be exported.

Parameters
type[in] Type identifier.