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

#include <Sparksee.h>

Inheritance diagram for STSExportManager:

Collaboration diagram for STSExportManager:

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.
(BOOL)	- exportAll
	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.
(BOOL)	- exportAllSwigExplicitSTSExportManager
	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.
(long long)	- nextNode
	Gets the next node to export or InvalidOID.
(long long)	- nextNodeSwigExplicitSTSExportManager
	Gets the next node to export or InvalidOID.
(long long)	- nextEdge
	Gets the next edge to export or InvalidOID.
(long long)	- nextEdgeSwigExplicitSTSExportManager
	Gets the next edge to export or InvalidOID.

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

◆ close

- (void) close

Ends the export process.

It is called once after the export process.

Implemented in STSDefaultExport.

References close.

Referenced by close.

◆ enableType:

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

Implemented in STSDefaultExport.

◆ exportAll

- (BOOL) exportAll

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.

Implemented in STSDefaultExport.

References exportAll.

Referenced by exportAll.

◆ exportAllSwigExplicitSTSExportManager

- (BOOL) exportAllSwigExplicitSTSExportManager

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.

References exportAllSwigExplicitSTSExportManager.

Referenced by exportAllSwigExplicitSTSExportManager.

◆ getEdge:edgeExport:

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

Implemented in STSDefaultExport.

◆ getEdgeType:edgeExport:

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

◆ getGraph:

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

◆ getNode:nodeExport:

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

Implemented in STSDefaultExport.

◆ getNodeType:nodeExport:

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

◆ nextEdge

- (long long) nextEdge

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

Implemented in STSDefaultExport.

References nextEdge.

Referenced by nextEdge.

◆ nextEdgeSwigExplicitSTSExportManager

- (long long) nextEdgeSwigExplicitSTSExportManager

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

References nextEdgeSwigExplicitSTSExportManager.

Referenced by nextEdgeSwigExplicitSTSExportManager.

◆ nextNode

- (long long) nextNode

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

Implemented in STSDefaultExport.

References nextNode.

Referenced by nextNode.

◆ nextNodeSwigExplicitSTSExportManager

- (long long) nextNodeSwigExplicitSTSExportManager

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

References nextNodeSwigExplicitSTSExportManager.

Referenced by nextNodeSwigExplicitSTSExportManager.

◆ prepare:

- (void) prepare: (STSGraph *) graph

Prepares the graph for the export process.

It is called once before the export process.

Parameters

graph Graph to be exported.

Implemented in STSDefaultExport.

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

Sparksee.h

Instance Methods

Detailed Description

Method Documentation

◆ close

◆ enableType:

◆ exportAll

◆ exportAllSwigExplicitSTSExportManager

◆ getEdge:edgeExport:

◆ getEdgeType:edgeExport:

◆ getGraph:

◆ getNode:nodeExport:

◆ getNodeType:nodeExport:

◆ nextEdge

◆ nextEdgeSwigExplicitSTSExportManager

◆ nextNode

◆ nextNodeSwigExplicitSTSExportManager

◆ prepare: