Package edu.uci.ics.jung.graph
Class GraphDecorator<V,E>
java.lang.Object
edu.uci.ics.jung.graph.GraphDecorator<V,E>
- All Implemented Interfaces:
Graph<V,
,E> Hypergraph<V,
,E> Serializable
- Direct Known Subclasses:
DelegateForest
,DelegateTree
,ObservableGraph
An implementation of
Graph
that delegates its method calls to a
constructor-specified Graph
instance. This is useful for adding
additional behavior (such as synchronization or unmodifiability) to an existing
instance.- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionGraphDecorator
(Graph<V, E> delegate) Creates a new instance based on the provideddelegate
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
addEdge
(E edge, Collection<? extends V> vertices) Addsedge
to this graph.boolean
addEdge
(E edge, Collection<? extends V> vertices, EdgeType edge_type) Addsedge
to this graph with typeedge_type
.boolean
Adds edgee
to this graph such that it connects vertexv1
tov2
.boolean
Adds edgee
to this graph such that it connects vertexv1
tov2
.boolean
Addsvertex
to this graph.boolean
containsEdge
(E edge) Returns true if this graph's edge collection containsedge
.boolean
containsVertex
(V vertex) Returns true if this graph's vertex collection containsvertex
.int
Returns the number of edges incident tovertex
.Returns an edge that connects this vertex tov
.findEdgeSet
(V v1, V v2) Returns all edges that connects this vertex tov
.Returns the default edge type for this graph.Ifdirected_edge
is a directed edge in this graph, returns the destination; otherwise returnsnull
.int
Returns the number of edges in this graph.int
getEdgeCount
(EdgeType edge_type) Returns the number of edges of typeedge_type
in this graph.getEdges()
Returns a view of all edges in this graph.Returns the collection of edges in this graph which are of typeedge_type
.getEdgeType
(E edge) Returns the edge type ofedge
in this graph.getEndpoints
(E edge) Returns the endpoints ofedge
as aPair
.int
getIncidentCount
(E edge) Returns the number of vertices that are incident toedge
.getIncidentEdges
(V vertex) Returns the collection of edges in this graph which are connected tovertex
.getIncidentVertices
(E edge) Returns the collection of vertices in this graph which are connected toedge
.getInEdges
(V vertex) Returns aCollection
view of the incoming edges incident tovertex
in this graph.int
getNeighborCount
(V vertex) Returns the number of vertices that are adjacent tovertex
(that is, the number of vertices that are incident to edges invertex
's incident edge set).getNeighbors
(V vertex) Returns the collection of vertices which are connected tovertex
via any edges in this graph.getOpposite
(V vertex, E edge) Returns the vertex at the other end ofedge
fromvertex
.getOutEdges
(V vertex) Returns aCollection
view of the outgoing edges incident tovertex
in this graph.int
getPredecessorCount
(V vertex) Returns the number of predecessors thatvertex
has in this graph.getPredecessors
(V vertex) Returns aCollection
view of the predecessors ofvertex
in this graph.Ifdirected_edge
is a directed edge in this graph, returns the source; otherwise returnsnull
.int
getSuccessorCount
(V vertex) Returns the number of successors thatvertex
has in this graph.getSuccessors
(V vertex) Returns aCollection
view of the successors ofvertex
in this graph.int
Returns the number of vertices in this graph.Returns a view of all vertices in this graph.int
Returns the number of incoming edges incident tovertex
.boolean
Returnstrue
ifvertex
is the destination ofedge
.boolean
isIncident
(V vertex, E edge) Returnstrue
ifvertex
andedge
are incident to each other.boolean
isNeighbor
(V v1, V v2) Returnstrue
ifv1
andv2
share an incident edge.boolean
isPredecessor
(V v1, V v2) Returnstrue
ifv1
is a predecessor ofv2
in this graph.boolean
Returnstrue
ifvertex
is the source ofedge
.boolean
isSuccessor
(V v1, V v2) Returnstrue
ifv1
is a successor ofv2
in this graph.int
Returns the number of outgoing edges incident tovertex
.boolean
removeEdge
(E edge) Removesedge
from this graph.boolean
removeVertex
(V vertex) Removesvertex
from this graph.
-
Field Details
-
delegate
-
-
Constructor Details
-
GraphDecorator
Creates a new instance based on the provideddelegate
.- Parameters:
delegate
- the graph to which method calls will be delegated
-
-
Method Details
-
addEdge
Description copied from interface:Hypergraph
Addsedge
to this graph. Fails under the following circumstances:edge
is already an element of the graph- either
edge
orvertices
isnull
vertices
has the wrong number of vertices for the graph typevertices
are already connected by another edge in this graph, and this graph does not accept parallel edges
- Specified by:
addEdge
in interfaceHypergraph<V,
E> - Parameters:
edge
- the edge to addvertices
- the vertices to which the edge will be connected- Returns:
true
if the add is successful, andfalse
otherwise- See Also:
-
addEdge
Description copied from interface:Hypergraph
Addsedge
to this graph with typeedge_type
. Fails under the following circumstances:edge
is already an element of the graph- either
edge
orvertices
isnull
vertices
has the wrong number of vertices for the graph typevertices
are already connected by another edge in this graph, and this graph does not accept parallel edgesedge_type
is not legal for this graph
- Specified by:
addEdge
in interfaceHypergraph<V,
E> - Parameters:
edge
- edge to add to this graphvertices
- vertices which are to be connected by this edgeedge_type
- type of edge to add- Returns:
true
if the add is successful, andfalse
otherwise- See Also:
-
addEdge
Description copied from interface:Graph
Adds edgee
to this graph such that it connects vertexv1
tov2
. Equivalent toaddEdge(e, new Pair(v1, v2))
. If this graph does not containv1
,v2
, or both, implementations may choose to either silently add the vertices to the graph or throw anIllegalArgumentException
. IfedgeType
is not legal for this graph, this method will throwIllegalArgumentException
. SeeHypergraph.addEdge()
for a listing of possible reasons for failure. -
addEdge
Description copied from interface:Graph
Adds edgee
to this graph such that it connects vertexv1
tov2
. Equivalent toaddEdge(e, new Pair(v1, v2))
. If this graph does not containv1
,v2
, or both, implementations may choose to either silently add the vertices to the graph or throw anIllegalArgumentException
. If this graph assigns edge types to its edges, the edge type ofe
will be the default for this graph. SeeHypergraph.addEdge()
for a listing of possible reasons for failure. -
addVertex
Description copied from interface:Hypergraph
Addsvertex
to this graph. Fails ifvertex
is null or already in the graph.- Specified by:
addVertex
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex to add- Returns:
true
if the add is successful, andfalse
otherwise- See Also:
-
isIncident
Description copied from interface:Hypergraph
Returnstrue
ifvertex
andedge
are incident to each other. Equivalent togetIncidentEdges(vertex).contains(edge)
and togetIncidentVertices(edge).contains(vertex)
.- Specified by:
isIncident
in interfaceHypergraph<V,
E> - Parameters:
vertex
- vertex to testedge
- edge to test- Returns:
true
ifvertex
andedge
are incident to each other- See Also:
-
isNeighbor
Description copied from interface:Hypergraph
Returnstrue
ifv1
andv2
share an incident edge. Equivalent togetNeighbors(v1).contains(v2)
.- Specified by:
isNeighbor
in interfaceHypergraph<V,
E> - Parameters:
v1
- the first vertex to testv2
- the second vertex to test- Returns:
true
ifv1
andv2
share an incident edge- See Also:
-
degree
Description copied from interface:Hypergraph
Returns the number of edges incident tovertex
. Special cases of interest:- Incident self-loops are counted once.
- If there is only one edge that connects this vertex to
each of its neighbors (and vice versa), then the value returned
will also be equal to the number of neighbors that this vertex has
(that is, the output of
getNeighborCount
). - If the graph is directed, then the value returned will be the sum of this vertex's indegree (the number of edges whose destination is this vertex) and its outdegree (the number of edges whose source is this vertex), minus the number of incident self-loops (to avoid double-counting).
Equivalent to
getIncidentEdges(vertex).size()
.- Specified by:
degree
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose degree is to be returned- Returns:
- the degree of this node
- See Also:
-
findEdge
Description copied from interface:Hypergraph
Returns an edge that connects this vertex tov
. If this edge is not uniquely defined (that is, if the graph contains more than one edge connectingv1
tov2
), any of these edges may be returned.findEdgeSet(v1, v2)
may be used to return all such edges. Returns null if either of the following is true:v2
is not connected tov1
- either
v1
orv2
are not present in this graph
Note: for purposes of this method,
v1
is only considered to be connected tov2
via a given directed edgee
ifv1 == e.getSource() && v2 == e.getDest()
evaluates totrue
. (v1
andv2
are connected by an undirected edgeu
ifu
is incident to bothv1
andv2
.)- Specified by:
findEdge
in interfaceHypergraph<V,
E> - Parameters:
v1
- the first endpoint of the returned edgev2
- the second endpoint of the returned edge- Returns:
- an edge that connects
v1
tov2
, ornull
if no such edge exists (or either vertex is not present) - See Also:
-
findEdgeSet
Description copied from interface:Hypergraph
Returns all edges that connects this vertex tov
. If this edge is not uniquely defined (that is, if the graph contains more than one edge connectingv1
tov2
), any of these edges may be returned.findEdgeSet(v1, v2)
may be used to return all such edges. Returns null ifv2
is not connected tov1
.
Returns an empty collection if eitherv1
orv2
are not present in this graph.Note: for purposes of this method,
v1
is only considered to be connected tov2
via a given directed edged
ifv1 == d.getSource() && v2 == d.getDest()
evaluates totrue
. (v1
andv2
are connected by an undirected edgeu
ifu
is incident to bothv1
andv2
.)- Specified by:
findEdgeSet
in interfaceHypergraph<V,
E> - Parameters:
v1
- the first endpoint of the returned edge setv2
- the second endpoint of the returned edge set- Returns:
- a collection containing all edges that connect
v1
tov2
, ornull
if either vertex is not present - See Also:
-
getDest
Description copied from interface:Graph
Ifdirected_edge
is a directed edge in this graph, returns the destination; otherwise returnsnull
. The destination of a directed edged
is defined to be the vertex incident tod
for whichd
is an incoming edge.directed_edge
is guaranteed to be a directed edge if itsEdgeType
isDIRECTED
. -
getEdgeCount
public int getEdgeCount()Description copied from interface:Hypergraph
Returns the number of edges in this graph.- Specified by:
getEdgeCount
in interfaceHypergraph<V,
E> - Returns:
- the number of edges in this graph
- See Also:
-
getEdgeCount
Description copied from interface:Hypergraph
Returns the number of edges of typeedge_type
in this graph.- Specified by:
getEdgeCount
in interfaceHypergraph<V,
E> - Parameters:
edge_type
- the type of edge for which the count is to be returned- Returns:
- the number of edges of type
edge_type
in this graph - See Also:
-
getEdges
Description copied from interface:Hypergraph
Returns a view of all edges in this graph. In general, this obeys theCollection
contract, and therefore makes no guarantees about the ordering of the vertices within the set.- Specified by:
getEdges
in interfaceHypergraph<V,
E> - Returns:
- a
Collection
view of all edges in this graph - See Also:
-
getEdges
Description copied from interface:Hypergraph
Returns the collection of edges in this graph which are of typeedge_type
.- Specified by:
getEdges
in interfaceHypergraph<V,
E> - Parameters:
edgeType
- the type of edges to be returned- Returns:
- the collection of edges which are of type
edge_type
, ornull
if the graph does not accept edges of this type - See Also:
-
getEdgeType
Description copied from interface:Hypergraph
Returns the edge type ofedge
in this graph.- Specified by:
getEdgeType
in interfaceHypergraph<V,
E> - Parameters:
edge
- the edge whose type is to be returned- Returns:
- the
EdgeType
ofedge
, ornull
ifedge
has no defined type - See Also:
-
getDefaultEdgeType
Description copied from interface:Hypergraph
Returns the default edge type for this graph.- Specified by:
getDefaultEdgeType
in interfaceHypergraph<V,
E> - Returns:
- the default edge type for this graph
- See Also:
-
getEndpoints
Description copied from interface:Graph
Returns the endpoints ofedge
as aPair
.- Specified by:
getEndpoints
in interfaceGraph<V,
E> - Parameters:
edge
- the edge whose endpoints are to be returned- Returns:
- the endpoints (incident vertices) of
edge
- See Also:
-
getIncidentCount
Description copied from interface:Hypergraph
Returns the number of vertices that are incident toedge
. For hyperedges, this can be any nonnegative integer; for edges this must be 2 (or 1 if self-loops are permitted).Equivalent to
getIncidentVertices(edge).size()
.- Specified by:
getIncidentCount
in interfaceHypergraph<V,
E> - Parameters:
edge
- the edge whose incident vertex count is to be returned- Returns:
- the number of vertices that are incident to
edge
. - See Also:
-
getIncidentEdges
Description copied from interface:Hypergraph
Returns the collection of edges in this graph which are connected tovertex
.- Specified by:
getIncidentEdges
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose incident edges are to be returned- Returns:
- the collection of edges which are connected to
vertex
, ornull
ifvertex
is not present - See Also:
-
getIncidentVertices
Description copied from interface:Hypergraph
Returns the collection of vertices in this graph which are connected toedge
. Note that for some graph types there are guarantees about the size of this collection (i.e., some graphs contain edges that have exactly two endpoints, which may or may not be distinct). Implementations for those graph types may provide alternate methods that provide more convenient access to the vertices.- Specified by:
getIncidentVertices
in interfaceHypergraph<V,
E> - Parameters:
edge
- the edge whose incident vertices are to be returned- Returns:
- the collection of vertices which are connected to
edge
, ornull
ifedge
is not present - See Also:
-
getInEdges
Description copied from interface:Graph
Returns aCollection
view of the incoming edges incident tovertex
in this graph.- Specified by:
getInEdges
in interfaceGraph<V,
E> - Specified by:
getInEdges
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose incoming edges are to be returned- Returns:
- a
Collection
view of the incoming edges incident tovertex
in this graph - See Also:
-
getNeighborCount
Description copied from interface:Hypergraph
Returns the number of vertices that are adjacent tovertex
(that is, the number of vertices that are incident to edges invertex
's incident edge set).Equivalent to
getNeighbors(vertex).size()
.- Specified by:
getNeighborCount
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose neighbor count is to be returned- Returns:
- the number of neighboring vertices
- See Also:
-
getNeighbors
Description copied from interface:Hypergraph
Returns the collection of vertices which are connected tovertex
via any edges in this graph. Ifvertex
is connected to itself with a self-loop, then it will be included in the collection returned.- Specified by:
getNeighbors
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose neighbors are to be returned- Returns:
- the collection of vertices which are connected to
vertex
, ornull
ifvertex
is not present - See Also:
-
getOpposite
Description copied from interface:Graph
Returns the vertex at the other end ofedge
fromvertex
. (That is, returns the vertex incident toedge
which is notvertex
.)- Specified by:
getOpposite
in interfaceGraph<V,
E> - Parameters:
vertex
- the vertex to be queriededge
- the edge to be queried- Returns:
- the vertex at the other end of
edge
fromvertex
- See Also:
-
getOutEdges
Description copied from interface:Graph
Returns aCollection
view of the outgoing edges incident tovertex
in this graph.- Specified by:
getOutEdges
in interfaceGraph<V,
E> - Specified by:
getOutEdges
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose outgoing edges are to be returned- Returns:
- a
Collection
view of the outgoing edges incident tovertex
in this graph - See Also:
-
getPredecessorCount
Description copied from interface:Graph
Returns the number of predecessors thatvertex
has in this graph. Equivalent tovertex.getPredecessors().size()
.- Specified by:
getPredecessorCount
in interfaceGraph<V,
E> - Parameters:
vertex
- the vertex whose predecessor count is to be returned- Returns:
- the number of predecessors that
vertex
has in this graph - See Also:
-
getPredecessors
Description copied from interface:Graph
Returns aCollection
view of the predecessors ofvertex
in this graph. A predecessor ofvertex
is defined as a vertexv
which is connected tovertex
by an edgee
, wheree
is an outgoing edge ofv
and an incoming edge ofvertex
.- Specified by:
getPredecessors
in interfaceGraph<V,
E> - Specified by:
getPredecessors
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose predecessors are to be returned- Returns:
- a
Collection
view of the predecessors ofvertex
in this graph - See Also:
-
getSource
Description copied from interface:Graph
Ifdirected_edge
is a directed edge in this graph, returns the source; otherwise returnsnull
. The source of a directed edged
is defined to be the vertex for whichd
is an outgoing edge.directed_edge
is guaranteed to be a directed edge if itsEdgeType
isDIRECTED
. -
getSuccessorCount
Description copied from interface:Graph
Returns the number of successors thatvertex
has in this graph. Equivalent tovertex.getSuccessors().size()
.- Specified by:
getSuccessorCount
in interfaceGraph<V,
E> - Parameters:
vertex
- the vertex whose successor count is to be returned- Returns:
- the number of successors that
vertex
has in this graph - See Also:
-
getSuccessors
Description copied from interface:Graph
Returns aCollection
view of the successors ofvertex
in this graph. A successor ofvertex
is defined as a vertexv
which is connected tovertex
by an edgee
, wheree
is an incoming edge ofv
and an outgoing edge ofvertex
.- Specified by:
getSuccessors
in interfaceGraph<V,
E> - Specified by:
getSuccessors
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose predecessors are to be returned- Returns:
- a
Collection
view of the successors ofvertex
in this graph - See Also:
-
getVertexCount
public int getVertexCount()Description copied from interface:Hypergraph
Returns the number of vertices in this graph.- Specified by:
getVertexCount
in interfaceHypergraph<V,
E> - Returns:
- the number of vertices in this graph
- See Also:
-
getVertices
Description copied from interface:Hypergraph
Returns a view of all vertices in this graph. In general, this obeys theCollection
contract, and therefore makes no guarantees about the ordering of the vertices within the set.- Specified by:
getVertices
in interfaceHypergraph<V,
E> - Returns:
- a
Collection
view of all vertices in this graph - See Also:
-
inDegree
Description copied from interface:Graph
Returns the number of incoming edges incident tovertex
. Equivalent togetInEdges(vertex).size()
. -
isDest
Description copied from interface:Graph
Returnstrue
ifvertex
is the destination ofedge
. Equivalent togetDest(edge).equals(vertex)
. -
isPredecessor
Description copied from interface:Graph
Returnstrue
ifv1
is a predecessor ofv2
in this graph. Equivalent tov1.getPredecessors().contains(v2)
.- Specified by:
isPredecessor
in interfaceGraph<V,
E> - Parameters:
v1
- the first vertex to be queriedv2
- the second vertex to be queried- Returns:
true
ifv1
is a predecessor ofv2
, and false otherwise.- See Also:
-
isSource
Description copied from interface:Graph
Returnstrue
ifvertex
is the source ofedge
. Equivalent togetSource(edge).equals(vertex)
. -
isSuccessor
Description copied from interface:Graph
Returnstrue
ifv1
is a successor ofv2
in this graph. Equivalent tov1.getSuccessors().contains(v2)
.- Specified by:
isSuccessor
in interfaceGraph<V,
E> - Parameters:
v1
- the first vertex to be queriedv2
- the second vertex to be queried- Returns:
true
ifv1
is a successor ofv2
, and false otherwise.- See Also:
-
outDegree
Description copied from interface:Graph
Returns the number of outgoing edges incident tovertex
. Equivalent togetOutEdges(vertex).size()
. -
removeEdge
Description copied from interface:Hypergraph
Removesedge
from this graph. Fails ifedge
is null, or is otherwise not an element of this graph.- Specified by:
removeEdge
in interfaceHypergraph<V,
E> - Parameters:
edge
- the edge to remove- Returns:
true
if the removal is successful,false
otherwise- See Also:
-
removeVertex
Description copied from interface:Hypergraph
Removesvertex
from this graph. As a side effect, removes any edgese
incident tovertex
if the removal ofvertex
would causee
to be incident to an illegal number of vertices. (Thus, for example, incident hyperedges are not removed, but incident edges--which must be connected to a vertex at both endpoints--are removed.)Fails under the following circumstances:
vertex
is not an element of this graphvertex
isnull
- Specified by:
removeVertex
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex to remove- Returns:
true
if the removal is successful,false
otherwise- See Also:
-
containsEdge
Description copied from interface:Hypergraph
Returns true if this graph's edge collection containsedge
. Equivalent togetEdges().contains(edge)
.- Specified by:
containsEdge
in interfaceHypergraph<V,
E> - Parameters:
edge
- the edge whose presence is being queried- Returns:
- true iff this graph contains an edge
edge
- See Also:
-
containsVertex
Description copied from interface:Hypergraph
Returns true if this graph's vertex collection containsvertex
. Equivalent togetVertices().contains(vertex)
.- Specified by:
containsVertex
in interfaceHypergraph<V,
E> - Parameters:
vertex
- the vertex whose presence is being queried- Returns:
- true iff this graph contains a vertex
vertex
- See Also:
-