sparksee.ExportManager Class Reference

Defines how to export a graph to an external format. More...

Inheritance diagram for sparksee.ExportManager:

Inheritance graph

List of all members.

Public Member Functions

def get_node_type
 Gets the default node export definition for the given node type.
def get_edge
 Gets the edge export definition for the given edge.
def get_graph
 Gets the graph export definition.
def get_edge_type
 Gets the default node export definition for the given edge type.
def prepare
 Prepares the graph for the export process.
def get_node
 Gets the node export definition for the given node.
def release
 Ends the export process.
def enable_type
 Gets whether a node or edge type must be exported or not.


Detailed Description

Defines how to export a graph to an external format.

This is an interface which must be implemented by the user. While the export proces, a call for each node or edge type and node or edge object is done to get how to export that element.

It is possible to export a Graph to a diferent fortmats. Nowadays, available formats are defined in the ExportType enum.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

def sparksee.ExportManager.get_node_type (   self,
  type,
  nodeExport 
)

Gets the default node export definition for the given node type.

GetNode has a higher priority than this function. That is, only if GetNode returns FALSE, the NodeExport of this function will be used.

Parameters:
type [in] Node type identifier.
nodeExport [out] The NodeExport which defines how to export the nodes of the given type.
Returns:
TRUE.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.get_edge (   self,
  edge,
  edgeExport 
)

Gets the edge export definition for the given edge.

Parameters:
edge Edge identifier.
edgeExport [out] The EdgeExport which defines how to export given edge.
Returns:
TRUE if the given EdgeExport has been updated, otherwise FALSE will be returned and the default EdgeExport for the type the edge belongs to will be used.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.get_graph (   self,
  graphExport 
)

Gets the graph export definition.

Parameters:
graphExport [out] The GraphExport which defines how to export the graph.
Returns:
TRUE.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.get_edge_type (   self,
  type,
  edgeExport 
)

Gets the default node export definition for the given edge type.

GetEdge has a higher priority than this function. That is, only if GetEdge returns FALSE, the EdgeExport of this function will be used.

Parameters:
type [in] Edge type identifier.
edgeExport [out] The EdgeExport which defines how to export the edges of the given type.
Returns:
TRUE.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.prepare (   self,
  graph 
)

Prepares the graph for the export process.

It is called once before the export process.

Parameters:
graph Graph to be exported.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.get_node (   self,
  node,
  nodeExport 
)

Gets the node export definition for the given node.

Parameters:
node Node identifier.
nodeExport [out] The NodeExport which defines how to export given node.
Returns:
TRUE if the given NodeExport has been updated, otherwise FALSE will be returned and the default NodeExport for the type the node belongs to will be used.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.release (   self  ) 

Ends the export process.

It is called once after the export process.

Reimplemented in sparksee.DefaultExport.

def sparksee.ExportManager.enable_type (   self,
  type 
)

Gets whether a node or edge type must be exported or not.

Parameters:
type Node or edge type identifier.
Returns:
If TRUE all objects of the given type will be exported, otherwise they will not be exported.

Reimplemented in sparksee.DefaultExport.


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