libraries.jgrapht

Class JGraphTLib

java.lang.Object

graphana.graphs.GraphLibrary<StdVertex,JGraphTWeightedEdge>

libraries.jgrapht.JGraphTLib

public class JGraphTLib
extends GraphLibrary<StdVertex,JGraphTWeightedEdge>

Binds the JGraphT library

Field Summary

Fields inherited from class graphana.graphs.GraphLibrary

DEFAULTDIRECTED, DEFAULTFORCELOOPFREE, DEFAULTWEIGHTED, directed, graphCreated, SET_STATUS, weighted

Constructor Summary

Constructors

Constructor and Description
JGraphTLib()

Method Summary

Modifier and Type	Method and Description
void	checkPrefaceGraph(boolean directed, boolean weighted, boolean forceLoopFree, GraphLibrary<?,?> preface) Checks whether or not this graph library would be able to create a graph which is equivalent to the given graph.
static JGraphTLib	createFromJGraphTGraph(org.jgrapht.Graph<?,?> graph) Creates a JGraphTLib by copying the contents of the given JGraphT graph instance
JGraphTWeightedEdge	derivAddEdge(StdVertex vertex1, StdVertex vertex2) Must create an edge and add it to the internal graph.
StdVertex	derivAddVertex() Must create a vertex and add it to the internal graph.
protected void	derivCopyFromExistingGraph(java.lang.Object graph, GraphLibrary<?,?> target) Copies the contents of the given graph instance into the given graph library.
protected void	derivCreateGraph(boolean directed, boolean weighted, boolean forceLoopFree) Must create the internal graph with the given COnfiguration.
protected double	derivGetEdgeWeight(JGraphTWeightedEdge edge) Returns the weight of the given edge.
StdVertex	derivGetEndVertex(JGraphTWeightedEdge edge) Returns the end point of the given edge.
StdVertex	derivGetStartVertex(JGraphTWeightedEdge edge) Returns the start point of the given edge.
protected void	derivRemoveEdge(JGraphTWeightedEdge edge) Removes the given edge from the internal graph
protected void	derivRemoveVertex(StdVertex vertex) Removes the given vertex from the internal graph.
protected void	derivSetEdgeWeight(JGraphTWeightedEdge edge, double weight) Sets the given weight as the weight of the given edge.
void	derivSetVertexIdent(StdVertex vertex, java.lang.String ident) Changes the identifier of the given vertex.
protected GraphConfiguration	getDefaultGraphConfiguration() Returns a GraphConfiguration which is working with the respective graph.
JGraphTWeightedEdge	getEdge(StdVertex vertex1, StdVertex vertex2) Returns the edge which contains the given vertices.
int	getEdgeCount()
java.lang.Object	getEdgeData(JGraphTWeightedEdge edge) Returns the data of the given edge.
java.lang.Iterable<JGraphTWeightedEdge>	getEdges()
java.lang.Object	getEdgeStatus(JGraphTWeightedEdge edge) Returns the status of the given edge in O(1).
int	getIngoingEdgeCount(StdVertex vertex) Returns the amount of ingoing edges of the given vertex.
java.lang.Iterable<JGraphTWeightedEdge>	getIngoingEdges(StdVertex vertex) Returns all ingoing edges of the given vertex.
org.jgrapht.graph.AbstractBaseGraph<StdVertex,JGraphTWeightedEdge>	getInternalGraph() Returns the internal graph.
java.lang.String	getLibName() Returns the (constant) name of the graph library.
int	getOutgoingEdgeCount(StdVertex vertex) Returns the amount of outgoing edges of the given vertex.
java.lang.Iterable<JGraphTWeightedEdge>	getOutgoingEdges(StdVertex vertex) Returns all outgoing edges of the given vertex.
int	getVertexCount()
java.lang.Object	getVertexData(StdVertex vertex) Returns the data of the given vertex.
java.lang.String	getVertexIdent(StdVertex vertex) Returns the identifier of the given vertex.
java.lang.Object	getVertexStatus(StdVertex vertex) Returns the status of the given vertex in O(1).
java.lang.Iterable<StdVertex>	getVertices()
void	setEdgeData(JGraphTWeightedEdge edge, java.lang.Object data) Sets the data of the given edge.
void	setEdgeStatus(JGraphTWeightedEdge edge, java.lang.Object status) Sets the status of the given edge in O(1).
void	setVertexData(StdVertex vertex, java.lang.Object data) Sets the data of the given vertex.
void	setVertexStatus(StdVertex vertex, java.lang.Object status) Sets the status of the given vertex in O(1).
protected boolean	supportsCopyFromExistingGraph() Returns true, iff this GraphLibrary sub class supports creating graphs from existing graph instances.

Methods inherited from class graphana.graphs.GraphLibrary

addEdge, addEdge, addEdge, addEdgeByIdent, addGraphListener, addVertex, addVertex, addVertex, addVertex, asConfigurated, clearAlgorithmResults, clearDates, clearEdgeData, clearEdgeDates, clearEdgeStates, clearEdgeStatus, clearGraph, clearStates, clearVertexData, clearVertexDates, clearVertexStates, clearVertexStatus, copyFromExistingGraph, copyFromExistingGraph, copyToGraph, copyToGraph, copyToGraph, createDefaultGraph, createGraph, createGraph, createGraph, createGraph, createGraphUnchecked, createGraphUnchecked, createMetaEdge, deleteLoops, deleteWarning, edgeExists, edgeExistsByIdent, edgesToString, edgeToString, enableLoops, forceLoopFree, getAlgorithmResult, getAverageDegree, getEdgeByIdent, getEdgeName, getEdgeWeight, getEdgeWeight, getEdgeWeightByIdent, getEndVertex, getEndVertex, getGraphId, getIncidentEdges, getMarkedEdgeCount, getMarkedVertexCount, getMaximumDegree, getMinimumDegree, getName, getNeighborCount, getNeighbors, getNextVertexIdentifier, getStartVertex, getUnmarkedNeighborCount, getVertexByIdent, getVertexByIdent, getVertexIdentUnchecked, getVertexStdPrefix, getVisualElements, graphModified, hasAlgorithmResult, hasEdgeData, hasVertexData, isDirected, isEdgeMarkedAsDeleted, isEdgeStatusSet, isEmpty, isForceLoopFree, isGraphCreated, isLoopFree, isVertexMarkedAsDeleted, isVertexStatusSet, isWeighted, markEdgeAsDeleted, markVertexAsDeleted, mergeGraph, metaEdgeToString, pollWarning, prepareAlgorithmRun, printWarning, putWarning, refresh, removeAlgorithmResult, removeEdge, removeEdge, removeEdge, removeEdgeDeletionMark, removeGraphListener, removeVertex, removeVertex, removeVertexDeletionMark, resolveVertexName, setAlgorithmResult, setBlockCacheOutput, setDirected, setEdgeDates, setEdgeStates, setEdgeWeight, setName, setVertexDates, setVertexIdent, setVertexStates, setVertexStatus, setVertexStdPrefix, toString, vertexExistsByIdent, vertexToString, verticesToString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JGraphTLib

public JGraphTLib()

Method Detail

createFromJGraphTGraph

public static JGraphTLib createFromJGraphTGraph(org.jgrapht.Graph<?,?> graph)
                                         throws InvalidGraphException

Creates a JGraphTLib by copying the contents of the given JGraphT graph instance

Parameters:

graph - the graph to copy from

Returns:

the created JGraphTLib

Throws:

InvalidGraphException - if the graph has unsupported properties

derivAddEdge

public JGraphTWeightedEdge derivAddEdge(StdVertex vertex1,
                                        StdVertex vertex2)

Description copied from class: GraphLibrary

Must create an edge and add it to the internal graph.

Specified by:

derivAddEdge in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex1 - The first endpoint.

vertex2 - The second endpoint.

Returns:

Reference to the added edge.

derivAddVertex

public StdVertex derivAddVertex()

Description copied from class: GraphLibrary

Must create a vertex and add it to the internal graph. It's identifier will be given in a later call.

Specified by:

derivAddVertex in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

Reference to the added vertex.

derivCreateGraph

protected void derivCreateGraph(boolean directed,
                                boolean weighted,
                                boolean forceLoopFree)
                         throws InvalidGraphConfigException

Description copied from class: GraphLibrary

Must create the internal graph with the given COnfiguration.

Specified by:

derivCreateGraph in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

directed - Determines, whether the graph shall be directed.

weighted - Determines, whether the graph shall be weighted.

forceLoopFree - Determines, whether it is impossible to add loops into the graph

Throws:

InvalidGraphConfigException - If the given configuration is not

checkPrefaceGraph

public void checkPrefaceGraph(boolean directed,
                              boolean weighted,
                              boolean forceLoopFree,
                              GraphLibrary<?,?> preface)
                       throws InvalidGraphConfigException

Description copied from class: GraphLibrary

Checks whether or not this graph library would be able to create a graph which is equivalent to the given graph.

Overrides:

checkPrefaceGraph in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

preface - the graph to check.

Throws:

InvalidGraphConfigException - if this graph library is not able to create an equivalent graph to the given graph.

getVertexCount

public int getVertexCount()

Specified by:

getVertexCount in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

The current amount of vertices.

getEdgeCount

public int getEdgeCount()

Specified by:

getEdgeCount in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

The current amount of edges.

getEdges

public java.lang.Iterable<JGraphTWeightedEdge> getEdges()

Specified by:

getEdges in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

An iterator which iterates over all edges of the graph.

getLibName

public java.lang.String getLibName()

Description copied from class: GraphLibrary

Returns the (constant) name of the graph library.

Specified by:

getLibName in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

derivGetStartVertex

public StdVertex derivGetStartVertex(JGraphTWeightedEdge edge)

Description copied from class: GraphLibrary

Returns the start point of the given edge.

Specified by:

derivGetStartVertex in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

the start point of the given edge.

derivGetEndVertex

public StdVertex derivGetEndVertex(JGraphTWeightedEdge edge)

Description copied from class: GraphLibrary

Returns the end point of the given edge.

Specified by:

derivGetEndVertex in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

the end point of the given edge.

getVertices

public java.lang.Iterable<StdVertex> getVertices()

Specified by:

getVertices in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

An iterator which iterates over all vertices of the graph.

getInternalGraph

public org.jgrapht.graph.AbstractBaseGraph<StdVertex,JGraphTWeightedEdge> getInternalGraph()

Description copied from class: GraphLibrary

Returns the internal graph.

Specified by:

getInternalGraph in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

derivGetEdgeWeight

protected double derivGetEdgeWeight(JGraphTWeightedEdge edge)

Description copied from class: GraphLibrary

Returns the weight of the given edge. This method is never called if the graph is unweighted.

Specified by:

derivGetEdgeWeight in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

derivSetEdgeWeight

protected void derivSetEdgeWeight(JGraphTWeightedEdge edge,
                                  double weight)

Description copied from class: GraphLibrary

Sets the given weight as the weight of the given edge.

Specified by:

derivSetEdgeWeight in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

getIngoingEdges

public java.lang.Iterable<JGraphTWeightedEdge> getIngoingEdges(StdVertex vertex)

Description copied from class: GraphLibrary

Returns all ingoing edges of the given vertex. If the graph is directed then simply all incident edges of the vertex are given. A loop is ingoing and outgoing at the same time.

Specified by:

getIngoingEdges in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

An iterator which iterates over all ingoing edges of the given vertex.

getIngoingEdgeCount

public int getIngoingEdgeCount(StdVertex vertex)

Description copied from class: GraphLibrary

Returns the amount of ingoing edges of the given vertex. If the graph is directed, then simply the amount of all incident edges is given. A loop is ingoing and outgoing at the same time and therefore counts as one.

Specified by:

getIngoingEdgeCount in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

An integer indicating the number of ingoing edges of the given vertex.

getOutgoingEdges

public java.lang.Iterable<JGraphTWeightedEdge> getOutgoingEdges(StdVertex vertex)

Description copied from class: GraphLibrary

Returns all outgoing edges of the given vertex. If the graph is directed then simply all incident edges of the vertex are given. A loop is ingoing and outgoing at the same time.

Specified by:

getOutgoingEdges in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

An iterator which iterates over all outgoing edges of the given vertex.

getOutgoingEdgeCount

public int getOutgoingEdgeCount(StdVertex vertex)

Description copied from class: GraphLibrary

Returns the amount of outgoing edges of the given vertex. If the graph is directed, then simply the amount of all incident edges is given. A loop is ingoing and outgoing at the same time and therefore counts as one.

Specified by:

getOutgoingEdgeCount in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

An integer indicating the number of outgoing edges of the given vertex.

derivRemoveVertex

protected void derivRemoveVertex(StdVertex vertex)

Description copied from class: GraphLibrary

Removes the given vertex from the internal graph.

Specified by:

derivRemoveVertex in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - The vertex which shall be removed

derivRemoveEdge

protected void derivRemoveEdge(JGraphTWeightedEdge edge)

Description copied from class: GraphLibrary

Removes the given edge from the internal graph

Specified by:

derivRemoveEdge in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

edge - The edge which shall be removed

getEdge

public JGraphTWeightedEdge getEdge(StdVertex vertex1,
                                   StdVertex vertex2)

Description copied from class: GraphLibrary

Returns the edge which contains the given vertices. If the graph is undirected then the order of the two given vertices is not important.

Specified by:

getEdge in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex1 - The first vertex (start point if the graph is directed)

vertex2 - The second vertex (end point if the graph is directed)

Returns:

The respective edge

getVertexIdent

public java.lang.String getVertexIdent(StdVertex vertex)

Description copied from class: GraphLibrary

Returns the identifier of the given vertex.

Specified by:

getVertexIdent in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - The vertex its identifier shall be returned

Returns:

the identifier of the given vertex

derivSetVertexIdent

public void derivSetVertexIdent(StdVertex vertex,
                                java.lang.String ident)

Description copied from class: GraphLibrary

Changes the identifier of the given vertex.

Specified by:

derivSetVertexIdent in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - The vertex its identifier shall be set

ident - The new identifier

getVertexStatus

public java.lang.Object getVertexStatus(StdVertex vertex)

Description copied from class: GraphLibrary

Returns the status of the given vertex in O(1).

Specified by:

getVertexStatus in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - the vertex.

Returns:

the status of the given vertex.

setVertexStatus

public void setVertexStatus(StdVertex vertex,
                            java.lang.Object status)

Description copied from class: GraphLibrary

Sets the status of the given vertex in O(1).

Specified by:

setVertexStatus in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - the vertex of which the status shall be set.

status - the new status to set.

getEdgeStatus

public java.lang.Object getEdgeStatus(JGraphTWeightedEdge edge)

Description copied from class: GraphLibrary

Returns the status of the given edge in O(1).

Specified by:

getEdgeStatus in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

edge - the edge.

Returns:

the status of the given edge.

setEdgeStatus

public void setEdgeStatus(JGraphTWeightedEdge edge,
                          java.lang.Object status)

Description copied from class: GraphLibrary

Sets the status of the given edge in O(1).

Specified by:

setEdgeStatus in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

edge - the edge of which the status shall be set.

status - the new status to set.

getEdgeData

public java.lang.Object getEdgeData(JGraphTWeightedEdge edge)

Description copied from class: GraphLibrary

Returns the data of the given edge.

Specified by:

getEdgeData in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

edge - the edge.

Returns:

the data of the given edge.

getVertexData

public java.lang.Object getVertexData(StdVertex vertex)

Description copied from class: GraphLibrary

Returns the data of the given vertex.

Specified by:

getVertexData in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - the vertex.

Returns:

the data of the given vertex.

setEdgeData

public void setEdgeData(JGraphTWeightedEdge edge,
                        java.lang.Object data)

Description copied from class: GraphLibrary

Sets the data of the given edge. The previous data will be overwritten.

Specified by:

setEdgeData in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

edge - the edge of which the data shall be set.

data - the new data.

setVertexData

public void setVertexData(StdVertex vertex,
                          java.lang.Object data)

Description copied from class: GraphLibrary

Sets the data of the given vertex. The previous data will be overwritten.

Specified by:

setVertexData in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

vertex - the vertex of which thee status shall be set.

data - the new data to set.

getDefaultGraphConfiguration

protected GraphConfiguration getDefaultGraphConfiguration()

Description copied from class: GraphLibrary

Returns a GraphConfiguration which is working with the respective graph. The method createGraph must work with the given configuration.

Specified by:

getDefaultGraphConfiguration in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

A valid GraphConfiguration

derivCopyFromExistingGraph

protected void derivCopyFromExistingGraph(java.lang.Object graph,
                                          GraphLibrary<?,?> target)
                                   throws InvalidGraphException,
                                          InvalidGraphConfigException

Description copied from class: GraphLibrary

Copies the contents of the given graph instance into the given graph library.

Overrides:

derivCopyFromExistingGraph in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Parameters:

graph - the graph instance of the respective graph library.

target - the target GraphLibrary to copy to.

Throws:

InvalidGraphException - if the given object is not a valid graph instance of the graph library.

InvalidGraphConfigException - if the graph library can not handle the configuration of the given graph instance.

supportsCopyFromExistingGraph

protected boolean supportsCopyFromExistingGraph()

Description copied from class: GraphLibrary

Returns true, iff this GraphLibrary sub class supports creating graphs from existing graph instances.

Overrides:

supportsCopyFromExistingGraph in class GraphLibrary<StdVertex,JGraphTWeightedEdge>

Returns:

true, iff this GraphLibrary sub class supports creating graphs from existing graph instances.