org.grinvin.factories.graphs

Interface GraphFactory

All Superinterfaces:
Factory
Known Subinterfaces:
VisualGraphFactory
Known Implementing Classes:
AbstractGraphFactory

public interface GraphFactory
extends Factory

An object that satisfies this interface can be used to create a graph and store it into a graph bundle. To have a factory create a graph, first set its parameters using GraphFactory and then call createGraph(GraphBundle).

Method Summary

URI
createGraph(GraphBundle graphBundle)
Create a graph and store it into the given graph bundle.
String
getDescription()
Return the internationalized description of the factory.
String
getIconPath()
Return the URI of the factory icon when the factory is not selected.
String
getId()
Return the string that uniquely identifies this factory.
String
getLongName()
Return the internationalized name of the factory.
String
getName()
Return the internationalized name of the factory.
String
getSelectedIconPath()
Return the URI of the factory icon when the factory is selected.
URI
getURI()
Return the URI of the graph which will be created from this factory when using the current parameter values.

Methods inherited from interface org.grinvin.factories.Factory

getParameterValues, getParameters, setParameterValues

Method Details

createGraph

public URI createGraph(GraphBundle graphBundle)
            throws FactoryParameterException,
                   FactoryException
Create a graph and store it into the given graph bundle.
Returns:
an URI which represents the graph being created.
Throws:
FactoryParameterException - when the parameters for this graph were not set in an appropriate manner before this method was called.

getDescription

public String getDescription()
Return the internationalized description of the factory.

getIconPath

public String getIconPath()
Return the URI of the factory icon when the factory is not selected.

getId

public String getId()
Return the string that uniquely identifies this factory. This id is typically used for retreiving documentation pages for this factory and for building URIs for the graphs created by this factory.

getLongName

public String getLongName()
Return the internationalized name of the factory.

getName

public String getName()
Return the internationalized name of the factory.

getSelectedIconPath

public String getSelectedIconPath()
Return the URI of the factory icon when the factory is selected.

getURI

public URI getURI()
            throws FactoryParameterException
Return the URI of the graph which will be created from this factory when using the current parameter values.