org.jgrapht.graph.guava

Class BaseValueGraphAdapter<V,W,VG extends com.google.common.graph.ValueGraph<V,W>>

java.lang.Object

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

org.jgrapht.graph.guava.BaseValueGraphAdapter<V,W,VG>

Type Parameters:

V - the graph vertex type

W - the value type

VG - type of the underlying Guava's value graph

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Graph<V,com.google.common.graph.EndpointPair<V>>

Direct Known Subclasses:

ImmutableValueGraphAdapter, MutableValueGraphAdapter

public abstract class BaseValueGraphAdapter<V,W,VG extends com.google.common.graph.ValueGraph<V,W>>
extends AbstractGraph<V,com.google.common.graph.EndpointPair<V>>
implements Graph<V,com.google.common.graph.EndpointPair<V>>, java.lang.Cloneable, java.io.Serializable

A base abstract implementation for the graph adapter class using Guava's ValueGraph. This is a helper class in order to support both mutable and immutable value graphs.

Author:

Dimitrios Michail

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Supplier<com.google.common.graph.EndpointPair<V>>	edgeSupplier
protected static java.lang.String	LOOPS_NOT_ALLOWED
protected java.util.Set<com.google.common.graph.EndpointPair<V>>	unmodifiableEdgeSet
protected java.util.Set<V>	unmodifiableVertexSet
protected java.util.function.ToDoubleFunction<W>	valueConverter
protected VG	valueGraph
protected org.jgrapht.graph.guava.ElementOrder<V>	vertexOrder
protected ElementOrderMethod<V>	vertexOrderMethod
protected java.util.function.Supplier<V>	vertexSupplier

Fields inherited from interface org.jgrapht.Graph

DEFAULT_EDGE_WEIGHT

Constructor Summary

Constructors

Constructor and Description
BaseValueGraphAdapter(VG valueGraph, java.util.function.ToDoubleFunction<W> valueConverter) Create a new adapter.
BaseValueGraphAdapter(VG valueGraph, java.util.function.ToDoubleFunction<W> valueConverter, java.util.function.Supplier<V> vertexSupplier, java.util.function.Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier) Create a new adapter.
BaseValueGraphAdapter(VG valueGraph, java.util.function.ToDoubleFunction<W> valueConverter, java.util.function.Supplier<V> vertexSupplier, java.util.function.Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier, ElementOrderMethod<V> vertexOrderMethod) Create a new adapter.

Method Summary

Modifier and Type	Method and Description
boolean	containsEdge(com.google.common.graph.EndpointPair<V> e)
boolean	containsVertex(V v)
protected org.jgrapht.graph.guava.ElementOrder<V>	createVertexOrder(ElementOrderMethod<V> vertexOrderMethod) Create the internal vertex order implementation.
int	degreeOf(V vertex)
java.util.Set<com.google.common.graph.EndpointPair<V>>	edgeSet()
java.util.Set<com.google.common.graph.EndpointPair<V>>	edgesOf(V vertex)
java.util.Set<com.google.common.graph.EndpointPair<V>>	getAllEdges(V sourceVertex, V targetVertex)
com.google.common.graph.EndpointPair<V>	getEdge(V sourceVertex, V targetVertex)
V	getEdgeSource(com.google.common.graph.EndpointPair<V> e)
java.util.function.Supplier<com.google.common.graph.EndpointPair<V>>	getEdgeSupplier()
V	getEdgeTarget(com.google.common.graph.EndpointPair<V> e)
double	getEdgeWeight(com.google.common.graph.EndpointPair<V> e)
GraphType	getType()
java.util.function.Supplier<V>	getVertexSupplier()
java.util.Set<com.google.common.graph.EndpointPair<V>>	incomingEdgesOf(V vertex)
int	inDegreeOf(V vertex)
int	outDegreeOf(V vertex)
java.util.Set<com.google.common.graph.EndpointPair<V>>	outgoingEdgesOf(V vertex)
void	setEdgeSupplier(java.util.function.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(java.util.function.Supplier<V> vertexSupplier) Set the vertex supplier that the graph uses whenever it needs to create new vertices.
java.util.Set<V>	vertexSet()

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, iterables, removeAllEdges, removeAllEdges, removeAllVertices, removeEdge, removeEdge, removeVertex, setEdgeWeight, setEdgeWeight

Field Detail

LOOPS_NOT_ALLOWED

protected static final java.lang.String LOOPS_NOT_ALLOWED

See Also:

Constant Field Values

unmodifiableVertexSet

protected transient java.util.Set<V> unmodifiableVertexSet

unmodifiableEdgeSet

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

vertexSupplier

protected java.util.function.Supplier<V> vertexSupplier

edgeSupplier

protected java.util.function.Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier

valueConverter

protected java.util.function.ToDoubleFunction<W> valueConverter

valueGraph

protected transient VG extends com.google.common.graph.ValueGraph<V,W> valueGraph

vertexOrderMethod

protected ElementOrderMethod<V> vertexOrderMethod

vertexOrder

protected transient org.jgrapht.graph.guava.ElementOrder<V> vertexOrder

Constructor Detail

BaseValueGraphAdapter

public BaseValueGraphAdapter(VG valueGraph,
                             java.util.function.ToDoubleFunction<W> valueConverter)

Create a new adapter.

Parameters:

valueGraph - the mutable value graph

valueConverter - a function that converts a value to a double

BaseValueGraphAdapter

public BaseValueGraphAdapter(VG valueGraph,
                             java.util.function.ToDoubleFunction<W> valueConverter,
                             java.util.function.Supplier<V> vertexSupplier,
                             java.util.function.Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier)

Create a new adapter.

Parameters:

valueGraph - the mutable value graph

valueConverter - a function that converts a value to a double

vertexSupplier - the vertex supplier

edgeSupplier - the edge supplier

BaseValueGraphAdapter

public BaseValueGraphAdapter(VG valueGraph,
                             java.util.function.ToDoubleFunction<W> valueConverter,
                             java.util.function.Supplier<V> vertexSupplier,
                             java.util.function.Supplier<com.google.common.graph.EndpointPair<V>> edgeSupplier,
                             ElementOrderMethod<V> vertexOrderMethod)

Create a new adapter.

Parameters:

valueGraph - the mutable value graph

valueConverter - a function that converts a value to a double

vertexSupplier - the vertex supplier

edgeSupplier - the edge supplier

vertexOrderMethod - the method used to ensure a total order of the graph vertices. This is required in order to make edge source/targets be consistent.

Method Detail

getVertexSupplier

public java.util.function.Supplier<V> getVertexSupplier()

Specified by:

getVertexSupplier in interface Graph<V,com.google.common.graph.EndpointPair<V>>

setVertexSupplier

public void setVertexSupplier(java.util.function.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 method Graph.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 graph v must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertex v2 such that v2.equals(v).

Parameters:

vertexSupplier - the vertex supplier

getEdgeSupplier

public java.util.function.Supplier<com.google.common.graph.EndpointPair<V>> getEdgeSupplier()

Specified by:

getEdgeSupplier in interface Graph<V,com.google.common.graph.EndpointPair<V>>

setEdgeSupplier

public void setEdgeSupplier(java.util.function.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 method Graph.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 graph e must not be equal to any other edge in the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e).

Parameters:

edgeSupplier - the edge supplier

getEdge

public com.google.common.graph.EndpointPair<V> getEdge(V sourceVertex,
                                                       V targetVertex)

Specified by:

getEdge in interface Graph<V,com.google.common.graph.EndpointPair<V>>

vertexSet

public java.util.Set<V> vertexSet()

Specified by:

vertexSet in interface Graph<V,com.google.common.graph.EndpointPair<V>>

getEdgeSource

public V getEdgeSource(com.google.common.graph.EndpointPair<V> e)

Specified by:

getEdgeSource in interface Graph<V,com.google.common.graph.EndpointPair<V>>

getEdgeTarget

public V getEdgeTarget(com.google.common.graph.EndpointPair<V> e)

Specified by:

getEdgeTarget in interface Graph<V,com.google.common.graph.EndpointPair<V>>

getType

public GraphType getType()

Specified by:

getType in interface Graph<V,com.google.common.graph.EndpointPair<V>>

containsEdge

public boolean containsEdge(com.google.common.graph.EndpointPair<V> e)

Specified by:

containsEdge in interface Graph<V,com.google.common.graph.EndpointPair<V>>

containsVertex

public boolean containsVertex(V v)

Specified by:

containsVertex in interface Graph<V,com.google.common.graph.EndpointPair<V>>

edgeSet

public java.util.Set<com.google.common.graph.EndpointPair<V>> edgeSet()

Specified by:

edgeSet in interface Graph<V,com.google.common.graph.EndpointPair<V>>

degreeOf

public int degreeOf(V vertex)

Specified by:

degreeOf in interface Graph<V,com.google.common.graph.EndpointPair<V>>

edgesOf

public java.util.Set<com.google.common.graph.EndpointPair<V>> edgesOf(V vertex)

Specified by:

edgesOf in interface Graph<V,com.google.common.graph.EndpointPair<V>>

inDegreeOf

public int inDegreeOf(V vertex)

Specified by:

inDegreeOf in interface Graph<V,com.google.common.graph.EndpointPair<V>>

incomingEdgesOf

public java.util.Set<com.google.common.graph.EndpointPair<V>> incomingEdgesOf(V vertex)

Specified by:

incomingEdgesOf in interface Graph<V,com.google.common.graph.EndpointPair<V>>

outDegreeOf

public int outDegreeOf(V vertex)

Specified by:

outDegreeOf in interface Graph<V,com.google.common.graph.EndpointPair<V>>

outgoingEdgesOf

public java.util.Set<com.google.common.graph.EndpointPair<V>> outgoingEdgesOf(V vertex)

Specified by:

outgoingEdgesOf in interface Graph<V,com.google.common.graph.EndpointPair<V>>

getEdgeWeight

public double getEdgeWeight(com.google.common.graph.EndpointPair<V> e)

Specified by:

getEdgeWeight in interface Graph<V,com.google.common.graph.EndpointPair<V>>

getAllEdges

public java.util.Set<com.google.common.graph.EndpointPair<V>> getAllEdges(V sourceVertex,
                                                                          V targetVertex)

Specified by:

getAllEdges in interface Graph<V,com.google.common.graph.EndpointPair<V>>

createVertexOrder

protected org.jgrapht.graph.guava.ElementOrder<V> createVertexOrder(ElementOrderMethod<V> vertexOrderMethod)

Create the internal vertex order implementation.

Parameters:

vertexOrderMethod - method to use

Returns:

the vertex order