sparksee.ExportManager Class Reference

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

Inheritance diagram for sparksee.ExportManager:

Public Member Functions
def	get_edge (self, edge, edge_export)
	Gets the edge export definition for the given edge. More...
def	release (self)
	Ends the export process. More...
def	get_graph (self, graph_export)
	Gets the graph export definition. More...
def	get_node (self, node, node_export)
	Gets the node export definition for the given node. More...
def	get_node_type (self, type, node_export)
	Gets the default node export definition for the given node type. More...
def	enable_type (self, type)
	Gets whether a node or edge type must be exported or not. More...
def	prepare (self, graph)
	Prepares the graph for the export process. More...
def	get_edge_type (self, type, edge_export)
	Gets the default node export definition for the given edge type. More...

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

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

Gets the edge export definition for the given edge.

Parameters

edge	Edge identifier.
edge_export	[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.

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

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.
edge_export	[out] The EdgeExport which defines how to export the edges of the given type.

Returns

TRUE.

def sparksee.ExportManager.get_graph	(		self,
			graph_export
	)

Gets the graph export definition.

Parameters

graph_export

[out] The GraphExport which defines how to export the graph.

Returns

TRUE.

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

Gets the node export definition for the given node.

Parameters

node	Node identifier.
node_export	[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.

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

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.
node_export	[out] The NodeExport which defines how to export the nodes of the given type.

Returns

TRUE.

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.

def sparksee.ExportManager.release

(

self

)

Ends the export process.

It is called once after the export process.