sparksee.ExportManager Class Reference

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

Inheritance diagram for sparksee.ExportManager:

Public Member Functions
	get_edge (self, edge, edge_export)
	Gets the edge export definition for the given edge.
	release (self)
	Ends the export process.
	get_graph (self, graph_export)
	Gets the graph export definition.
	next_edge (self)
	Gets the next edge to export or InvalidOID.
	get_node (self, node, node_export)
	Gets the node export definition for the given node.
	next_node (self)
	Gets the next node to export or InvalidOID.
	get_node_type (self, type, node_export)
	Gets the default node export definition for the given node type.
	export_all (self)
	Get if all the graph object should be exported or only a subgraph It should return true (default option), to export all the nodes and edges in the Graph as with previous verions.
	enable_type (self, type)
	Gets whether a node or edge type must be exported or not.
	prepare (self, graph)
	Prepares the graph for the export process.
	get_edge_type (self, type, edge_export)
	Gets the default node export definition for the given edge type.

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

enable_type()

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.

export_all()

sparksee.ExportManager.export_all

(

self

)

Get if all the graph object should be exported or only a subgraph It should return true (default option), to export all the nodes and edges in the Graph as with previous verions.

Or false to use the new NextNode() and NextEdge() methods of this class to get the only nodes/edges that should be exported.

Returns

bool_t Returns true to export all the graph or false otherwise.

Reimplemented in sparksee.DefaultExport.

get_edge()

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.

Reimplemented in sparksee.DefaultExport.

get_edge_type()

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.

Reimplemented in sparksee.DefaultExport.

get_graph()

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.

Reimplemented in sparksee.DefaultExport.

get_node()

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.

Reimplemented in sparksee.DefaultExport.

get_node_type()

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.

Reimplemented in sparksee.DefaultExport.

next_edge()

sparksee.ExportManager.next_edge

(

self

)

Gets the next edge to export or InvalidOID.

It will return valid edge OIDs to export and InvalidOID when there is not any more edges to export. ExportAll returns false.

Returns

oid_t Return an edge OID or InvalidOID

Reimplemented in sparksee.DefaultExport.

next_node()

sparksee.ExportManager.next_node

(

self

)

Gets the next node to export or InvalidOID.

It will return valid node OIDs to export and InvalidOID when there is not any more nodes to export. ExportAll returns false.

Returns

oid_t Return a node OID or InvalidOID

Reimplemented in sparksee.DefaultExport.

prepare()

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.

release()

sparksee.ExportManager.release

(

self

)

Ends the export process.

It is called once after the export process.

Reimplemented in sparksee.DefaultExport.