JgraphtBackendImpl (GINsim 3.0.0b-SNAPSHOT API)

java.lang.Object
- org.jgrapht.graph.AbstractGraph<V,E>
- - org.jgrapht.graph.GraphDelegator<V,E>
  - - org.jgrapht.graph.DefaultListenableGraph<V,E>
    - - org.ginsim.core.graph.backend.JgraphtBackendImpl<V,E>

All Implemented Interfaces:

Serializable, Cloneable, GraphBackend<V,E>, org.jgrapht.Graph<V,E>, org.jgrapht.ListenableGraph<V,E>
```
public class JgraphtBackendImpl<V,E extends Edge<V>>
extends org.jgrapht.graph.DefaultListenableGraph<V,E>
implements GraphBackend<V,E>
```
See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.jgrapht.Graph
  DEFAULT_EDGE_WEIGHT

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addEdgeInBackend(E edge)` Add an edge in the JGraphT Graph
`boolean`	`addNodeInBackend(V vertex)` Add a vertex in the JGraphT graph
`boolean`	`containsEdge(V from, V to)`
`boolean`	`containsNode(V vertex)`
`void`	`damage(Object o)` Declare an object visual setting change
`EdgeViewInfo<V,E>`	`ensureEdgeViewInfo(E edge)` Get raw view information for an edge, create it if needed.
`Collection<E>`	`getEdges()`
`EdgeViewInfo<V,E>`	`getEdgeViewInfo(E edge)` Get raw view information for an edge.
`V`	`getExistingNode(V node)`
`static GraphBackend`	`getGraphBackend(Graph graph)`
`Collection<E>`	`getIncomingEdges(V vertex)`
`V`	`getNodeByName(String id)` Give access to the vertex named with the given name
`int`	`getNodeCount()`
`Collection<V>`	`getNodes()`
`NodeViewInfo`	`getNodeViewInfo(V vertex)` Get the Raw view info for a node.
`Collection<E>`	`getOutgoingEdges(V vertex)`
`List<E>`	`getShortestPath(V source, V target)` Find the shortest path between the two given vertices
`List<Set<V>>`	`getStronglyConnectedComponents()` Return a list of set of vertex, each set containing a strongly connected component of the graph
`boolean`	`removeNode(V node)` remove a node from the JgraphT graph
`void`	`repaint()` Trigger a repaint of the damaged areas
`void`	`setDefaultEdgeStyle(EdgeStyle<V,E> style)`
`void`	`setViewListener(GraphViewListener l)`

Methods inherited from class org.jgrapht.graph.DefaultListenableGraph
addEdge, addEdge, addGraphListener, addVertex, addVertexSetListener, clone, fireEdgeAdded, fireEdgeRemoved, fireEdgeWeightUpdated, fireVertexAdded, fireVertexRemoved, isReuseEvents, removeEdge, removeEdge, removeGraphListener, removeVertex, removeVertexSetListener, setEdgeWeight, setReuseEvents

Methods inherited from class org.jgrapht.graph.GraphDelegator
addVertex, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getDelegate, getEdge, getEdgeFactory, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getType, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, toString, vertexSet

Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets

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

Methods inherited from interface org.ginsim.core.graph.GraphBackend
getEdge, removeEdge

Methods inherited from interface org.jgrapht.Graph
addVertex, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getType, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, removeAllEdges, removeAllEdges, removeAllVertices, vertexSet

- Method Detail
  - getGraphBackend
```
public static GraphBackend getGraphBackend(Graph graph)
```
  - addEdgeInBackend
```
public boolean addEdgeInBackend(E edge)
```
    Add an edge in the JGraphT Graph
    
    Specified by:
    
    addEdgeInBackend in interface GraphBackend<V,E extends Edge<V>>
    
    Parameters:
    
    edge -
    
    Returns:
    
    true if the edge was correctly added, false if not.
  - addNodeInBackend
```
public boolean addNodeInBackend(V vertex)
```
    Add a vertex in the JGraphT graph
    
    Specified by:
    
    addNodeInBackend in interface GraphBackend<V,E extends Edge<V>>
    
    Parameters:
    
    vertex -
    
    Returns:
    
    true if the vertex was correctly added, false if not.
  - removeNode
```
public boolean removeNode(V node)
```
    remove a node from the JgraphT graph
    
    Specified by:
    
    removeNode in interface GraphBackend<V,E extends Edge<V>>
    
    Parameters:
    
    node - the node to remove
    
    Returns:
    
    true if the node was correctly removed, false if not
  - getNodeCount
```
public int getNodeCount()
```
    Specified by:
    
    getNodeCount in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    the number of node in this graph.
  - getEdges
```
public Collection<E> getEdges()
```
    Specified by:
    
    getEdges in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    a Collection of the graph edges.
  - getNodes
```
public Collection<V> getNodes()
```
    Specified by:
    
    getNodes in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    a Collection of the graph vertices.
  - getNodeByName
```
public V getNodeByName(String id)
```
    Give access to the vertex named with the given name
    
    Specified by:
    
    getNodeByName in interface GraphBackend<V,E extends Edge<V>>
    
    Parameters:
    
    id - name of a vertex
    
    Returns:
    
    the vertex corresponding to this unique id or null if not found.
  - getIncomingEdges
```
public Collection<E> getIncomingEdges(V vertex)
```
    Specified by:
    
    getIncomingEdges in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    incoming edges of the given node.
  - getOutgoingEdges
```
public Collection<E> getOutgoingEdges(V vertex)
```
    Specified by:
    
    getOutgoingEdges in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    outgoing edges of the given node.
  - getNodeViewInfo
```
public NodeViewInfo getNodeViewInfo(V vertex)
```
    Description copied from interface: GraphBackend
    
    Get the Raw view info for a node.
    
    Specified by:
    
    getNodeViewInfo in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    raw setting for node rendering
  - containsNode
```
public boolean containsNode(V vertex)
```
    Specified by:
    
    containsNode in interface GraphBackend<V,E extends Edge<V>>
    
    Parameters:
    
    vertex -
    
    Returns:
    
    true if the vertex is in the graph, false if not.
  - getExistingNode
```
public V getExistingNode(V node)
```
    Specified by:
    
    getExistingNode in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    an existing node if found, or null.
  - containsEdge
```
public boolean containsEdge(V from,
                            V to)
```
    Specified by:
    
    containsEdge in interface GraphBackend<V,E extends Edge<V>>
    
    Specified by:
    
    containsEdge in interface org.jgrapht.Graph<V,E extends Edge<V>>
    
    Overrides:
    
    containsEdge in class org.jgrapht.graph.AbstractGraph<V,E extends Edge<V>>
    
    Parameters:
    
    from -
    
    to -
    
    Returns:
    
    true if an edge between the two provided vertices exists in the graph, false if not.
  - getShortestPath
```
public List<E> getShortestPath(V source,
                               V target)
```
    Find the shortest path between the two given vertices
    
    Specified by:
    
    getShortestPath in interface GraphBackend<V,E extends Edge<V>>
    
    Parameters:
    
    source - the vertex at the beginning of the searched path
    
    target - the vertex at the end of the searched path
    
    Returns:
    
    the list of edges composing the shortest path
  - getStronglyConnectedComponents
```
public List<Set<V>> getStronglyConnectedComponents()
```
    Return a list of set of vertex, each set containing a strongly connected component of the graph
    
    Specified by:
    
    getStronglyConnectedComponents in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    a list of set of vertex, each set containing a strongly connected component of the graph
  - damage
```
public void damage(Object o)
```
    Description copied from interface: GraphBackend
    
    Declare an object visual setting change
    
    Specified by:
    
    damage in interface GraphBackend<V,E extends Edge<V>>
  - repaint
```
public void repaint()
```
    Description copied from interface: GraphBackend
    
    Trigger a repaint of the damaged areas
    
    Specified by:
    
    repaint in interface GraphBackend<V,E extends Edge<V>>
  - setViewListener
```
public void setViewListener(GraphViewListener l)
```
    Specified by:
    
    setViewListener in interface GraphBackend<V,E extends Edge<V>>
  - getEdgeViewInfo
```
public EdgeViewInfo<V,E> getEdgeViewInfo(E edge)
```
    Description copied from interface: GraphBackend
    
    Get raw view information for an edge. This may return null if the edge has no attached information.
    
    Specified by:
    
    getEdgeViewInfo in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    the raw view information for this edge
  - ensureEdgeViewInfo
```
public EdgeViewInfo<V,E> ensureEdgeViewInfo(E edge)
```
    Description copied from interface: GraphBackend
    
    Get raw view information for an edge, create it if needed.
    
    Specified by:
    
    ensureEdgeViewInfo in interface GraphBackend<V,E extends Edge<V>>
    
    Returns:
    
    the raw view information for this edge
  - setDefaultEdgeStyle
```
public void setDefaultEdgeStyle(EdgeStyle<V,E> style)
```
    Specified by:
    
    setDefaultEdgeStyle in interface GraphBackend<V,E extends Edge<V>>

Class JgraphtBackendImpl<V,E extends Edge<V>>

Field Summary

Fields inherited from interface org.jgrapht.Graph

Method Summary

Methods inherited from class org.jgrapht.graph.DefaultListenableGraph

Methods inherited from class org.jgrapht.graph.GraphDelegator

Methods inherited from class org.jgrapht.graph.AbstractGraph

Methods inherited from class java.lang.Object

Methods inherited from interface org.ginsim.core.graph.GraphBackend

Methods inherited from interface org.jgrapht.Graph

Method Detail

getGraphBackend

addEdgeInBackend

addNodeInBackend

removeNode

getNodeCount

getEdges

getNodes

getNodeByName

getIncomingEdges

getOutgoingEdges

getNodeViewInfo

containsNode

getExistingNode

containsEdge

getShortestPath

getStronglyConnectedComponents

damage

repaint

setViewListener

getEdgeViewInfo

ensureEdgeViewInfo

setDefaultEdgeStyle