|
Evolvica Core API Version 0.6.2 Last Modified: June 29 2004 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.evolvica.engine.AbstractAlgorithm
Abstract base class for an algorithm implementation.
Field Summary | |
protected gnu.trove.THashSet |
connections
Connections. |
protected gnu.trove.THashSet |
elements
Algorithm elements. |
protected MetadataStore |
metadata
The metadata store of this algorithm. |
protected java.lang.String |
name
Algorithm name. |
protected IRunner |
runner
Algorithm runner. |
protected IValidator |
validator
Algorithm validator. |
Constructor Summary | |
AbstractAlgorithm()
|
Method Summary | |
void |
addElement(IElement element)
Adds an element to this algorithm. |
void |
addMetadataChangeListener(java.beans.PropertyChangeListener listener)
Adds a property change listener that reacts on metadata changes to this algorithm. |
void |
addOperator(IOperator operator)
Adds an operator to this algorithm. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a property change listener to this algorithm. |
void |
connect(IElement source,
int output,
IElement target,
int input)
Connects two elements. |
void |
connect(IOperator source,
int output,
IOperator target)
Connects two operators. |
void |
connect(IOperator source,
int output,
IOperator target,
int input)
Connects two operators. |
void |
connect(IOperator source,
IOperator target)
Connects two operator. |
void |
connect(IOperator source,
IOperator target,
int input)
Connects two operators. |
int |
connectionSize()
Returns the number of connections in this algorithm. |
int |
elementSize()
Returns the number of elements contained in this algorithm. |
void |
execute()
Executes the algorithm. |
void |
firePropertyChangeEvent(java.beans.PropertyChangeEvent event)
Fires a property change event. |
IConnection |
getConnection(IElement source,
int output,
IElement target,
int input)
Returns the connection between two elements. |
IConnection |
getConnection(IOperator source,
int output,
IOperator target,
int input)
Returns the connection between two operators. |
IElement |
getElement(IOperator operator)
Return the algorithm element for a given operator. |
IElement |
getElementById(java.lang.String id)
Gets an element by its ID. |
Metadata |
getMetadata(java.lang.Object source,
java.lang.String path)
Returns a metadata object from the associated metadata store. |
java.lang.String |
getName()
Returns the name of the algorithm. |
IRunner |
getRunner()
Gets the algorithm runner. |
IValidator |
getValidator()
Gets the algorithm validator. |
java.util.Iterator |
iterateConnections()
Iterates all connections in this algorithm. |
java.util.Iterator |
iterateElements()
Iterates all elements in this algorithm. |
void |
removeConnection(IConnection connection)
Removes a connection from this algorithm. |
void |
removeElement(IElement element)
Removes an element from this algorithm. |
void |
removeMetadataChangeListener(java.beans.PropertyChangeListener listener)
Removes a metadata property change listener from this algorithm. |
void |
removeOperator(IOperator operator)
Removes the element for a given operator from this algorithm. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener from this algorithm. |
void |
restoreMetadata(IMetadataProvider provider)
Restores the metadata from the given metadata provider. |
void |
serializeMetadata(IMetadataSerializer serializer)
Serializes this algorithm's metadata by using the given serializer. |
void |
setMetadata(java.lang.Object source,
Metadata data)
Sets a metadata object. |
void |
setName(java.lang.String string)
Sets the name of the algorithm. |
void |
setRunner(IRunner runner)
Sets a new algorithm runner. |
abstract void |
setup()
Sets up the algorithm. |
void |
setValidator(IValidator validator)
Sets the algorithm validator. |
abstract void |
teardown()
Teardown method. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String name
protected gnu.trove.THashSet elements
protected gnu.trove.THashSet connections
protected IRunner runner
protected IValidator validator
protected MetadataStore metadata
Constructor Detail |
public AbstractAlgorithm()
Method Detail |
public void addElement(IElement element)
IAlgorithm
addElement
in interface IAlgorithm
element
- alement to addIAlgorithm.addElement(org.evolvica.engine.IElement)
public void addOperator(IOperator operator)
operator
- operator to be addedpublic IElement getElement(IOperator operator)
operator
- operator
public IElement getElementById(java.lang.String id)
IAlgorithm
getElementById
in interface IAlgorithm
id
- id of the element
IAlgorithm.getElementById(java.lang.String)
public java.util.Iterator iterateElements()
IAlgorithm
iterateElements
in interface IAlgorithm
IAlgorithm.iterateElements()
public void removeElement(IElement element)
IAlgorithm
removeElement
in interface IAlgorithm
element
- element to be removedIAlgorithm.removeElement(org.evolvica.engine.IElement)
public void removeOperator(IOperator operator)
operator
- operator to be removed from this algorithmpublic int elementSize()
IAlgorithm
elementSize
in interface IAlgorithm
IAlgorithm.elementSize()
public void connect(IOperator source, IOperator target)
source
- source operatortarget
- target operatorpublic void connect(IOperator source, int output, IOperator target)
source
- source operatoroutput
- output slottarget
- target operatorpublic void connect(IOperator source, IOperator target, int input)
source
- source operatortarget
- target operatorinput
- input slotpublic void connect(IOperator source, int output, IOperator target, int input)
IAlgorithm
connect
in interface IAlgorithm
source
- source operatoroutput
- source slottarget
- target operatorinput
- target slotIAlgorithm.connect(org.evolvica.engine.IOperator, int, org.evolvica.engine.IOperator, int)
public void connect(IElement source, int output, IElement target, int input)
IAlgorithm
connect
in interface IAlgorithm
source
- source elementoutput
- source slottarget
- target elementinput
- target slotIAlgorithm.connect(org.evolvica.engine.IElement, int, org.evolvica.engine.IElement, int)
public IConnection getConnection(IElement source, int output, IElement target, int input)
IAlgorithm
getConnection
in interface IAlgorithm
source
- source elementoutput
- source slottarget
- target elementinput
- target slot
IAlgorithm.getConnection(org.evolvica.engine.IElement, int, org.evolvica.engine.IElement, int)
public IConnection getConnection(IOperator source, int output, IOperator target, int input)
IAlgorithm
getConnection
in interface IAlgorithm
source
- source operatoroutput
- source slottarget
- target operatorinput
- target slot
IAlgorithm.getConnection(org.evolvica.engine.IOperator, int, org.evolvica.engine.IOperator, int)
public java.util.Iterator iterateConnections()
IAlgorithm
iterateConnections
in interface IAlgorithm
IAlgorithm.iterateConnections()
public void removeConnection(IConnection connection)
IAlgorithm
removeConnection
in interface IAlgorithm
connection
- connection to be removed.IAlgorithm.removeConnection(org.evolvica.engine.IConnection)
public int connectionSize()
IAlgorithm
connectionSize
in interface IAlgorithm
IAlgorithm.connectionSize()
public abstract void setup() throws java.lang.Exception
IAlgorithm
setup
in interface IAlgorithm
java.lang.Exception
- thrown if the setup stage failsIAlgorithm.setup()
public abstract void teardown() throws java.lang.Exception
IAlgorithm
teardown
in interface IAlgorithm
java.lang.Exception
- thrown if teardown stage failsIAlgorithm.teardown()
public void execute()
IAlgorithm
execute
in interface IAlgorithm
IAlgorithm.execute()
public java.lang.String getName()
IAlgorithm
getName
in interface IAlgorithm
IAlgorithm.getName()
public IRunner getRunner()
IAlgorithm
getRunner
in interface IAlgorithm
IAlgorithm.getRunner()
public IValidator getValidator()
IAlgorithm
getValidator
in interface IAlgorithm
IAlgorithm.getValidator()
public void setName(java.lang.String string)
IAlgorithm
setName
in interface IAlgorithm
string
- name of the algorithmIAlgorithm.setName(java.lang.String)
public void setRunner(IRunner runner) throws java.beans.PropertyVetoException
IAlgorithm
setRunner
in interface IAlgorithm
runner
- new algorithm runner
java.beans.PropertyVetoException
- thrown if algorithm runner is nullIAlgorithm.setRunner(org.evolvica.engine.IRunner)
public void setValidator(IValidator validator)
IAlgorithm
setValidator
in interface IAlgorithm
validator
- new algorithm validatorIAlgorithm.setValidator(org.evolvica.engine.IValidator)
public Metadata getMetadata(java.lang.Object source, java.lang.String path)
IAlgorithm
getMetadata
in interface IAlgorithm
source
- source objectpath
- metadata path
IAlgorithm.getMetadata(java.lang.Object, java.lang.String)
public void restoreMetadata(IMetadataProvider provider)
IAlgorithm
restoreMetadata
in interface IAlgorithm
provider
- metadata providerIAlgorithm.restoreMetadata(org.evolvica.util.IMetadataProvider)
public void serializeMetadata(IMetadataSerializer serializer)
IAlgorithm
serializeMetadata
in interface IAlgorithm
serializer
- metadata serializerIAlgorithm.serializeMetadata(org.evolvica.util.IMetadataSerializer)
public void setMetadata(java.lang.Object source, Metadata data)
IAlgorithm
setMetadata
in interface IAlgorithm
source
- source objectdata
- metadata objectIAlgorithm.setMetadata(java.lang.Object, org.evolvica.util.Metadata)
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
IAlgorithm
addPropertyChangeListener
in interface IAlgorithm
listener
- property change listener to be addedIAlgorithm.addPropertyChangeListener(java.beans.PropertyChangeListener)
public void addMetadataChangeListener(java.beans.PropertyChangeListener listener)
IAlgorithm
addMetadataChangeListener
in interface IAlgorithm
listener
- property change listener to be addedIAlgorithm.addMetadataChangeListener(java.beans.PropertyChangeListener)
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
IAlgorithm
removePropertyChangeListener
in interface IAlgorithm
listener
- property change listener to be removedIAlgorithm.removePropertyChangeListener(java.beans.PropertyChangeListener)
public void removeMetadataChangeListener(java.beans.PropertyChangeListener listener)
IAlgorithm
removeMetadataChangeListener
in interface IAlgorithm
listener
- property change listener to be removedIAlgorithm.removeMetadataChangeListener(java.beans.PropertyChangeListener)
public void firePropertyChangeEvent(java.beans.PropertyChangeEvent event)
IAlgorithm
firePropertyChangeEvent
in interface IAlgorithm
event
- event to be firedIAlgorithm.firePropertyChangeEvent(java.beans.PropertyChangeEvent)
|
Evolvica Core API Version 0.6.2 Last Modified: June 29 2004 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |