edu.udo.cs.yale.operator.meta
Class RepeatUntilOperatorChain

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.OperatorChain
          edu.udo.cs.yale.operator.meta.RepeatUntilOperatorChain

All Implemented Interfaces:

ConfigurationListener

public class RepeatUntilOperatorChain
extends OperatorChain

Performs its inner operators until all given criteria is met or a timeout occurs.

Version:

$Id: RepeatUntilOperatorChain.java,v 1.11 2006/04/05 08:57:26 ingomierswa Exp $

Author:

Stefan Rueping

Field Summary

static java.lang.String[]	COMPARISONS
static int	DECREASING
private double	fitness
private int	iteration
private IOContainer	lastInput
static int	NONE
static int	NONINCREASING
private long	stoptime

Constructor Summary

RepeatUntilOperatorChain(OperatorDescription description)

Method Summary

IOObject[]	apply() Applies all inner operators.
private boolean	evaluateCondition(IOContainer input) Evaluates whether the stopping condition is met
InnerOperatorCondition	getInnerOperatorCondition() Returns a simple chain condition.
java.lang.Class[]	getInputClasses() Returns the classes that are needed as input.
int	getMaxNumberOfInnerOperators() Returns the minimum number of innner operators.
int	getMinNumberOfInnerOperators() Returns the maximum 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.

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

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

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

addError, addValue, addWarning, apply, createExperimentTree, createFromXML, createMarkedExperimentTree, getAddOnlyAdditionalOutput, 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

COMPARISONS

public static final java.lang.String[] COMPARISONS

NONE

public static final int NONE

See Also:

Constant Field Values

DECREASING

public static final int DECREASING

See Also:

Constant Field Values

NONINCREASING

public static final int NONINCREASING

See Also:

Constant Field Values

iteration

private int iteration

stoptime

private long stoptime

fitness

private double fitness

lastInput

private IOContainer lastInput

Constructor Detail

RepeatUntilOperatorChain

public RepeatUntilOperatorChain(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException,
                        MissingIOObjectException

Description copied from class: OperatorChain

Applies all inner operators. The input to this operator becomes the input of the first inner operator. The latter's output is passed to the second inner operator and so on. Note to subclassers: If subclasses (for example wrappers) want to make use of this method remember to call exactly this method (super.apply()) and do not call super.apply(IOContainer) erroneously which will result in an infinite loop. Subclasses who override this method without invoking super.apply() should at least invoke the method OperatorChain.clearStepCounter().

Overrides:

apply in class OperatorChain

Returns:

the last inner operator's output or the input itself if the chain is empty.

Throws:

OperatorException

MissingIOObjectException

evaluateCondition

private boolean evaluateCondition(IOContainer input)
                           throws MissingIOObjectException,
                                  UndefinedParameterError

Evaluates whether the stopping condition is met

Throws:

MissingIOObjectException

UndefinedParameterError

getInnerOperatorCondition

public InnerOperatorCondition getInnerOperatorCondition()

Returns a simple chain condition.

Specified by:

getInnerOperatorCondition in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Returns the maximum number of innner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Returns the minimum number of innner operators.

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

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

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

getNumberOfSteps

public int getNumberOfSteps()

Description copied from class: OperatorChain

Returns the number of steps performed by this chain.

Specified by:

getNumberOfSteps in class OperatorChain

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