Packagecom.yworks.io.graphml.writer
Interfacepublic interface IGraphElementProvider
Implementors DefaultGraphElementProvider

Provide generic access to the objects in a graph structure



Public Methods
 MethodDefined By
  
Returns the number of edges in the graph.
IGraphElementProvider
  
Returns an iterator over all edges that are contained in the current graph object.
IGraphElementProvider
  
Returns the graph object.
IGraphElementProvider
  
Returns the number of nodes in the graph.
IGraphElementProvider
  
Returns an iterator over all nodes that are contained in the current graph object.
IGraphElementProvider
  
Returns the subgraph which might be defined under a node.
IGraphElementProvider
  
Returns an iterator over all ports that belong to the given node
IGraphElementProvider
  
getSourceNode(edge:Object):Object
Returns the source node of the given edge.
IGraphElementProvider
  
getSourcePort(edge:Object):Object
Returns the source port of the given edge
IGraphElementProvider
  
getTargetNode(edge:Object):Object
Returns the target node of the given edge
IGraphElementProvider
  
getTargetPort(edge:Object):Object
Returns the target port of the given edge
IGraphElementProvider
  
Returns whether the default direction of edges in the graph is directed.
IGraphElementProvider
  
isDirected(edge:Object):Object
Returns true if the given edge is directed
IGraphElementProvider
Method Detail
getEdgeCount()method
public function getEdgeCount():int

Returns the number of edges in the graph.

Returns
int — the number of edges in the graph.
getEdgeObjects()method 
public function getEdgeObjects():Iterator

Returns an iterator over all edges that are contained in the current graph object.

Returns
Iterator — An iterator over all edges that are contained in the current graph object
getGraphObject()method 
public function getGraphObject():Object

Returns the graph object.

Returns
Object — the graph object.
getNodeCount()method 
public function getNodeCount():int

Returns the number of nodes in the graph.

Returns
int — The number of nodes in the graph.
getNodeObjects()method 
public function getNodeObjects():Iterator

Returns an iterator over all nodes that are contained in the current graph object.

Returns
Iterator — An iterator over all nodes that are contained in the current graph object
getNodeSubgraph()method 
public function getNodeSubgraph(node:Object):IGraphElementProvider

Returns the subgraph which might be defined under a node.

Parameters

node:Object — The node for which a subgraph is searched

Returns
IGraphElementProvider — The element provider of the subgraph defined under the node, or null if no such subgraph exists.
getPortObjects()method 
public function getPortObjects(node:Object):Iterator

Returns an iterator over all ports that belong to the given node

Parameters

node:Object — the node.

Returns
Iterator — an iterator over all ports that belong to the given node
getSourceNode()method 
public function getSourceNode(edge:Object):Object

Returns the source node of the given edge.

Parameters

edge:Object — the edge.

Returns
Object — The source node of the given edge
getSourcePort()method 
public function getSourcePort(edge:Object):Object

Returns the source port of the given edge

Parameters

edge:Object — the edge.

Returns
Object — the source port of the given edge
getTargetNode()method 
public function getTargetNode(edge:Object):Object

Returns the target node of the given edge

Parameters

edge:Object — the edge.

Returns
Object — the target node of the given edge
getTargetPort()method 
public function getTargetPort(edge:Object):Object

Returns the target port of the given edge

Parameters

edge:Object — the edge.

Returns
Object — the target port of the given edge
isDefaultDirected()method 
public function isDefaultDirected():Boolean

Returns whether the default direction of edges in the graph is directed.

Returns
Booleantrue iff edges are directed by default
isDirected()method 
public function isDirected(edge:Object):Object

Returns true if the given edge is directed

Parameters

edge:Object — the edge.

Returns
Objecttrue if the given edge is directed