org.ginsim.core.graph

Interface GraphBackend<V,E extends Edge<V>>

Type Parameters:

V -

E -

All Known Implementing Classes:

JgraphtBackendImpl

public interface GraphBackend<V,E extends Edge<V>>

Abstract definition of a graph backend to avoid leaking implementation details in the main classes.

Author:

Lionel Spinelli, Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
boolean	addEdgeInBackend(E edge) Add an edge to the graph.
boolean	addNodeInBackend(V node) Add a node to the graph.
boolean	containsEdge(V from, V to)
boolean	containsNode(V node)
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.
E	getEdge(V source, V target)
Collection<E>	getEdges()
EdgeViewInfo<V,E>	getEdgeViewInfo(E edge) Get raw view information for an edge.
V	getExistingNode(V node)
Collection<E>	getIncomingEdges(V node)
V	getNodeByName(String id) Give access to the node named with the given name
int	getNodeCount()
Collection<V>	getNodes()
NodeViewInfo	getNodeViewInfo(V node) Get the Raw view info for a node.
Collection<E>	getOutgoingEdges(V node)
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 node, each set containing a strongly connected component of the graph
boolean	removeEdge(E edge) remove an edge from the graph.
boolean	removeNode(V node) remove a node from the graph.
void	repaint() Trigger a repaint of the damaged areas
void	setDefaultEdgeStyle(EdgeStyle<V,E> style)
void	setViewListener(GraphViewListener l)

Method Detail

addNodeInBackend

boolean addNodeInBackend(V node)

Add a node to the graph. The front-end graph is responsible for creating the node object and calling this method in the backend.

Parameters:

node -

Returns:

true if the node was created, false otherwise

addEdgeInBackend

boolean addEdgeInBackend(E edge)

Add an edge to the graph. The front-end graph is responsible for creating the edge and calling this method in the backend.

Parameters:

edge -

Returns:

true if the edge was created, false otherwise

containsNode

boolean containsNode(V node)

Parameters:

node -

Returns:

true if the node is in the graph, false if not.

getExistingNode

V getExistingNode(V node)

Parameters:

node -

Returns:

an existing node if found, or null.

containsEdge

boolean containsEdge(V from,
                     V to)

Parameters:

from -

to -

Returns:

true if an edge between the two provided vertices exists in the graph, false if not.

removeNode

boolean removeNode(V node)

remove a node from the graph.

Parameters:

node -

Returns:

true if the node was correctly removed, false if not.

removeEdge

boolean removeEdge(E edge)

remove an edge from the graph.

Parameters:

edge -

Returns:

true if the edge was correctly removed, false if not.

getNodes

Collection<V> getNodes()

Returns:

a Collection of the graph vertices.

getNodeByName

V getNodeByName(String id)

Give access to the node named with the given name

Parameters:

id - name of a node

Returns:

the node corresponding to this unique id or null if not found.

getNodeCount

int getNodeCount()

Returns:

the number of node in this graph.

getEdge

E getEdge(V source,
          V target)

Parameters:

source -

target -

Returns:

the edge between source and target or null if not found.

getEdges

Collection<E> getEdges()

Returns:

a Collection of the graph edges.

getIncomingEdges

Collection<E> getIncomingEdges(V node)

Parameters:

node -

Returns:

incoming edges of the given node.

getOutgoingEdges

Collection<E> getOutgoingEdges(V node)

Parameters:

node -

Returns:

outgoing edges of the given node.

getNodeViewInfo

NodeViewInfo getNodeViewInfo(V node)

Get the Raw view info for a node.

Parameters:

node -

Returns:

raw setting for node rendering

getEdgeViewInfo

EdgeViewInfo<V,E> getEdgeViewInfo(E edge)

Get raw view information for an edge. This may return null if the edge has no attached information.

Parameters:

edge -

Returns:

the raw view information for this edge

ensureEdgeViewInfo

EdgeViewInfo<V,E> ensureEdgeViewInfo(E edge)

Get raw view information for an edge, create it if needed.

Parameters:

edge -

Returns:

the raw view information for this edge

getShortestPath

List<E> getShortestPath(V source,
                        V target)

Find the shortest path between the two given vertices

Parameters:

source - the node at the beginning of the searched path

target - the node at the end of the searched path

Returns:

the list of edges composing the shortest path

getStronglyConnectedComponents

List<Set<V>> getStronglyConnectedComponents()

Return a list of set of node, each set containing a strongly connected component of the graph

Returns:

a list of set of node, each set containing a strongly connected component of the graph

setViewListener

void setViewListener(GraphViewListener l)

damage

void damage(Object o)

Declare an object visual setting change

Parameters:

o -

repaint

void repaint()

Trigger a repaint of the damaged areas

setDefaultEdgeStyle

void setDefaultEdgeStyle(EdgeStyle<V,E> style)