Sparksee  5.2.0
STSExportManager Class Reference

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

Inheritance diagram for STSExportManager:
Inheritance graph
Collaboration diagram for STSExportManager:
Collaboration graph

Instance Methods

(void) - prepare:
 Prepares the graph for the export process.
 
(void) - close
 Ends the export process.
 
(BOOL) - getGraph:
 Gets the graph export definition.
 
(BOOL) - getNodeType:nodeExport:
 Gets the default node export definition for the given node type.
 
(BOOL) - getEdgeType:edgeExport:
 Gets the default node export definition for the given edge type.
 
(BOOL) - getNode:nodeExport:
 Gets the node export definition for the given node.
 
(BOOL) - getEdge:edgeExport:
 Gets the edge export definition for the given edge.
 
(BOOL) - enableType:
 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

Method Documentation

- (void) close

Ends the export process.

It is called once after the export process.

Implemented in STSDefaultExport.

- (BOOL) 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.

Implemented in STSDefaultExport.

- (BOOL) getEdge: (long long)  edge
edgeExport: (STSEdgeExport *)  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.

Implemented in STSDefaultExport.

- (BOOL) getEdgeType: (int)  type
edgeExport: (STSEdgeExport *)  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.

Implemented in STSDefaultExport.

- (BOOL) getGraph: (STSGraphExport *)  graphExport

Gets the graph export definition.

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

Implemented in STSDefaultExport.

- (BOOL) getNode: (long long)  node
nodeExport: (STSNodeExport *)  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.

Implemented in STSDefaultExport.

- (BOOL) getNodeType: (int)  type
nodeExport: (STSNodeExport *)  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.

Implemented in STSDefaultExport.

- (void) prepare: (STSGraph *)  graph

Prepares the graph for the export process.

It is called once before the export process.

Parameters
graphGraph to be exported.

Implemented in STSDefaultExport.


The documentation for this class was generated from the following file: