org.ginsim.core.graph

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

All Superinterfaces:

GraphModel<V,E>

All Known Subinterfaces:

DynamicGraph, HierarchicalTransitionGraph, ReducedGraph<AG,AV,AE>, RegulatoryGraph, TransitionGraph<V,E>, TrapSpaceInclusionDiagram, Tree

All Known Implementing Classes:

AbstractDerivedGraph, AbstractGraph, DynamicGraphImpl, HierarchicalTransitionGraphImpl, ReducedGraphImpl, RegulatoryGraphImpl, TransitionGraphImpl, TrapSpaceTreeImpl, TreeImpl

public interface Graph<V,E extends Edge<V>>
extends GraphModel<V,E>

The main graph object in GINsim. Beside the basic graph methods from the GraphModel interface, this provides access to the view (styles and attribute readers), and define methods to save a graph.

Author:

Aurelien Naldi, Lionel Spinelli

Method Summary

Modifier and Type	Method and Description
void	addViewListener(GraphViewListener listener) Add a listener for view change events.
void	copyView(Graph<V,E> src, ViewCopyHelper<Graph<V,E>,V,E> helper) Transfer view settings from a related graph.
void	fireGraphChange(GraphChangeType type, Object data) The graph has changed, all listeners will be notified.
Map<String,String>	getAttributes() Retrieve graph-level attributes
Dimension	getDimension() Get the global bounds of the graph.
String	getDisplayName(V node) Retrieve the name to use when displaying a graph node.
EdgeAttributesReader	getEdgeAttributeReader() Give access to the attribute reader of edges
NodeAttributesReader	getNodeAttributeReader() Give access to the attribute reader of vertices
StyleManager<V,E>	getStyleManager() Retrieve the style manager for this graph.
void	save(String path) Save this graph.
void	save(String path, Collection<V> nodes, Collection<E> edges) Save some components of this graph.
void	setAttribute(String name, String value)

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

addEdge, addNode, containsEdge, containsNode, getAnnotation, getEdge, getEdges, getExistingNode, getGraphName, getIncomingEdges, getNodeByName, getNodeCount, getNodeOrderSize, getNodes, getOutgoingEdges, getShortestPath, getStronglyConnectedComponents, getSubgraph, merge, removeEdge, removeNode, searchNodes, setGraphName

Method Detail

getStyleManager

StyleManager<V,E> getStyleManager()

Retrieve the style manager for this graph.

Returns:

the style manager

getEdgeAttributeReader

EdgeAttributesReader getEdgeAttributeReader()

Give access to the attribute reader of edges

Returns:

the attribute reader of edges

getNodeAttributeReader

NodeAttributesReader getNodeAttributeReader()

Give access to the attribute reader of vertices

Returns:

the attribute reader of vertices

getDimension

Dimension getDimension()

Get the global bounds of the graph.

Returns:

save

void save(String path)
   throws GsException

Save this graph.

Parameters:

path -

Throws:

GsException

save

void save(String path,
          Collection<V> nodes,
          Collection<E> edges)
   throws GsException

Save some components of this graph.

Parameters:

path -

Throws:

GsException

addViewListener

void addViewListener(GraphViewListener listener)

Add a listener for view change events. Note: only one listener is supported: the GraphGUI

Parameters:

listener -

copyView

void copyView(Graph<V,E> src,
              ViewCopyHelper<Graph<V,E>,V,E> helper)

Transfer view settings from a related graph. The position and styles of matching nodes and edges will be copied from the source graph to the current one

Parameters:

src - the source graph

fireGraphChange

void fireGraphChange(GraphChangeType type,
                     Object data)

The graph has changed, all listeners will be notified. It will also be marked as unsaved.

Parameters:

type -

data -

getDisplayName

String getDisplayName(V node)

Retrieve the name to use when displaying a graph node.

Parameters:

node -

Returns:

getAttributes

Map<String,String> getAttributes()

Retrieve graph-level attributes

Returns:

a map of attribute values, it can be empty but should not be null

setAttribute

void setAttribute(String name,
                  String value)