V
 the graph vertex typeE
 the graph edge typepublic abstract class AbstractBaseGraph<V,E> extends AbstractGraph<V,E> implements Graph<V,E>, Cloneable, Serializable
Graph
interface. Its subclasses add
various restrictions to get more specific graphs. The decision whether it is directed or
undirected is decided at construction time and cannot be later modified (see constructor for
details).
This graph implementation guarantees deterministic vertex and edge set ordering (via
LinkedHashMap
and LinkedHashSet
).
Modifier  Constructor and Description 

protected 
AbstractBaseGraph(EdgeFactory<V,E> ef,
boolean allowMultipleEdges,
boolean allowLoops)
Construct a new graph.

Modifier and Type  Method and Description 

E 
addEdge(V sourceVertex,
V targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and
returns the created edge.

boolean 
addEdge(V sourceVertex,
V targetVertex,
E e)
Adds the specified edge to this graph, going from the source vertex to the target vertex.

boolean 
addVertex(V v)
Adds the specified vertex to this graph if not already present.

Object 
clone()
Returns a shallow copy of this graph instance.

boolean 
containsEdge(E e)
Returns true if this graph contains the specified edge.

boolean 
containsVertex(V v)
Returns true if this graph contains the specified vertex.

protected Specifics<V,E> 
createDirectedSpecifics()
Create directed specifics for the graph

protected Specifics<V,E> 
createUndirectedSpecifics()
Create undirected specifics for the graph

int 
degreeOf(V vertex)
Returns the degree of the specified vertex.

Set<E> 
edgeSet()
Returns a set of the edges contained in this graph.

Set<E> 
edgesOf(V vertex)
Returns a set of all edges touching the specified vertex.

Set<E> 
getAllEdges(V sourceVertex,
V targetVertex)
Returns a set of all edges connecting source vertex to target vertex if such vertices exist
in this graph.

E 
getEdge(V sourceVertex,
V targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge
exist in this graph.

EdgeFactory<V,E> 
getEdgeFactory()
Returns the edge factory using which this graph creates new edges.

EdgeSetFactory<V,E> 
getEdgeSetFactory()
Returns the
EdgeSetFactory used by this graph. 
V 
getEdgeSource(E e)
Returns the source vertex of an edge.

V 
getEdgeTarget(E e)
Returns the target vertex of an edge.

double 
getEdgeWeight(E e)
Returns the weight assigned to a given edge.

Set<E> 
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.

boolean 
isAllowingLoops()
Returns
true if and only if selfloops are allowed in this graph. 
boolean 
isAllowingMultipleEdges()
Returns
true if and only if multiple edges are allowed in this graph. 
int 
outDegreeOf(V vertex)
Returns the "out degree" of the specified vertex.

Set<E> 
outgoingEdgesOf(V vertex)
Returns a set of all edges outgoing from the specified vertex.

boolean 
removeEdge(E e)
Removes the specified edge from the graph.

E 
removeEdge(V sourceVertex,
V targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge
exist in this graph.

boolean 
removeVertex(V v)
Removes the specified vertex from this graph including all its touching edges if present.

void 
setEdgeSetFactory(EdgeSetFactory<V,E> edgeSetFactory)
Set the
EdgeSetFactory to use for this graph. 
void 
setEdgeWeight(E e,
double weight)
Assigns a weight to an edge.

Set<V> 
vertexSet()
Returns a set of the vertices contained in this graph.

assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets
finalize, getClass, notify, notifyAll, wait, wait, wait
containsEdge, removeAllEdges, removeAllEdges, removeAllVertices
protected AbstractBaseGraph(EdgeFactory<V,E> ef, boolean allowMultipleEdges, boolean allowLoops)
ef
 the edge factory of the new graph.allowMultipleEdges
 whether to allow multiple edges or not.allowLoops
 whether to allow edges that are selfloops or not.NullPointerException
 if the specified edge factory is
null
.public Set<E> getAllEdges(V sourceVertex, V targetVertex)
null
, returns
null
. 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.
getAllEdges
in interface Graph<V,E>
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.public boolean isAllowingLoops()
true
if and only if selfloops are allowed in this graph. A self loop is
an edge that its source and target vertices are the same.true
if and only if graph loops are allowed.public boolean isAllowingMultipleEdges()
true
if and only if multiple edges are allowed in this graph. The
meaning of multiple edges is that there can be many edges going from vertex v1 to vertex v2.true
if and only if multiple edges are allowed.public E getEdge(V sourceVertex, V targetVertex)
null
. If any of the specified vertices is null
returns null
In undirected graphs, the returned edge may have its source and target vertices in the opposite order.
public EdgeFactory<V,E> getEdgeFactory()
getEdgeFactory
in interface Graph<V,E>
public void setEdgeSetFactory(EdgeSetFactory<V,E> edgeSetFactory)
EdgeSetFactory
to use for this graph. Initially, a graph is created with a
default implementation which always supplies an ArrayList
with capacity 1.edgeSetFactory
 factory to use for subsequently created edge sets (this call has no
effect on existing edge sets)public EdgeSetFactory<V,E> getEdgeSetFactory()
EdgeSetFactory
used by this graph. The default is
ArrayList
with capacity 1.public E addEdge(V sourceVertex, V targetVertex)
null
.
The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.
This method creates the new edge e
using this graph's EdgeFactory
.
For the new edge to be added e
must not be equal to any other edge the
graph (even if the graph allows edgemultiplicity). More formally, the graph must not contain
any edge e2
such that e2.equals(e)
. If such
e2
is found then the newly created edge e
is abandoned, the method leaves
this graph unchanged returns
null
.
addEdge
in interface Graph<V,E>
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.
null
.Graph.getEdgeFactory()
public boolean addEdge(V sourceVertex, V targetVertex, E e)
e
, to this graph if this graph contains no edge e2
such that
e2.equals(e)
. If this graph already contains such an edge, the call leaves this
graph unchanged and returns false. Some graphs do not allow edgemultiplicity. In
such cases, if the graph already contains an edge from the specified source to the specified
target, than this method does not change the graph and returns
false
. If the edge was added to the graph, returns
true
.
The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.
addEdge
in interface Graph<V,E>
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.e
 edge to be added to this graph.Graph.addEdge(Object, Object)
,
Graph.getEdgeFactory()
public boolean addVertex(V v)
v
, to this graph if this graph contains no vertex
u
such that
u.equals(v)
. If this graph already contains such vertex, the call leaves this graph
unchanged and returns false. In combination with the restriction on constructors,
this ensures that graphs never contain duplicate vertices.public V getEdgeSource(E e)
getEdgeSource
in interface Graph<V,E>
e
 edge of interestpublic V getEdgeTarget(E e)
getEdgeTarget
in interface Graph<V,E>
e
 edge of interestpublic Object clone()
clone
in class Object
RuntimeException
 in case the clone is not supportedObject.clone()
public boolean containsEdge(E e)
e2
such that
e.equals(e2)
. If the specified edge is null
returns
false
.containsEdge
in interface Graph<V,E>
e
 edge whose presence in this graph is to be tested.public boolean containsVertex(V v)
u
such that
u.equals(v)
. If the specified vertex is null
returns
false
.containsVertex
in interface Graph<V,E>
v
 vertex whose presence in this graph is to be tested.public int degreeOf(V vertex)
vertex
 vertex whose degree is to be calculated.UndirectedGraph.degreeOf(Object)
public Set<E> edgeSet()
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.
public Set<E> edgesOf(V vertex)
public int inDegreeOf(V vertex)
vertex
 vertex whose in degree is to be calculated.DirectedGraph.inDegreeOf(Object)
public Set<E> incomingEdgesOf(V vertex)
vertex
 the vertex for which the list of incoming edges to be returnedDirectedGraph.incomingEdgesOf(Object)
public int outDegreeOf(V vertex)
vertex
 vertex whose out degree is to be calculatedDirectedGraph.outDegreeOf(Object)
public Set<E> outgoingEdgesOf(V vertex)
vertex
 the vertex for which the list of outgoing edges to be returnedDirectedGraph.outgoingEdgesOf(Object)
public E removeEdge(V sourceVertex, V targetVertex)
null
otherwise.removeEdge
in interface Graph<V,E>
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.null
if no edge removed.public boolean removeEdge(E e)
e2
such that e2.equals(e)
, if the graph contains such edge. Returns
true if the graph contained the specified edge. (The graph will not contain the
specified edge once the call returns).
If the specified edge is null
returns
false
.
removeEdge
in interface Graph<V,E>
e
 edge to be removed from this graph, if present.true
if and only if the graph contained the specified edge.public boolean removeVertex(V v)
u
such that u.equals(v)
, the call removes all edges that touch
u
and then removes u
itself. If no such u
is found,
the call leaves the graph unchanged. Returns true if the graph contained the
specified vertex. (The graph will not contain the specified vertex once the call returns).
If the specified vertex is null
returns
false
.
removeVertex
in interface Graph<V,E>
v
 vertex to be removed from this graph, if present.true
if the graph contained the specified vertex; false
otherwise.public Set<V> vertexSet()
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.
public double getEdgeWeight(E e)
WeightedGraph.DEFAULT_EDGE_WEIGHT
), allowing weightedgraph algorithms to apply to
them where meaningful.getEdgeWeight
in interface Graph<V,E>
e
 edge of interestWeightedGraph
public void setEdgeWeight(E e, double weight)
e
 edge on which to set weightweight
 new weight for edgeWeightedGraph.setEdgeWeight(Object, double)
protected Specifics<V,E> createUndirectedSpecifics()
Copyright © 2016. All rights reserved.