org.ginsim.core.graph

Class GSGraphManager

java.lang.Object

org.ginsim.core.graph.GSGraphManager

public class GSGraphManager
extends Object

Manage registered graph types and handles graph creation (from scratch or through a parser). It loads GraphFactory implementations annotated as services.

Author:

Lionel Spinelli, Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
<G extends GraphModel<?,?>> void	addGraphListener(G graph, GraphListener<G> listener)
void	close(Graph graph) Remove all the server side association to the graph
<G extends GraphModel<?,?>> void	fireGraphChange(G graph, GraphChangeType type, Object data)
Set	getAllGraphs() Return the list of registered graphs
Collection<GraphFactory>	getGraphFactories()
Graph	getGraphFromPath(String path) Return the graph associated to the given file path, if it exists
String	getGraphPath(Graph graph) Return the path of the file the graph has been loaded from or saved to (if it exists)
ServiceClassInfo[]	getGraphsInfo()
String	getGraphType()
static GSGraphManager	getInstance()
RegulatoryGraph	getNewGraph() Create a new (RegulatoryGraph)
<C extends Graph> C	getNewGraph(Class<C> graph_class) Create a new default graph of the given class
<C extends Graph> C	getNewGraph(Class<C> graph_class, Object... args)
Class	getParserClass(String graph_type) Search for the factory managing the given graph type and return the corresponding parser
Graph	open(File file)
Graph	open(Set set, File file)
Graph	open(String file_path) Retrieve the Graph stored in the file at the given file path
void	registerGraph(Graph graph) register a graph without associated file path
<G extends Graph<?,?>> void	registerGraph(G graph, String file_path) Memorize the link between the graph and the path of the file the graph has been loaded from or saved to
<G extends GraphModel<?,?>> void	removeGraphListener(G graph, GraphListener<G> listener)

Methods inherited from class java.lang.Object

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

Method Detail

getGraphType

public String getGraphType()

getInstance

public static GSGraphManager getInstance()

Returns:

an instance of this graphDescriptor.

getNewGraph

public RegulatoryGraph getNewGraph()

Create a new (RegulatoryGraph)

Returns:

a new Regulatory Graph

getNewGraph

public <C extends Graph> C getNewGraph(Class<C> graph_class)

Create a new default graph of the given class

Parameters:

graph_class - the class of the graph to instantiate

Returns:

the new instance of the graph

getGraphFactories

public Collection<GraphFactory> getGraphFactories()

getNewGraph

public <C extends Graph> C getNewGraph(Class<C> graph_class,
                                       Object... args)

Parameters:

graph_class -

args -

Returns:

a new Graph of the specified type, or null if failed

getParserClass

public Class getParserClass(String graph_type)

Search for the factory managing the given graph type and return the corresponding parser

Parameters:

graph_type - the type of the graph

Returns:

the class of the parser used to read the given graph type

registerGraph

public void registerGraph(Graph graph)

register a graph without associated file path

Parameters:

graph - the graph

registerGraph

public <G extends Graph<?,?>> void registerGraph(G graph,
                                                 String file_path)

Memorize the link between the graph and the path of the file the graph has been loaded from or saved to

Parameters:

graph - the graph

file_path - the path of the file the graph has been loaded from or saved to

getAllGraphs

public Set getAllGraphs()

Return the list of registered graphs

Returns:

the list of all registered graph types

addGraphListener

public <G extends GraphModel<?,?>> void addGraphListener(G graph,
                                                         GraphListener<G> listener)

removeGraphListener

public <G extends GraphModel<?,?>> void removeGraphListener(G graph,
                                                            GraphListener<G> listener)

fireGraphChange

public <G extends GraphModel<?,?>> void fireGraphChange(G graph,
                                                        GraphChangeType type,
                                                        Object data)

getGraphPath

public String getGraphPath(Graph graph)

Return the path of the file the graph has been loaded from or saved to (if it exists)

Parameters:

graph -

Returns:

the path of the file the graph has been loaded from or saved to if it exsists, null if not.

getGraphFromPath

public Graph getGraphFromPath(String path)

Return the graph associated to the given file path, if it exists

Parameters:

path - the file path associated to the desired graph

Returns:

the graph associated to the given file path, if it exists, null if not

open

public Graph open(String file_path)
           throws GsException

Retrieve the Graph stored in the file at the given file path

Parameters:

file_path - the file path of the graph file

Returns:

the Graph stored in the file at the given file path

Throws:

GsException

open

public Graph open(File file)
           throws GsException

Parameters:

file - the File containing the graph to open

Returns:

a graph of the correct type read from the given file

Throws:

GsException

open

public Graph open(Set set,
                  File file)
           throws GsException

Parameters:

file - the File containing the graph to open

Returns:

a graph of the correct type read from the given file

Throws:

GsException

close

public void close(Graph graph)

Remove all the server side association to the graph

Parameters:

graph - the graph to close

getGraphsInfo

public ServiceClassInfo[] getGraphsInfo()