DexNet 4.7.0
Public Member Functions
com::sparsity::dex::gdb::ExportManager Class Reference

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

Inheritance diagram for com::sparsity::dex::gdb::ExportManager:
Inheritance graph

List of all members.

Public Member Functions

bool GetNodeType (int type, com.sparsity.dex.gdb.NodeExport nodeExport)
 Gets the default node export definition for the given node type.
bool GetEdge (long edge, com.sparsity.dex.gdb.EdgeExport edgeExport)
 Gets the edge export definition for the given edge.
bool GetGraph (com.sparsity.dex.gdb.GraphExport graphExport)
 Gets the graph export definition.
bool GetEdgeType (int type, com.sparsity.dex.gdb.EdgeExport edgeExport)
 Gets the default node export definition for the given edge type.
void Prepare (com.sparsity.dex.gdb.Graph graph)
 Prepares the graph for the export process.
bool GetNode (long node, com.sparsity.dex.gdb.NodeExport nodeExport)
 Gets the node export definition for the given node.
void Release ()
 Ends the export process.
bool EnableType (int 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, these are the available formats: (i) ExportType.Graphviz, (ii) ExportType.GraphML, and (iii) ExportType.YGraphML

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

Member Function Documentation

bool com::sparsity::dex::gdb::ExportManager::EnableType ( int  type)

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

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

Reimplemented in com::sparsity::dex::gdb::DefaultExport.

bool com::sparsity::dex::gdb::ExportManager::GetEdge ( long  edge,
com.sparsity.dex.gdb.EdgeExport  edgeExport 
)

Gets the edge export definition for the given edge.

Parameters:
edgeEdge 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 com::sparsity::dex::gdb::DefaultExport.

bool com::sparsity::dex::gdb::ExportManager::GetEdgeType ( int  type,
com.sparsity.dex.gdb.EdgeExport  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 com::sparsity::dex::gdb::DefaultExport.

bool com::sparsity::dex::gdb::ExportManager::GetGraph ( com.sparsity.dex.gdb.GraphExport  graphExport)

Gets the graph export definition.

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

Reimplemented in com::sparsity::dex::gdb::DefaultExport.

bool com::sparsity::dex::gdb::ExportManager::GetNode ( long  node,
com.sparsity.dex.gdb.NodeExport  nodeExport 
)

Gets the node export definition for the given node.

Parameters:
nodeNode 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 com::sparsity::dex::gdb::DefaultExport.

bool com::sparsity::dex::gdb::ExportManager::GetNodeType ( int  type,
com.sparsity.dex.gdb.NodeExport  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 com::sparsity::dex::gdb::DefaultExport.

void com::sparsity::dex::gdb::ExportManager::Prepare ( com.sparsity.dex.gdb.Graph  graph)

Prepares the graph for the export process.

It is called once before the export process.

Parameters:
graphGraph to be exported.

Reimplemented in com::sparsity::dex::gdb::DefaultExport.

void com::sparsity::dex::gdb::ExportManager::Release ( )

Ends the export process.

It is called once after the export process.

Reimplemented in com::sparsity::dex::gdb::DefaultExport.