org.jgrapht.graph.guava

Class MutableNetworkAdapter<V,E>

java.lang.Object

org.jgrapht.graph.AbstractGraph<V,E>

org.jgrapht.graph.guava.BaseNetworkAdapter<V,E,com.google.common.graph.MutableNetwork<V,E>>

org.jgrapht.graph.guava.MutableNetworkAdapter<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Graph<V,E>

public class MutableNetworkAdapter<V,E>
extends BaseNetworkAdapter<V,E,com.google.common.graph.MutableNetwork<V,E>>
implements Graph<V,E>, java.lang.Cloneable, java.io.Serializable

A graph adapter class using Guava's MutableNetwork.

Changes in the adapter such as adding or removing vertices and edges are reflected in the underlying network. Example usage:

 MutableNetwork<String, DefaultEdge> mutableNetwork =
     NetworkBuilder.directed().allowsParallelEdges(true).allowsSelfLoops(true).build();
 
 Graph<String, DefaultEdge> graph = new MutableNetworkAdapter<>(
     mutableNetwork, SupplierUtil.createStringSupplier(), SupplierUtil.DEFAULT_EDGE_SUPPLIER);
 
 graph.addVertex("v1");
 
 System.out.println(mutableNetwork.nodes().contains("v1")); // outputs true
 

Author:

Dimitrios Michail

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	GRAPH_IS_UNWEIGHTED

Fields inherited from class org.jgrapht.graph.guava.BaseNetworkAdapter

edgeSupplier, LOOPS_NOT_ALLOWED, network, unmodifiableEdgeSet, unmodifiableVertexSet, vertexOrder, vertexOrderMethod, vertexSupplier

Fields inherited from interface org.jgrapht.Graph

DEFAULT_EDGE_WEIGHT

Constructor Summary

Constructors

Constructor and Description
MutableNetworkAdapter(com.google.common.graph.MutableNetwork<V,E> network) Create a new network adapter.
MutableNetworkAdapter(com.google.common.graph.MutableNetwork<V,E> network, java.util.function.Supplier<V> vertexSupplier, java.util.function.Supplier<E> edgeSupplier) Create a new network adapter.
MutableNetworkAdapter(com.google.common.graph.MutableNetwork<V,E> network, java.util.function.Supplier<V> vertexSupplier, java.util.function.Supplier<E> edgeSupplier, ElementOrderMethod<V> vertexOrderMethod) Create a new network adapter.

Method Summary

Modifier and Type	Method and Description
E	addEdge(V sourceVertex, V targetVertex)
boolean	addEdge(V sourceVertex, V targetVertex, E e)
V	addVertex()
boolean	addVertex(V v)
java.lang.Object	clone() Returns a shallow copy of this graph instance.
boolean	removeEdge(E e)
E	removeEdge(V sourceVertex, V targetVertex)
boolean	removeVertex(V v)
void	setEdgeWeight(E e, double weight)

Methods inherited from class org.jgrapht.graph.guava.BaseNetworkAdapter

containsEdge, containsVertex, createVertexOrder, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getType, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, setEdgeSupplier, setVertexSupplier, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapht.Graph

containsEdge, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getType, getVertexSupplier, incomingEdgesOf, inDegreeOf, iterables, outDegreeOf, outgoingEdgesOf, removeAllEdges, removeAllEdges, removeAllVertices, setEdgeWeight, vertexSet

Field Detail

GRAPH_IS_UNWEIGHTED

protected static final java.lang.String GRAPH_IS_UNWEIGHTED

See Also:

Constant Field Values

Constructor Detail

MutableNetworkAdapter

public MutableNetworkAdapter(com.google.common.graph.MutableNetwork<V,E> network)

Create a new network adapter.

Parameters:

network - the mutable network

MutableNetworkAdapter

public MutableNetworkAdapter(com.google.common.graph.MutableNetwork<V,E> network,
                             java.util.function.Supplier<V> vertexSupplier,
                             java.util.function.Supplier<E> edgeSupplier)

Create a new network adapter.

Parameters:

network - the mutable network

vertexSupplier - the vertex supplier

edgeSupplier - the edge supplier

MutableNetworkAdapter

public MutableNetworkAdapter(com.google.common.graph.MutableNetwork<V,E> network,
                             java.util.function.Supplier<V> vertexSupplier,
                             java.util.function.Supplier<E> edgeSupplier,
                             ElementOrderMethod<V> vertexOrderMethod)

Create a new network adapter.

Parameters:

network - the mutable network

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

addEdge

public E addEdge(V sourceVertex,
                 V targetVertex)

Specified by:

addEdge in interface Graph<V,E>

addEdge

public boolean addEdge(V sourceVertex,
                       V targetVertex,
                       E e)

Specified by:

addEdge in interface Graph<V,E>

addVertex

public V addVertex()

Specified by:

addVertex in interface Graph<V,E>

addVertex

public boolean addVertex(V v)

Specified by:

addVertex in interface Graph<V,E>

removeEdge

public E removeEdge(V sourceVertex,
                    V targetVertex)

Specified by:

removeEdge in interface Graph<V,E>

removeEdge

public boolean removeEdge(E e)

Specified by:

removeEdge in interface Graph<V,E>

removeVertex

public boolean removeVertex(V v)

Specified by:

removeVertex in interface Graph<V,E>

setEdgeWeight

public void setEdgeWeight(E e,
                          double weight)

Specified by:

setEdgeWeight in interface Graph<V,E>

clone

public java.lang.Object clone()

Returns a shallow copy of this graph instance. Neither edges nor vertices are cloned.

Overrides:

clone in class java.lang.Object

Returns:

a shallow copy of this graph.

Throws:

java.lang.RuntimeException - in case the clone is not supported

See Also:

Object.clone()