edu.udo.cs.yale.operator
Class OperatorChain

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

All Implemented Interfaces:

ConfigurationListener

Direct Known Subclasses:

AbstractMetaLearner, EvolutionaryBoosting, EvolutionaryFeatureAggregation, ExampleSetIterator, ExperimentOperator, FeatureOperator, GenericWekaEnsembleLearner, GenericWekaMetaLearner, IteratingOperatorChain, IteratingPerformanceAverage, IterativeWeightOptimization, LearningCurveOperator, MartinsIterationOperator, MultipleLabelIterator, OperatorEnabler, ParameterIteration, ParameterOptimizationOperator, PSOWeighting, RandomOptimizationChain, RepeatUntilOperatorChain, SDRulesetInduction, SimpleOperatorChain, SplitChain, TransformedRegression, ValidationChain, WeightOptimization, WrapperValidationChain, XVPrediction

public abstract class OperatorChain
extends Operator

A chain of operators that is subsequently applied. As an OperatorChain is an Operator itself it can be arbitrarily nested.
Inheritants can access inner operators by getOperator(int). They should override getMaxNumberOfInnerOperators() and getMinNumberOfInnerOperators() which are used for some checks. They should also override getInnerOperatorCondition() to ensure that all inner operators get the desired input and return the necessary output for the next inner operator. You also have to implement getNumberOfSteps() which is used to estimate the needed runtime of your experiment and for display purposes in the graphical user interface. Please refer to the YALE tutorial for a description how to implement your own operator chain.

Version:

$Id: OperatorChain.java,v 2.43 2006/08/22 13:08:19 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

Field Summary

private java.util.List<AddListener>	addListeners
private java.util.List<Operator>	operators The inner operators.
private int	stepCounter

Constructor Summary

OperatorChain(OperatorDescription description)
Creates an empty operator chain.

Method Summary

void	addAddListener(AddListener listener) Adds the given listener.
int	addOperator(Operator o) Adds a new inner operator at the last position.
void	addOperator(Operator operator, int index) Adds the given operator at the given position.
IOObject[]	apply() Applies all inner operators.
int	checkDeprecations() Will count an the number of deprecated operators, i.e. the operators which Operator.getDeprecationInfo() method does not return null.
java.lang.Class[]	checkIO(java.lang.Class[] input) This method checks if inner operators can handle their input and deliver the necessary output.
int	checkNumberOfInnerOperators() Checks if the number of inner operators lies between MinInnerOps and MaxInnerOps.
int	checkProperties() Will throw an exception if a non optional property has no default value and is not defined by user.
void	clearErrorList() Clears the list of errors.
void	clearStepCounter() Necessary to call at the begin of an overloaded apply(IOContainer).
Operator	cloneOperator(java.lang.String name) Performs a deep clone of this operator chain.
void	countStep()
protected java.lang.String	createExperimentTree(int indent, java.lang.String selfPrefix, java.lang.String childPrefix, Operator markOperator, java.lang.String mark) Returns this OperatorChain's name and class and the ExperimentTrees of the inner operators.
void	delete() Deletes this operator removing it from the name map.
void	experimentFinished() Called at the end of the experiment.
void	experimentStarts() Called when the experiment starts.
private void	fireAddEvent(Operator child) Notifies all added add listeners that a new child was added.
java.util.List<Operator>	getAllInnerOperators() Returns recursively all child operators independently if they are activated or not.
private java.lang.Class[]	getAllOutputClasses(java.lang.Class[] innerOutput) Helper method if in addition to the created output the inner output should also be returned.
int	getCurrentStep()
int	getIndexOfOperator(Operator operator, boolean useDeselected)
abstract InnerOperatorCondition	getInnerOperatorCondition() Must return a condition of the IO behaviour of all desired inner operators.
Operator	getInnerOperatorForName(java.lang.String name) Returns the inner operator named name or null if no such operator exists.
protected java.lang.String	getInnerOperatorsXML(java.lang.String indent) Writes the XML representation of the inner operators.
abstract int	getMaxNumberOfInnerOperators() Returns the maximum number of innner operators.
abstract int	getMinNumberOfInnerOperators() Returns the minimum number of innner operators.
int	getNumberOfAllOperators() Returns the number of all inner operators (including the disabled operators).
int	getNumberOfChildrensSteps()
int	getNumberOfOperators() Returns the number of all enabled inner operators.
abstract int	getNumberOfSteps() Returns the number of steps performed by this chain.
Operator	getOperator(int i) Returns the i-th inner operator.
Operator	getOperatorFromAll(int i) Returns the i-th operator.
java.util.Iterator<Operator>	getOperators() Returns an iterator over all Operators.
boolean	isEnabled() Returns true if this operator is enabled.
void	performAdditionalChecks() This method invokes the additional check method for each child.
void	removeAddListener(AddListener listener) Removes the given listener.
void	removeOperator(Operator operator) Removes the given operator from this operator chain.
void	setEnabled(boolean enabled) Sets the activation mode.
void	setExperiment(Experiment experiment) Sets the experiment for this operator chain and for all children.
boolean	shouldReturnInnerOutput() Indicates if inner output should be delivered by this operator chain.

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, getInputClasses, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getName, getOperatorClassName, getOperatorDescription, getOutputClasses, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsInt, getParameterAsString, getParameterList, getParameters, getParameterType, getParameterTypes, 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

operators

private java.util.List<Operator> operators

The inner operators. They are applied in their ordering in the list.

addListeners

private java.util.List<AddListener> addListeners

stepCounter

private int stepCounter

Constructor Detail

OperatorChain

public OperatorChain(OperatorDescription description)

Creates an empty operator chain.

Method Detail

getMaxNumberOfInnerOperators

public abstract int getMaxNumberOfInnerOperators()

Returns the maximum number of innner operators.

getMinNumberOfInnerOperators

public abstract int getMinNumberOfInnerOperators()

Returns the minimum number of innner operators.

getInnerOperatorCondition

public abstract InnerOperatorCondition getInnerOperatorCondition()

Must return a condition of the IO behaviour of all desired inner operators. If there are no "special" conditions and the chain works similar to a simple operator chain this method should at least return a SimpleChainInnerOperatorCondition. More than one condition should be combined with help of the class CombinedInnerOperatorCondition.

getNumberOfSteps

public abstract int getNumberOfSteps()

Returns the number of steps performed by this chain.

Overrides:

getNumberOfSteps in class Operator

addAddListener

public void addAddListener(AddListener listener)

Adds the given listener.

removeAddListener

public void removeAddListener(AddListener listener)

Removes the given listener.

fireAddEvent

private void fireAddEvent(Operator child)

Notifies all added add listeners that a new child was added.

cloneOperator

public Operator cloneOperator(java.lang.String name)

Performs a deep clone of this operator chain. Use this method only if you are sure what you are doing.

Overrides:

cloneOperator in class Operator

setExperiment

public void setExperiment(Experiment experiment)

Sets the experiment for this operator chain and for all children.

Overrides:

setExperiment in class Operator

checkIO

public final java.lang.Class[] checkIO(java.lang.Class[] input)
                                throws IllegalInputException,
                                       WrongNumberOfInnerOperatorsException

This method checks if inner operators can handle their input and deliver the necessary output. Depending on the return value of the method shouldReturnInnerOutput() this method returns

• the result of getDeliveredOutputClasses() if the output of the inner operators should not be returned.
• the result of getAllOutputClasses(Class[] innerOutput) if the output of the inner operators (innerOutput) should also be returned.

Overrides:

checkIO in class Operator

Throws:

IllegalInputException

WrongNumberOfInnerOperatorsException

shouldReturnInnerOutput

public boolean shouldReturnInnerOutput()

Indicates if inner output should be delivered by this operator chain. Default is false. Operators which want to change this default behaviour should override this method and should return true. In this case the method checkIO would not longer return the result of Operator.getDeliveredOutputClasses() but of getAllOutputClasses(Class[]).

getAllOutputClasses

private java.lang.Class[] getAllOutputClasses(java.lang.Class[] innerOutput)

Helper method if in addition to the created output the inner output should also be returned. Can be used in checkIO(Class[] input).

addOperator

public int addOperator(Operator o)

Adds a new inner operator at the last position. The returned index is the position of the added operator with respect to all operators (including the disabled operators).

addOperator

public void addOperator(Operator operator,
                        int index)

Adds the given operator at the given position. Please note that all operators (including the disabled operators) are used for position calculations.

removeOperator

public void removeOperator(Operator operator)

Removes the given operator from this operator chain.

getOperator

public Operator getOperator(int i)

Returns the i-th inner operator.

getOperators

public java.util.Iterator<Operator> getOperators()

Returns an iterator over all Operators.

getAllInnerOperators

public java.util.List<Operator> getAllInnerOperators()

Returns recursively all child operators independently if they are activated or not.

getNumberOfOperators

public int getNumberOfOperators()

Returns the number of all enabled inner operators.

getNumberOfAllOperators

public int getNumberOfAllOperators()

Returns the number of all inner operators (including the disabled operators). Mainly used for GUI purposes. Operators should use getNumberOfOperators().

getOperatorFromAll

public Operator getOperatorFromAll(int i)

Returns the i-th operator. In contrast to the method getOperator(int i) this method also uses disabled operators. Mainly used for GUI purposes. Other operators should use the method getOperator(int i) which only delivers enabled inner operators.

getIndexOfOperator

public int getIndexOfOperator(Operator operator,
                              boolean useDeselected)

getInnerOperatorForName

public Operator getInnerOperatorForName(java.lang.String name)

Returns the inner operator named name or null if no such operator exists.

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: Operator

Sets the activation mode. Inactive operators do not perform their action.

Overrides:

setEnabled in class Operator

isEnabled

public boolean isEnabled()

Description copied from class: Operator

Returns true if this operator is enabled.

Overrides:

isEnabled in class Operator

experimentStarts

public void experimentStarts()

Description copied from class: Operator

Called when the experiment starts. Resets all counters.

Overrides:

experimentStarts in class Operator

experimentFinished

public void experimentFinished()

Description copied from class: Operator

Called at the end of the experiment. The default implementation does nothing.

Overrides:

experimentFinished in class Operator

apply

public IOObject[] apply()
                 throws OperatorException

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 clearStepCounter().

Specified by:

apply in class Operator

Returns:

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

Throws:

OperatorException

performAdditionalChecks

public void performAdditionalChecks()
                             throws UserError

This method invokes the additional check method for each child. Subclasses which override this method to perform a check should also invoke super.performAdditionalChecks()!

Overrides:

performAdditionalChecks in class Operator

Throws:

UserError

checkProperties

public int checkProperties()

Will throw an exception if a non optional property has no default value and is not defined by user.

Overrides:

checkProperties in class Operator

checkDeprecations

public int checkDeprecations()

Will count an the number of deprecated operators, i.e. the operators which Operator.getDeprecationInfo() method does not return null. Returns the total number of deprecations.

Overrides:

checkDeprecations in class Operator

checkNumberOfInnerOperators

public int checkNumberOfInnerOperators()

Checks if the number of inner operators lies between MinInnerOps and MaxInnerOps. Performs the check for all operator chains which are children of this operator chain.

createExperimentTree

protected java.lang.String createExperimentTree(int indent,
                                                java.lang.String selfPrefix,
                                                java.lang.String childPrefix,
                                                Operator markOperator,
                                                java.lang.String mark)

Returns this OperatorChain's name and class and the ExperimentTrees of the inner operators.

Overrides:

createExperimentTree in class Operator

getInnerOperatorsXML

protected final java.lang.String getInnerOperatorsXML(java.lang.String indent)

Description copied from class: Operator

Writes the XML representation of the inner operators. Since an Operator does not have any inner operators, the default implementation does nothing. Implemented by OperatorChain.

Overrides:

getInnerOperatorsXML in class Operator

delete

public void delete()

Description copied from class: Operator

Deletes this operator removing it from the name map.

Overrides:

delete in class Operator

clearErrorList

public void clearErrorList()

Description copied from class: Operator

Clears the list of errors.

Overrides:

clearErrorList in class Operator

See Also:

Operator.addError(String)

getNumberOfChildrensSteps

public int getNumberOfChildrensSteps()

countStep

public void countStep()

getCurrentStep

public int getCurrentStep()

clearStepCounter

public void clearStepCounter()

Necessary to call at the begin of an overloaded apply(IOContainer).

Introduced because otherwise a overloading of apply(IOContainer) cannot reset the step counter.