edu.udo.cs.yale.operator
Class ExperimentOperator

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.OperatorChain
          edu.udo.cs.yale.operator.ExperimentOperator

All Implemented Interfaces:

ConfigurationListener

public final class ExperimentOperator
extends OperatorChain

Each experiment must contain exactly one operator of this class and it must be the root operator of the experiment. The only purpose of this operator is to provide some parameters that have global relevance.

Version:

$Id: ExperimentOperator.java,v 2.25 2006/04/14 11:42:27 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private java.util.List<ExperimentListener>

listenerList

Constructor Summary

ExperimentOperator(OperatorDescription description)

ExperimentOperator(OperatorDescription description, Experiment experiment)
Creates an empty operator chain.

Method Summary

void	addExperimentListener(ExperimentListener l)
void	countStep()
void	experimentFinished() Called at the end of the experiment.
void	experimentStarts() Called at the beginning of the experiment.
boolean	getAddOnlyAdditionalOutput() Since the apply methods of the inner operators already add additional output, the handle additional output method should simply return a new container which is build from the additional output objects.
InnerOperatorCondition	getInnerOperatorCondition() Returns a simple chain condition.
java.lang.Class[]	getInputClasses() Returns the classes that are needed as input.
int	getMaxNumberOfInnerOperators() Returns the highest possible value for the maximum number of innner operators.
int	getMinNumberOfInnerOperators() Returns 0 for the minimum number of innner operators.
int	getNumberOfSteps() Returns the number of steps performed by this chain.
java.lang.Class[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
void	removeExperimentListener(ExperimentListener l)
void	sendEmail(IOContainer results, java.lang.Throwable e)
boolean	shouldReturnInnerOutput() Returns true since this operator chain should just return the output of the last inner operator.

Methods inherited from class edu.udo.cs.yale.operator.OperatorChain

addAddListener, addOperator, addOperator, apply, checkDeprecations, checkIO, checkNumberOfInnerOperators, checkProperties, clearErrorList, clearStepCounter, cloneOperator, createExperimentTree, delete, getAllInnerOperators, getCurrentStep, getIndexOfOperator, getInnerOperatorForName, getInnerOperatorsXML, getNumberOfAllOperators, getNumberOfChildrensSteps, getNumberOfOperators, getOperator, getOperatorFromAll, getOperators, isEnabled, performAdditionalChecks, removeAddListener, removeOperator, setEnabled, setExperiment

Methods inherited from class edu.udo.cs.yale.operator.Operator

addError, addValue, addWarning, apply, createExperimentTree, createFromXML, createMarkedExperimentTree, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getErrorList, getExperiment, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsInt, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isParameterSet, logMessage, register, remove, rename, resume, setBreakpoint, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

listenerList

private java.util.List<ExperimentListener> listenerList

Constructor Detail

ExperimentOperator

public ExperimentOperator(OperatorDescription description)

ExperimentOperator

public ExperimentOperator(OperatorDescription description,
                          Experiment experiment)

Creates an empty operator chain.

Method Detail

shouldReturnInnerOutput

public boolean shouldReturnInnerOutput()

Returns true since this operator chain should just return the output of the last inner operator.

Overrides:

shouldReturnInnerOutput in class OperatorChain

getInnerOperatorCondition

public InnerOperatorCondition getInnerOperatorCondition()

Returns a simple chain condition.

Specified by:

getInnerOperatorCondition in class OperatorChain

getAddOnlyAdditionalOutput

public boolean getAddOnlyAdditionalOutput()

Since the apply methods of the inner operators already add additional output, the handle additional output method should simply return a new container which is build from the additional output objects. Therefore this method returns true.

Overrides:

getAddOnlyAdditionalOutput in class Operator

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Returns the highest possible value for the maximum number of innner operators.

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Returns 0 for the minimum number of innner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

getNumberOfSteps

public int getNumberOfSteps()

Description copied from class: OperatorChain

Returns the number of steps performed by this chain.

Specified by:

getNumberOfSteps in class OperatorChain

addExperimentListener

public void addExperimentListener(ExperimentListener l)

removeExperimentListener

public void removeExperimentListener(ExperimentListener l)

experimentStarts

public void experimentStarts()

Called at the beginning of the experiment. Notifies all listeners and the children operators (super method).

Overrides:

experimentStarts in class OperatorChain

countStep

public void countStep()

Overrides:

countStep in class OperatorChain

experimentFinished

public void experimentFinished()

Called at the end of the experiment. Notifies all listeners and the children operators (super method).

Overrides:

experimentFinished in class OperatorChain

sendEmail

public void sendEmail(IOContainer results,
                      java.lang.Throwable e)
               throws UndefinedParameterError

Throws:

UndefinedParameterError

getInputClasses

public java.lang.Class[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input object which should not be consumed must also be defined by this method (e.g. for preprocessing operators). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed must not be defined as additional output in this method. May be null or an empy array (no additional output is produced).

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Overrides:

getParameterTypes in class Operator