com.touchgraph.graphlayout.graphelements
Interface ImmutableGraphEltSet

All Known Implementing Classes:

GraphEltSet, Locality, VisibleLocality

public interface ImmutableGraphEltSet

ImmutableGraphEltSet provides access to the elements of GraphElementSet that does not allow for addition or deletion of nodes or edges.

Version:

1.21 $Id: ImmutableGraphEltSet.java,v 3.0 2004/07/24 13:21:17 altheim Exp $

Author:

Alexander Shapiro

Method Summary

int	edgeCount() Return the number of Edges in the cumulative Vector.
Edge	findEdge(Node from, Node to) Return an Edge spanning Node from to Node to.
Node	findNode(String id) Return the Node whose ID matches the String id, null if no match is found.
Node	findNodeLabelContaining(String substring) Return the first Nodes whose label contains the String substring, null if no match is found.
Collection	findNodesByLabel(String label) Return a Collection of all Nodes whose label matches the String label, null if no match is found.
void	forAllEdges(TGForEachEdge fee) iterates through Edges.
void	forAllNodePairs(TGForEachNodePair fenp) iterates through pairs of Nodes.
void	forAllNodes(TGForEachNode fen) iterates through all the nodes.
Iterator	getEdges() Return an iterator over the Edges in the cumulative Vector, null if it is empty.
Node	getFirstNode() Return the first Node, null if none exist.
Iterator	getNodes() Return an iterator over the Nodes in the cumulative Vector, null if it is empty.
Node	getRandomNode() Returns a random node, or null if none exist (for making random graphs).
int	nodeCount() Return the number of Nodes in the cumulative Vector.

Method Detail

nodeCount

int nodeCount()

Return the number of Nodes in the cumulative Vector.

getNodes

Iterator getNodes()

Return an iterator over the Nodes in the cumulative Vector, null if it is empty.

edgeCount

int edgeCount()

Return the number of Edges in the cumulative Vector.

getEdges

Iterator getEdges()

Return an iterator over the Edges in the cumulative Vector, null if it is empty.

findNode

Node findNode(String id)

Return the Node whose ID matches the String id, null if no match is found.

findNodesByLabel

Collection findNodesByLabel(String label)

Return a Collection of all Nodes whose label matches the String label, null if no match is found.

findNodeLabelContaining

Node findNodeLabelContaining(String substring)

Return the first Nodes whose label contains the String substring, null if no match is found.

findEdge

Edge findEdge(Node from,
              Node to)

Return an Edge spanning Node from to Node to.

getRandomNode

Node getRandomNode()

Returns a random node, or null if none exist (for making random graphs).

getFirstNode

Node getFirstNode()

Return the first Node, null if none exist.

forAllNodes

void forAllNodes(TGForEachNode fen)

iterates through all the nodes.

forAllNodePairs

void forAllNodePairs(TGForEachNodePair fenp)

iterates through pairs of Nodes.

forAllEdges

void forAllEdges(TGForEachEdge fee)

iterates through Edges.