
Plexus v0.13.1  
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
public interface Graph
The root interface of the graph hierarchy.
See the Overview Summary for details not included here.
Nodes must contain unique (using Object.equals()
) userprovided objects. This requirement allows
nodes to be referenced unambiguously (when creating edges, for
example). The userdefined objects contained in Graph.Edge
objects, however, are not subject to this requirement in the
general case, although Object.equals()
will be used
for edge comparisons.
Nothing in this interface prohibits a Graph.Edge
from also
being a node in the same Graph
. In other words,
Graph.Edges
can point to other
Graph.Edges
. If a particular Graph
implementation allows this, these two aspects of any particular
Graph.Edge
are independent. Adding or removing an
Graph.Edge
as a node has no impact upon the object's
existence as a Graph.Edge
, and vice versa.
All generalpurpose implementations of this interface should
provide two "standard" constructors: a void (no arguments)
constructor, which creates an empty graph, and a constructor with
a single argument of type Graph
, which creates a new
graph with the same elements as its argument.
Nested Class Summary  

static interface 
Graph.Edge
An interface describing an edge in a Graph . 
Method Summary  

Graph.Edge 
addEdge(Object object,
Object tail,
Object head,
boolean isDirected)
Adds the specified edge to the Graph (optional
operation). 
boolean 
addNode(Object node)
Adds node to this Graph (optional
operation). 
Collection 
adjacentNodes(Object node,
org.apache.commons.collections.Predicate traverserPredicate)
Returns the nodes adjacent to the specified node
for which the specified Predicate is satisfied. 
boolean 
containsEdge(Graph.Edge edge)
Returns true if this Graph contains
the specified Graph.Edge . 
boolean 
containsNode(Object node)
Returns true if this Graph contains
the specified node. 
int 
degree(Object node)
Returns the degree of node , defined as the number
of edges incident on node , with selfloops
counted twice. 
int 
degree(Object node,
org.apache.commons.collections.Predicate traverserPredicate)
Returns the degree of node for which the
specified Predicate is satisfied, defined as the
number of edges incident on node that pass the
predicate, with selfloops counted only once. 
Collection 
edges(org.apache.commons.collections.Predicate edgePredicate)
Returns the Graph.Edges from this
Graph that satisfy the specified
predicate . 
Object 
getAdjacentNode(Object node,
org.apache.commons.collections.Predicate traverserPredicate)
Returns a node adjacent to the specified node for
which the specified Predicate is satisfied. 
Graph.Edge 
getEdge(org.apache.commons.collections.Predicate edgePredicate)
Returns a Graph.Edge from this Graph
that satisfies the specified predicate , or
null if no such Graph.Edge exists. 
Graph.Edge 
getIncidentEdge(Object node,
org.apache.commons.collections.Predicate traverserPredicate)
Returns a Graph.Edge incident on the specified
node for which the specified
Predicate is satisfied. 
Object 
getNode(org.apache.commons.collections.Predicate nodePredicate)
Returns a node from this Graph that satisfies the
specified predicate , or null if no
such node exists. 
Collection 
incidentEdges(Object node,
org.apache.commons.collections.Predicate traverserPredicate)
Returns the Graph.Edges incident on the specified
node for which the specified
Predicate is satisfied. 
Collection 
nodes(org.apache.commons.collections.Predicate nodePredicate)
Returns the nodes from this Graph that satisfy
the specified predicate . 
boolean 
removeEdge(Graph.Edge edge)
Removes the specified Graph.Edge from this
Graph (optional operation). 
boolean 
removeNode(Object node)
Removes node from this Graph
(optional operation). 
Traverser 
traverser(Object node,
org.apache.commons.collections.Predicate traverserPredicate)
Returns a Traverser from node to all
adjacent nodes for which the specified Predicate
is satisfied. 
Method Detail 

boolean addNode(Object node)
node
to this Graph
(optional
operation). Returns true
if this
Graph
changed as a result of the call. Returns
false
if this Graph
already contains
node
.
If a Graph
refuses to add a particular node
for any reason other than that it already contains the node,
it must throw an exception (rather than returning
false
). This preserves the invariant that a
Graph
always contains the specified node after
this call returns. Graph
classes should clearly
specify in their documentation any other restrictions on what
nodes may be added.
node
 the node to be added to this Graph
.
true
if this Graph
changed
as a result of the call, false
if this
Graph
already contains the specified node.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
UnsupportedOperationException
 if this method is not
supported by this Graph
.boolean removeNode(Object node)
node
from this Graph
(optional operation). This method will also remove all edges
incident on node
.
node
 the node to be removed from this
Graph
.
true
if this Graph
contained
node
.
UnsupportedOperationException
 if this method is not
supported by this Graph
.boolean containsNode(Object node)
true
if this Graph
contains
the specified node.
node
 the node whose presence in this Graph
is to be tested.
true
if this Graph
contains
the specified node.Graph.Edge addEdge(Object object, Object tail, Object head, boolean isDirected)
Graph
(optional
operation). Returns the newly created Graph.Edge
if this Graph
changed as a result of the call.
Returns null
if this Graph
does not
allow duplicate edges and already contains the specified edge.
If a Graph
refuses to add a particular edge
for any reason other than that it already contains the edge,
it must throw an exception (rather than returning
null
). This preserves the invariant that a
Graph
always contains the specified edge after
this call returns. Graph
classes should clearly
specify in their documentation any other restrictions on what
edges may be added.
object
 the userdefined object to be contained in the
new edge.tail
 the first endpoint of the new edge.head
 the second endpoint of the new edge.isDirected
 whether the new edge is directed.
Graph.Edge
if this
Graph
changed as a result of the call,
null
if this Graph
does not allow
duplicate edges and already contains the specified edge.
ClassCastException
 if the class of
object
, tail
, or head
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
object
, tail
, head
, or
isDirected
is inappropriate for this
Graph
.
IllegalArgumentException
 if object
,
tail
, or head
is null
and this Graph
does not not permit
null
edges and/or nodes.
NoSuchNodeException
 if tail
or
head
is not present in this Graph
.
UnsupportedOperationException
 if this method is not
supported by this Graph
.boolean removeEdge(Graph.Edge edge)
Graph.Edge
from this
Graph
(optional operation).
edge
 the Graph.Edge
to be removed from
this Graph
.
true
if this Graph
contained
the specified Graph.Edge
.
UnsupportedOperationException
 if this method is not
supported by this Graph
.boolean containsEdge(Graph.Edge edge)
true
if this Graph
contains
the specified Graph.Edge
.
edge
 the Graph.Edge
whose presence in this
Graph
is to be tested.
true
if this Graph
contains
the specified Graph.Edge
.int degree(Object node)
node
, defined as the number
of edges incident on node
, with selfloops
counted twice. If this node has more than
Integer.MAX_VALUE
incident edges, returns
Integer.MAX_VALUE
.
node
 return the degree of this node.
node
.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.int degree(Object node, org.apache.commons.collections.Predicate traverserPredicate)
node
for which the
specified Predicate
is satisfied, defined as the
number of edges incident on node
that pass the
predicate, with selfloops counted only once. The argument to
the Predicate.evaluate()
method is expected to be
an OrderedPair
. The first
element of the OrderedPair
is the specified
node
, the second is the Graph.Edge
.
If this node has more than Integer.MAX_VALUE
such
edges, returns Integer.MAX_VALUE
.
node
 return the degree of this node for which the
specified predicate is satisfied.traverserPredicate
 the predicate which the counted
Graph.Edges
must satisfy.
node
for which the
specified predicate is satisfied.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.Collection nodes(org.apache.commons.collections.Predicate nodePredicate)
Graph
that satisfy
the specified predicate
.
nodePredicate
 the predicate which the returned nodes
must satisfy.
Graph
that satisfy
the specified predicate
.Collection edges(org.apache.commons.collections.Predicate edgePredicate)
Graph.Edges
from this
Graph
that satisfy the specified
predicate
.
edgePredicate
 the predicate which the returned
Graph.Edges
must satisfy.
Graph.Edges
from this
Graph
that satisfy the specified
predicate
.Collection adjacentNodes(Object node, org.apache.commons.collections.Predicate traverserPredicate)
node
for which the specified Predicate
is satisfied.
The argument to the Predicate.evaluate()
method
is expected to be an OrderedPair
. The first element of
the OrderedPair
is the specified
node
, the second is the Graph.Edge
.
It should be noted that removing a node from the returned
Collection
merely removes one instance of it
being adjacent to the specified node
. In other
words, a connecting Graph.Edge
is removed.
node
 return the nodes adjacent to this node for which
the specified predicate is satisfied.traverserPredicate
 the predicate which the returned
nodes and the traversed Graph.Edges
must satisfy.
node
for which the specified predicate is satisfied.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.Collection incidentEdges(Object node, org.apache.commons.collections.Predicate traverserPredicate)
Graph.Edges
incident on the specified
node
for which the specified
Predicate
is satisfied. The argument to the
Predicate.evaluate()
method is expected to be an
OrderedPair
. The first
element of the OrderedPair
is the specified
node
, the second is the Graph.Edge
.
node
 return the Graph.Edges
incident on
this node for which the specified predicate is satisfied.traverserPredicate
 the predicate which the returned
Graph.Edges
must satisfy.
Graph.Edges
incident on the specified
node
for which the specified predicate is
satisfied.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.Object getNode(org.apache.commons.collections.Predicate nodePredicate)
Graph
that satisfies the
specified predicate
, or null
if no
such node exists.
nodePredicate
 the predicate which the returned node
must satisfy.
Graph
that satisfies the
specified predicate
, or null
if no
such node exists.Graph.Edge getEdge(org.apache.commons.collections.Predicate edgePredicate)
Graph.Edge
from this Graph
that satisfies the specified predicate
, or
null
if no such Graph.Edge
exists.
edgePredicate
 the predicate which the returned
Graph.Edge
must satisfy.
Graph.Edge
from this Graph
that satisfies the specified predicate
, or
null
if no such Graph.Edge
exists.Object getAdjacentNode(Object node, org.apache.commons.collections.Predicate traverserPredicate)
node
for
which the specified Predicate
is satisfied. The
argument to the Predicate.evaluate()
method is
expected to be an OrderedPair
. The first element of
the OrderedPair
is the specified
node
, the second is the Graph.Edge
.
node
 traverse to a node adjacent to this node for which
the specified predicate is satisfied.traverserPredicate
 the predicate which the returned
node and the traversed Graph.Edge
must satisfy.
node
for
which the specified predicate is satisfied.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.Graph.Edge getIncidentEdge(Object node, org.apache.commons.collections.Predicate traverserPredicate)
Graph.Edge
incident on the specified
node
for which the specified
Predicate
is satisfied. The argument to the
Predicate.evaluate()
method is expected to be an
OrderedPair
. The first
element of the OrderedPair
is the specified
node
, the second is the Graph.Edge
.
node
 traverse to a Graph.Edge
incident on
this node for which the specified predicate is satisfied.traverserPredicate
 the predicate which the returned
Graph.Edge
must satisfy.
Graph.Edge
incident on the specified
node
for which the specified predicate is
satisfied.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.Traverser traverser(Object node, org.apache.commons.collections.Predicate traverserPredicate)
Traverser
from node
to all
adjacent nodes for which the specified Predicate
is satisfied. The argument to the
Predicate.evaluate()
method is expected to be an
OrderedPair
. The first
element of the OrderedPair
is the specified
node
, the second is the Graph.Edge
.
The nodes returned by Iterator.next()
are not
necessarily distinct. Selfloops are only traversed once.
There are no guarantees concerning the order in which the
nodes are returned (unless this Graph
is an
instance of some class that provides a guarantee).
node
 traverse over all nodes adjacent to this node for
which the specified predicate is satisfied.traverserPredicate
 the predicate which the returned
nodes and their traversed Graph.Edges
must
satisfy.
Traverser
from node
to all
adjacent nodes for which the specified predicate is satisfied.
ClassCastException
 if the class of node
is of an inappropriate class for this Graph
.
IllegalArgumentException
 if some aspect of
node
is inappropriate for this
Graph
.
IllegalArgumentException
 if node
is
null
and this Graph
does not not
permit null
nodes.
NoSuchNodeException
 if node
is not
present in this Graph
.

Plexus v0.13.1  
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 