org.grinvin.generators.graphs

Interface GraphGenerator

All Superinterfaces:
Factory, NamedFactory
Known Implementing Classes:
AbstractGraphGenerator

public interface GraphGenerator
extends NamedFactory

An object that satisfies this interface can be used to instantiate an object of type GraphGeneratorInstance.

Method Summary

GraphGeneratorInstance
createInstance()
Should be overridden to generate an instance for the current values of the factory arguments.
String
getId()
Return the string that uniquely identifies this generator.
String
getInstanceId()
Return the id of the generator instance which will be created when using the current parameter values.

Methods inherited from interface org.grinvin.factories.Factory

getParameterValues, getParameters, setParameterValues

Methods inherited from interface org.grinvin.factories.NamedFactory

getDescription, getIconPath, getLongName, getName, getSelectedIconPath

Method Details

createInstance

public GraphGeneratorInstance createInstance()
            throws FactoryException
Should be overridden to generate an instance for the current values of the factory arguments.

getId

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

getInstanceId

public String getInstanceId()
            throws FactoryParameterException
Return the id of the generator instance which will be created when using the current parameter values.