STSDefaultExport Class Reference

Default implementation for ExportManager class. More...

#include <Sparksee.h>

Inheritance diagram for STSDefaultExport:

Collaboration diagram for STSDefaultExport:

Instance Methods
(id)	- init
	Creates a new instance.
(BOOL)	- subgraphNodes:
	Limit the exported nodes to the nodes in the given node set.
(BOOL)	- subgraphEdges:
	Limit the exported edges to the edges in the given edges set.
(void)	- setTitleWithAttributes:
	Include additional information including all the node/edge attributes as Title instead of the default title text (just the type name).
(void)	- setTypeColorRGB:color:
	Set the color for a specific node/edge type.
(void)	- setNodeTypeImage:image:
	Set an image for all the nodes of a specific node type.
(void)	- setNodeTypeImageAttribute:imageAttr:
	Set the attribute that stores the image for a specific node type.
(void)	- setTypeLabelAttribute:labelAttr:
	Set the attribute that stores the label for a specific node/edge type.
(void)	- setNodeTypeShape:shape:
	Set the shape for all nodes of this type.
(BOOL)	- setMaxTextCharacters:
	Sets the maximum number of Text Attribute characters to show.
(BOOL)	- setMaxArrayElements:
	Sets the maximum number of elements of an Array Attribute to show.
(void)	- prepare:
	Default implementation of the ExportManager class method Prepare.
(void)	- prepareSwigExplicitSTSDefaultExport:
	Default implementation of the ExportManager class method Prepare.
(void)	- close
	Default implementation of the ExportManager class method Release.
(void)	- closeSwigExplicitSTSDefaultExport
	Default implementation of the ExportManager class method Release.
(BOOL)	- getGraph:
	Default implementation of the ExportManager class method GetGraph.
(BOOL)	- getGraphSwigExplicitSTSDefaultExport:
	Default implementation of the ExportManager class method GetGraph.
(BOOL)	- getNodeType:nodeExport:
	Default implementation of the ExportManager class method GetNodeType.
(BOOL)	- getNodeTypeSwigExplicitSTSDefaultExport:nodeExport:
	Default implementation of the ExportManager class method GetNodeType.
(BOOL)	- getEdgeType:edgeExport:
	Default implementation of the ExportManager class method GetEdgeType.
(BOOL)	- getEdgeTypeSwigExplicitSTSDefaultExport:edgeExport:
	Default implementation of the ExportManager class method GetEdgeType.
(BOOL)	- getNode:nodeExport:
	Default implementation of the ExportManager class method GetNode.
(BOOL)	- getNodeSwigExplicitSTSDefaultExport:nodeExport:
	Default implementation of the ExportManager class method GetNode.
(BOOL)	- getEdge:edgeExport:
	Default implementation of the ExportManager class method GetEdge.
(BOOL)	- getEdgeSwigExplicitSTSDefaultExport:edgeExport:
	Default implementation of the ExportManager class method GetEdge.
(BOOL)	- enableType:
	Default implementation of the ExportManager class method EnableType.
(BOOL)	- enableTypeSwigExplicitSTSDefaultExport:
	Default implementation of the ExportManager class method EnableType.
(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)	- exportAllSwigExplicitSTSDefaultExport
	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)	- nextNodeSwigExplicitSTSDefaultExport
	Gets the next node to export or InvalidOID.
(long long)	- nextEdge
	Gets the next edge to export or InvalidOID.
(long long)	- nextEdgeSwigExplicitSTSDefaultExport
	Gets the next edge to export or InvalidOID.
(void)	- setTypeColor:red:green:blue:alpha:
	Set Set the color for a specific node/edge type with separated RGBA components.
(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)	- nextNodeSwigExplicitSTSExportManager
	Gets the next node to export or InvalidOID.
(long long)	- nextEdgeSwigExplicitSTSExportManager
	Gets the next edge to export or InvalidOID.

Detailed Description

Default implementation for ExportManager class.

It uses the default values from GraphExport, NodeExport and EdgeExport to export all node and edge types.

Author

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

Method Documentation

enableType:

- (BOOL) enableType:

(int)

type

Default implementation of the ExportManager class method EnableType.

This enables all node and edge types to be exported.

Parameters

type	[in] The type to enable.

Returns

TRUE.

Implements STSExportManager.

enableTypeSwigExplicitSTSDefaultExport:

- (BOOL) enableTypeSwigExplicitSTSDefaultExport:

(int)

type

Default implementation of the ExportManager class method EnableType.

This enables all node and edge types to be exported.

Parameters

type	[in] The type to enable.

Returns

TRUE.

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 Next() method of this class to get the only nodes/edges that should be exported. It will return true to export all the graph unless a subgraph had been selected by calling the SubgraphNodes or SubgraphEdges methods.

Returns

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

Implements STSExportManager.

References exportAll.

Referenced by exportAll.

exportAllSwigExplicitSTSDefaultExport

- (BOOL) exportAllSwigExplicitSTSDefaultExport

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 Next() method of this class to get the only nodes/edges that should be exported. It will return true to export all the graph unless a subgraph had been selected by calling the SubgraphNodes or SubgraphEdges methods.

Returns

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

References exportAllSwigExplicitSTSDefaultExport.

Referenced by exportAllSwigExplicitSTSDefaultExport.

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

Default implementation of the ExportManager class method GetEdge.

This sets the default EdgeExport values and sets the OID as the label. Also, it exports the edge as directed just if the edge is directed.

Parameters

edge	[in] An edge.
edgeExport	[out] The EdgeExport that will store the information.

Returns

TRUE.

Implements STSExportManager.

getEdgeSwigExplicitSTSDefaultExport:edgeExport:

- (BOOL) getEdgeSwigExplicitSTSDefaultExport:		(long long)	edge
edgeExport:		(STSEdgeExport *)	edgeExport

Default implementation of the ExportManager class method GetEdge.

This sets the default EdgeExport values and sets the OID as the label. Also, it exports the edge as directed just if the edge is directed.

Parameters

edge	[in] An edge.
edgeExport	[out] The EdgeExport that will store the information.

Returns

TRUE.

getEdgeType:edgeExport:

- (BOOL) getEdgeType:		(int)	type
edgeExport:		(STSEdgeExport *)	edgeExport

Default implementation of the ExportManager class method GetEdgeType.

This sets de default EdgeExport values.

Parameters

type	[in] An edge type.
edgeExport	[out] The EdgeExport that will store the information.

Returns

TRUE.

Implements STSExportManager.

getEdgeTypeSwigExplicitSTSDefaultExport:edgeExport:

- (BOOL) getEdgeTypeSwigExplicitSTSDefaultExport:		(int)	type
edgeExport:		(STSEdgeExport *)	edgeExport

Default implementation of the ExportManager class method GetEdgeType.

This sets de default EdgeExport values.

Parameters

type	[in] An edge type.
edgeExport	[out] The EdgeExport that will store the information.

Returns

TRUE.

getGraph:

- (BOOL) getGraph:

(STSGraphExport *)

graphExport

Default implementation of the ExportManager class method GetGraph.

This sets the default GraphExport values including the default background color and the database alias as the label. The default GraphExport label could be empty (because the database did not have an alias) but this method will add " graph" or " subgraph" to the label anyway to easily know if the hole graph was exported or just some nodes/edges.

Parameters

graphExport

[out] The GraphExport that will store the information.

Returns

TRUE.

Implements STSExportManager.

getGraphSwigExplicitSTSDefaultExport:

- (BOOL) getGraphSwigExplicitSTSDefaultExport:

(STSGraphExport *)

graphExport

Default implementation of the ExportManager class method GetGraph.

This sets the default GraphExport values including the default background color and the database alias as the label. The default GraphExport label could be empty (because the database did not have an alias) but this method will add " graph" or " subgraph" to the label anyway to easily know if the hole graph was exported or just some nodes/edges.

Parameters

graphExport

[out] The GraphExport that will store the information.

Returns

TRUE.

getNode:nodeExport:

- (BOOL) getNode:		(long long)	node
nodeExport:		(STSNodeExport *)	nodeExport

Default implementation of the ExportManager class method GetNode.

This sets the default NodeExport values and sets the OID as the label.

Parameters

node	[in] A node.
nodeExport	[out] The NodeExport that will store the information.

Returns

TRUE.

Implements STSExportManager.

getNodeSwigExplicitSTSDefaultExport:nodeExport:

- (BOOL) getNodeSwigExplicitSTSDefaultExport:		(long long)	node
nodeExport:		(STSNodeExport *)	nodeExport

Default implementation of the ExportManager class method GetNode.

This sets the default NodeExport values and sets the OID as the label.

Parameters

node	[in] A node.
nodeExport	[out] The NodeExport that will store the information.

Returns

TRUE.

getNodeType:nodeExport:

- (BOOL) getNodeType:		(int)	type
nodeExport:		(STSNodeExport *)	nodeExport

Default implementation of the ExportManager class method GetNodeType.

This sets de default NodeExport values.

Parameters

type	[in] A node type.
nodeExport	[out] The NodeExport that will store the information.

Returns

TRUE.

Implements STSExportManager.

getNodeTypeSwigExplicitSTSDefaultExport:nodeExport:

- (BOOL) getNodeTypeSwigExplicitSTSDefaultExport:		(int)	type
nodeExport:		(STSNodeExport *)	nodeExport

Default implementation of the ExportManager class method GetNodeType.

This sets de default NodeExport values.

Parameters

type	[in] A node type.
nodeExport	[out] The NodeExport that will store the information.

Returns

TRUE.

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

Implements STSExportManager.

References nextEdge.

Referenced by nextEdge.

nextEdgeSwigExplicitSTSDefaultExport

- (long long) nextEdgeSwigExplicitSTSDefaultExport

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

Referenced by nextEdgeSwigExplicitSTSDefaultExport.

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

Implements STSExportManager.

References nextNode.

Referenced by nextNode.

nextNodeSwigExplicitSTSDefaultExport

- (long long) nextNodeSwigExplicitSTSDefaultExport

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

Referenced by nextNodeSwigExplicitSTSDefaultExport.

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

Default implementation of the ExportManager class method Prepare.

Parameters

graph

null

Implements STSExportManager.

prepareSwigExplicitSTSDefaultExport:

- (void) prepareSwigExplicitSTSDefaultExport:

(STSGraph *)

graph

Default implementation of the ExportManager class method Prepare.

Parameters

graph

null

setMaxArrayElements:

- (BOOL) setMaxArrayElements:

(int)

size

Sets the maximum number of elements of an Array Attribute to show.

If an Array Attribute has more than the given size elements, only the first ones will be used and "..." will be added.

Parameters

size

null

Returns

Returns True if successful or False if the give value is not valid.

setMaxTextCharacters:

- (BOOL) setMaxTextCharacters:

(int)

size

Sets the maximum number of Text Attribute characters to show.

If a Text Attribute has more than the given size characters it will be truncated and "..." will be added.

Parameters

size

null

Returns

Returns True if successful or False if the give value is not valid.

setNodeTypeImage:image:

- (void) setNodeTypeImage:		(int)	nodeType
image:		(NSString *)	image

Set an image for all the nodes of a specific node type.

Parameters

nodeType	[in] A valid node type.
image	[in] A path or URL of the image to use for all nodes of this type.

setNodeTypeImageAttribute:imageAttr:

- (void) setNodeTypeImageAttribute:		(int)	nodeType
imageAttr:		(int)	imageAttr

Set the attribute that stores the image for a specific node type.

Parameters

nodeType	[in] A valid node type.
imageAttr	[in] The attribute to use for nodes of this type to get the image url/path.

setNodeTypeShape:shape:

- (void) setNodeTypeShape:		(int)	nodeType
shape:		(enum STSNodeShape)	shape

Set the shape for all nodes of this type.

Parameters

nodeType	[in] A valid node type.
shape	[in] The shape for all the nodes of the given type.

setTitleWithAttributes:

- (void) setTitleWithAttributes:

(BOOL)

encoded

Include additional information including all the node/edge attributes as Title instead of the default title text (just the type name).

Parameters

encoded

[in] If true the tooltip data will be added as a base64 encoded JSON instead of very basic html text format for easy parsing of the additional data.

setTypeColor:red:green:blue:alpha:

- (void) setTypeColor:		(int)	type
red:		(double)	red
green:		(double)	green
blue:		(double)	blue
alpha:		(double)	alpha

Set Set the color for a specific node/edge type with separated RGBA components.

Parameters

red	[in] The red color component ([0..1]).
green	[in] The green color component ([0..1]).
blue	[in] The blue color component ([0..1]).
alpha	[in] The alpha component ([0..1]).

setTypeColorRGB:color:

- (void) setTypeColorRGB:		(int)	type
color:		(int)	color

Set the color for a specific node/edge type.

Parameters

type	[in] A valid node/edge type.
color	[in] The main color for the type. The label color will be set as a complementary color from the given color to guarantee that it will contrast.

setTypeLabelAttribute:labelAttr:

- (void) setTypeLabelAttribute:		(int)	type
labelAttr:		(int)	labelAttr

Set the attribute that stores the label for a specific node/edge type.

Parameters

type	[in] A valid node/edge type.
labelAttr	[in] The attribute to use for nodes/edges of this type to get the label. If a valid label can be obttained from the attribute it will be used instead of the default OID.

subgraphEdges:

- (BOOL) subgraphEdges:

(STSObjects *)

edges

Limit the exported edges to the edges in the given edges set.

If only the subgraph edges are specified, the exported nodes will be calculated as all the nodes present in the selected edges.

Parameters

edges

[in] Subgraph edges to export. Must be kept alive by the user until the export is finished. The given Objects set can also contain nodes, but will be ignored. This is useful to use a signle Objects set to limit both subgraph nodes and edges. But if an Objects containing both nodes and edges is used, then both SubgraphNodes and SubgraphEdges methods must be called.

Returns

Returns true if successful or false otherwise.

subgraphNodes:

- (BOOL) subgraphNodes:

(STSObjects *)

nodes

Limit the exported nodes to the nodes in the given node set.

If only the subgraph nodes are specified, the exported edges will be calculated as all the edges between the selected nodes.

Parameters

nodes

[in] Subgraph nodes to export. Must be kept alive by the user until the export is finished. The given Objects set can also contain edges, but will be ignored. This is useful to use a signle Objects set to limit both subgraph nodes and edges. But if an Objects containing both nodes and edges is used, then both SubgraphNodes and SubgraphEdges methods must be called.

Returns

Returns true if successful or false otherwise.

---

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

• Sparksee.h