Class BaseGraphAdapter<V,G extends com.google.common.graph.Graph<V>>
 java.lang.Object

 org.jgrapht.graph.AbstractGraph<V,com.google.common.graph.EndpointPair<V>>

 org.jgrapht.graph.guava.BaseGraphAdapter<V,G>

 Type Parameters:
V
 the graph vertex typeG
 type of the underlying Guava's graph
 All Implemented Interfaces:
Serializable
,Cloneable
,Graph<V,com.google.common.graph.EndpointPair<V>>
 Direct Known Subclasses:
ImmutableGraphAdapter
,MutableGraphAdapter
public abstract class BaseGraphAdapter<V,G extends com.google.common.graph.Graph<V>> extends AbstractGraph<V,com.google.common.graph.EndpointPair<V>> implements Graph<V,com.google.common.graph.EndpointPair<V>>, Cloneable, Serializable
A base abstract implementation for the graph adapter class using Guava'sGraph
. This is a helper class in order to support both mutable and immutable graphs. Author:
 Dimitrios Michail
 See Also:
 Serialized Form


Field Summary
Fields Modifier and Type Field Description protected Supplier<com.google.common.graph.EndpointPair<V>>
edgeSupplier
protected G
graph
protected static String
LOOPS_NOT_ALLOWED
protected Set<com.google.common.graph.EndpointPair<V>>
unmodifiableEdgeSet
protected Set<V>
unmodifiableVertexSet
protected Supplier<V>
vertexSupplier

Fields inherited from interface org.jgrapht.Graph
DEFAULT_EDGE_WEIGHT


Constructor Summary
Constructors Constructor Description BaseGraphAdapter(G graph)
Create a new adapter.BaseGraphAdapter(G graph, Supplier<V> vertexSupplier, Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier)
Create a new adapter.

Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsEdge(com.google.common.graph.EndpointPair<V> e)
Returnstrue
if this graph contains the specified edge.boolean
containsVertex(V v)
Returnstrue
if this graph contains the specified vertex.int
degreeOf(V vertex)
Returns the degree of the specified vertex.Set<com.google.common.graph.EndpointPair<V>>
edgeSet()
Returns a set of the edges contained in this graph.Set<com.google.common.graph.EndpointPair<V>>
edgesOf(V vertex)
Returns a set of all edges touching the specified vertex.Set<com.google.common.graph.EndpointPair<V>>
getAllEdges(V sourceVertex, V targetVertex)
Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph.com.google.common.graph.EndpointPair<V>
getEdge(V sourceVertex, V targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph.V
getEdgeSource(com.google.common.graph.EndpointPair<V> e)
Returns the source vertex of an edge.Supplier<com.google.common.graph.EndpointPair<V>>
getEdgeSupplier()
Return the edge supplier that the graph uses whenever it needs to create new edges.V
getEdgeTarget(com.google.common.graph.EndpointPair<V> e)
Returns the target vertex of an edge.double
getEdgeWeight(com.google.common.graph.EndpointPair<V> e)
Returns the weight assigned to a given edge.GraphType
getType()
Get the graph type.Supplier<V>
getVertexSupplier()
Return the vertex supplier that the graph uses whenever it needs to create new vertices.Set<com.google.common.graph.EndpointPair<V>>
incomingEdgesOf(V vertex)
Returns a set of all edges incoming into the specified vertex.int
inDegreeOf(V vertex)
Returns the "in degree" of the specified vertex.int
outDegreeOf(V vertex)
Returns the "out degree" of the specified vertex.Set<com.google.common.graph.EndpointPair<V>>
outgoingEdgesOf(V vertex)
Returns a set of all edges outgoing from the specified vertex.void
setEdgeSupplier(Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier)
Set the edge supplier that the graph uses whenever it needs to create new edges.void
setVertexSupplier(Supplier<V> vertexSupplier)
Set the vertex supplier that the graph uses whenever it needs to create new vertices.Set<V>
vertexSet()
Returns a set of the vertices contained in this graph.
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapht.Graph
addEdge, addEdge, addVertex, addVertex, containsEdge, removeAllEdges, removeAllEdges, removeAllVertices, removeEdge, removeEdge, removeVertex, setEdgeWeight, setEdgeWeight




Field Detail

LOOPS_NOT_ALLOWED
protected static final String LOOPS_NOT_ALLOWED
 See Also:
 Constant Field Values

unmodifiableEdgeSet
protected transient Set<com.google.common.graph.EndpointPair<V>> unmodifiableEdgeSet


Constructor Detail

BaseGraphAdapter
public BaseGraphAdapter(G graph)
Create a new adapter. Parameters:
graph
 the graph


Method Detail

getVertexSupplier
public Supplier<V> getVertexSupplier()
Description copied from interface:Graph
Return the vertex supplier that the graph uses whenever it needs to create new vertices.A graph uses the vertex supplier to create new vertex objects whenever a user calls method
Graph.addVertex()
. Users can also create the vertex in user code and then use methodGraph.addVertex(Object)
to add the vertex.In contrast with the
Supplier
interface, the vertex supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new vertex to be added in a graphv
must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertexv2
such thatv2.equals(v)
.Care must also be taken when interchanging calls to methods
Graph.addVertex(Object)
andGraph.addVertex()
. In such a case the user must make sure never to add vertices in the graph using methodGraph.addVertex(Object)
, which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into anIllegalArgumentException
when calling methodGraph.addVertex()
. Specified by:
getVertexSupplier
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Returns:
 the vertex supplier or
null
if the graph has no such supplier

setVertexSupplier
public void setVertexSupplier(Supplier<V> vertexSupplier)
Set the vertex supplier that the graph uses whenever it needs to create new vertices.A graph uses the vertex supplier to create new vertex objects whenever a user calls method
Graph.addVertex()
. Users can also create the vertex in user code and then use methodGraph.addVertex(Object)
to add the vertex.In contrast with the
Supplier
interface, the vertex supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new vertex to be added in a graphv
must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertexv2
such thatv2.equals(v)
. Parameters:
vertexSupplier
 the vertex supplier

getEdgeSupplier
public Supplier<com.google.common.graph.EndpointPair<V>> getEdgeSupplier()
Description copied from interface:Graph
Return the edge supplier that the graph uses whenever it needs to create new edges.A graph uses the edge supplier to create new edge objects whenever a user calls method
Graph.addEdge(Object, Object)
. Users can also create the edge in user code and then use methodGraph.addEdge(Object, Object, Object)
to add the edge.In contrast with the
Supplier
interface, the edge supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new edge to be added in a graphe
must not be equal to any other edge in the graph (even if the graph allows edgemultiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. Specified by:
getEdgeSupplier
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Returns:
 the edge supplier
null
if the graph has no such supplier

setEdgeSupplier
public void setEdgeSupplier(Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier)
Set the edge supplier that the graph uses whenever it needs to create new edges.A graph uses the edge supplier to create new edge objects whenever a user calls method
Graph.addEdge(Object, Object)
. Users can also create the edge in user code and then use methodGraph.addEdge(Object, Object, Object)
to add the edge.In contrast with the
Supplier
interface, the edge supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new edge to be added in a graphe
must not be equal to any other edge in the graph (even if the graph allows edgemultiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. Parameters:
edgeSupplier
 the edge supplier

getEdge
public com.google.common.graph.EndpointPair<V> getEdge(V sourceVertex, V targetVertex)
Description copied from interface:Graph
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. Otherwise returnsnull
. If any of the specified vertices isnull
returnsnull
In undirected graphs, the returned edge may have its source and target vertices in the opposite order.

vertexSet
public Set<V> vertexSet()
Description copied from interface:Graph
Returns a set of the vertices contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.The graph implementation may maintain a particular set ordering (e.g. via
LinkedHashSet
) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

getEdgeSource
public V getEdgeSource(com.google.common.graph.EndpointPair<V> e)
Description copied from interface:Graph
Returns the source vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning). Specified by:
getEdgeSource
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
e
 edge of interest Returns:
 source vertex

getEdgeTarget
public V getEdgeTarget(com.google.common.graph.EndpointPair<V> e)
Description copied from interface:Graph
Returns the target vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning). Specified by:
getEdgeTarget
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
e
 edge of interest Returns:
 target vertex

getType
public GraphType getType()
Description copied from interface:Graph
Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, selfloops, multiple (parallel) edges, weights, etc.

containsEdge
public boolean containsEdge(com.google.common.graph.EndpointPair<V> e)
Description copied from interface:Graph
Returnstrue
if this graph contains the specified edge. More formally, returnstrue
if and only if this graph contains an edgee2
such thate.equals(e2)
. If the specified edge isnull
returnsfalse
. Specified by:
containsEdge
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
e
 edge whose presence in this graph is to be tested. Returns:
true
if this graph contains the specified edge.

containsVertex
public boolean containsVertex(V v)
Description copied from interface:Graph
Returnstrue
if this graph contains the specified vertex. More formally, returnstrue
if and only if this graph contains a vertexu
such thatu.equals(v)
. If the specified vertex isnull
returnsfalse
. Specified by:
containsVertex
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
v
 vertex whose presence in this graph is to be tested. Returns:
true
if this graph contains the specified vertex.

edgeSet
public Set<com.google.common.graph.EndpointPair<V>> edgeSet()
Description copied from interface:Graph
Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.The graph implementation may maintain a particular set ordering (e.g. via
LinkedHashSet
) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

degreeOf
public int degreeOf(V vertex)
Description copied from interface:Graph
Returns the degree of the specified vertex.A degree of a vertex in an undirected graph is the number of edges touching that vertex. Edges with same source and target vertices (selfloops) are counted twice.
In directed graphs this method returns the sum of the "in degree" and the "out degree".

edgesOf
public Set<com.google.common.graph.EndpointPair<V>> edgesOf(V vertex)
Description copied from interface:Graph
Returns a set of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty set.

inDegreeOf
public int inDegreeOf(V vertex)
Description copied from interface:Graph
Returns the "in degree" of the specified vertex.The "in degree" of a vertex in a directed graph is the number of inward directed edges from that vertex. See http://mathworld.wolfram.com/Indegree.html.
In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (selfloops) are counted twice.
 Specified by:
inDegreeOf
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
vertex
 vertex whose degree is to be calculated. Returns:
 the degree of the specified vertex.

incomingEdgesOf
public Set<com.google.common.graph.EndpointPair<V>> incomingEdgesOf(V vertex)
Description copied from interface:Graph
Returns a set of all edges incoming into the specified vertex.In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.
 Specified by:
incomingEdgesOf
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
vertex
 the vertex for which the list of incoming edges to be returned. Returns:
 a set of all edges incoming into the specified vertex.

outDegreeOf
public int outDegreeOf(V vertex)
Description copied from interface:Graph
Returns the "out degree" of the specified vertex.The "out degree" of a vertex in a directed graph is the number of outward directed edges from that vertex. See http://mathworld.wolfram.com/Outdegree.html.
In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (selfloops) are counted twice.
 Specified by:
outDegreeOf
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
vertex
 vertex whose degree is to be calculated. Returns:
 the degree of the specified vertex.

outgoingEdgesOf
public Set<com.google.common.graph.EndpointPair<V>> outgoingEdgesOf(V vertex)
Description copied from interface:Graph
Returns a set of all edges outgoing from the specified vertex.In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.
 Specified by:
outgoingEdgesOf
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
vertex
 the vertex for which the list of outgoing edges to be returned. Returns:
 a set of all edges outgoing from the specified vertex.

getEdgeWeight
public double getEdgeWeight(com.google.common.graph.EndpointPair<V> e)
Description copied from interface:Graph
Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined byGraph.DEFAULT_EDGE_WEIGHT
), allowing weightedgraph algorithms to apply to them when meaningful. Specified by:
getEdgeWeight
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
e
 edge of interest Returns:
 edge weight

getAllEdges
public Set<com.google.common.graph.EndpointPair<V>> getAllEdges(V sourceVertex, V targetVertex)
Description copied from interface:Graph
Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph. If any of the vertices does not exist or isnull
, returnsnull
. If both vertices exist but no edges found, returns an empty set.In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned set is either singleton set or empty set.
 Specified by:
getAllEdges
in interfaceGraph<V,G extends com.google.common.graph.Graph<V>>
 Parameters:
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge. Returns:
 a set of all edges connecting source vertex to target vertex.

