edu.udo.cs.yale.operator
Class Operator

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

All Implemented Interfaces:

ConfigurationListener

Direct Known Subclasses:

AbsoluteSampling, AbstractLearner, AbstractWekaExampleSource, ArffExampleSetWriter, Attribute2RealValueMapping, AttributeCounter, AttributeSetLoader, AttributeSetWriter, AttributeValueMapper, AttributeWeightsApplier, AttributeWeightsCreator, AttributeWeightSelection, AttributeWeightsLoader, AttributeWeightsWriter, AverageBuilder, C45ExampleSource, CFSFeatureSetEvaluator, ChangeAttributeName, ChangeAttributeType, CommandLineOperator, CompleteFeatureGenerationOperator, ComponentWeights, ConsistencyFeatureSetEvaluator, CorpusBasedFeatureWeighting, CorrelationMatrixOperator, DataStatisticsOperator, Deobfuscator, Discretization, ExampleFilter, ExampleSetGenerator, ExampleSetJoin, ExampleSetWriter, ExampleSource, ExampleVisualizationOperator, ExcelExampleSource, ExperimentEmbeddingOperator, ExperimentLogOperator, FastICA, FeatureFilter, FeatureGenerationOperator, FeatureRangeRemoval, FourierTransform, FrequencyDiscretizer, FunctionValueSeries, GenericWekaAssociationLearner, GenericWekaAttributeWeighting, GHA, GNUPlotOperator, HyperplaneProjection, IdTagging, InteractiveAttributeWeighting, IOConsumeOperator, IOContainerReader, IOContainerWriter, IOMultiplyOperator, IOObjectReader, IOObjectWriter, LiftChartGenerator, MacroDefinitionOperator, MassiveDataGenerator, MergeNominalValues, MinMaxWrapper, ModelApplier, ModelBasedSampling, ModelLoader, ModelWriter, MultipleLabelGenerator, NoiseOperator, NominalExampleSetGenerator, NominalToBinary, NumericToBinary, Obfuscator, OperatorChain, ParameterCloner, ParameterSetLoader, ParameterSetter, ParameterSetWriter, PCA, PerformanceEvaluator, PerformanceLoader, PerformanceWriter, PermutationOperator, PlattScaling, PreprocessingOperator, PrincipalComponentsTransformation, RemoveCorrelatedFeatures, RemoveUselessFeatures, RenameAttributeOperator, ResultSetExampleSource, ResultWriter, ROCChartGenerator, Series2WindowExamples, SignificanceTestOperator, SimpleExampleSource, SimpleSampling, SingleAttributes2ValueSeries, SOMDimensionalityReduction, SparseFormatExampleSource, SplitSVMModel, SPSSExampleSource, StandardDeviationWeighting, StratifiedSampling, TFIDFFilter, ThresholdApplier, ThresholdCreator, ThresholdFinder, ThresholdLoader, ThresholdWriter, ValueReplenishment, WeightedPerformanceCreator

public abstract class Operator
extends java.lang.Object
implements ConfigurationListener

An operator accepts an array of input objects and generates an array of output objects that can be processed by other operators. Both must implement the IOObject interface. This is the superclass which must be extended by all Yale operators. Please refer to the YALE tutorial for a detailed description how to implement your operator.

As default, operators consume their input by using it. This is often a useful behavior especially in complex experiments. For example, a learning operator consumes an example set to produce a model and so does a cross validation to produce a performance value of the learning method. To receive the input IOObject of a certain class simply use getInput(Class class). This method delivers the first object of the desired class which is in the input of this operator. The delivered object is consumed afterwards and thus is removed from input. If the operator alters this object, it should return the altered object as output again. Therefore, you have to add the object to the output array which is delivered by the apply() method of the operator. You also have to declare it in getOutputClasses(). All input objects which are not used by your operator will be automatically passed to the next operators.

In some cases it would be useful if the user can define if the input object should be consumed or not. For example, a validation chain like cross validation should estimate the performance but should also be able to return the example set which is then used to learn the overall model. Operators can change the default behavior for input consumation and a parameter will be automatically defined and queried. The default behavior is defined in the method getInputDescription(Class cls) and should be overriden in these cases. Please note that input objects with a changed input description must not be defined in getOutputClasses() and must not be returned at the end of apply. Both is automatically done with respect to the value of the automatically created parameter. Please refer to the Javadoc comments of this method for further explanations.

Version:

$Id: Operator.java,v 2.94 2006/10/02 22:35:50 ingomierswa Exp $

Author:

Ralf Klinkenberg, Ingo Mierswa, Simon Fischer

See Also:

OperatorChain

Field Summary

private int	applyCount Number of times the operator was applied.
private boolean[]	breakPoint Indicates if before / within / after this operator a breakpoint is set.
private java.lang.Thread	breakpointThread The thread which runs this operator.
private boolean	enabled Indicates if this operator is enabled.
private java.util.List<java.lang.String>	errorList The list which stores the errors of this operator (parameter not set, wrong children number, wrong IO).
private Experiment	experiment The experiment the operator belongs to.
private IOContainer	inputContainer Its input as set by the apply method.
private long	loopStartTime System time when the current loop of execution started.
private java.lang.String	name Name of the operators (for logging).
private OperatorDescription	operatorDescription The operator description of this operator (icon, classname, description, ...).
private Parameters	parameters Parameters for this Operator.
private OperatorChain	parent Its parent, if part of an operator chain.
private long	startTime System time when execution started.
private java.lang.String	userDescription A user defined description for this operator instance.
private java.util.Map<java.lang.String,Value>	valueMap The values for this operator.

Constructor Summary

Operator(OperatorDescription description)
Creates an unnamed operator.

Method Summary

void	addError(java.lang.String message) Adds an error message.
void	addValue(Value value) Adds an implementation of Value.
void	addWarning(java.lang.String message) Adds a warning message to the error list.
abstract IOObject[]	apply() Implement this method in subclasses.
IOContainer	apply(IOContainer input) Applies the operator.
int	checkDeprecations() Will count an the number of deprecated operators, i.e. the operators which getDeprecationInfo() method does not return null.
java.lang.Class[]	checkIO(java.lang.Class[] input) Subclasses will throw an exception if something isn't ok.
int	checkProperties() Will count an error if a non optional property has no default value and is not defined by user.
void	clearErrorList() Clears the list of errors.
Operator	cloneOperator(java.lang.String name) Performs a deep clone on the most parts of this operator.
private static java.lang.String	createDescriptionFromXML(org.w3c.dom.Element element)
java.lang.String	createExperimentTree(int indent) Returns this operator's name and class.
protected java.lang.String	createExperimentTree(int indent, java.lang.String selfPrefix, java.lang.String childPrefix, Operator markOperator, java.lang.String mark) Returns this operator's name and class.
static Operator	createFromXML(org.w3c.dom.Element element, Experiment experiment)
java.lang.String	createMarkedExperimentTree(int indent, java.lang.String mark, Operator markOperator) Returns this operator's name and class.
private static java.lang.Object[]	createParameterFromXML(org.w3c.dom.Element element)
private static java.lang.Object[]	createParameterListFromXML(org.w3c.dom.Element element)
protected void	delete() Deletes this operator removing it from the name map.
private java.lang.String	expandString(java.lang.String str) Replaces %n with the name of this operator %c with the class of this operator %a with the number of times the operator was applied %b with the number of times the operator was applied plus one (a shortcut for %p[1]) %p[number] with the number of times the operator was applied plus number %t with the system time %% with % Returns null if str is null.
void	experimentFinished() Called at the end of the experiment.
void	experimentStarts() Called when the experiment starts.
boolean	getAddOnlyAdditionalOutput() Indicates how additional output should be added to the IOContainer.
int	getApplyCount() Returns the number of times this operator was already applied.
java.lang.Class[]	getDeliveredOutputClasses() Returns the classes that are guaranteed to be returned by apply().
java.lang.String	getDeprecationInfo() Returns null if this operator is not deprecated.
java.lang.Class[]	getDesiredInputClasses() Returns the classes that are needed as input.
java.util.List	getErrorList() Returns a List of Strings containing error messages.
Experiment	getExperiment() Returns the experiment of this operator.
protected java.lang.String	getInnerOperatorsXML(java.lang.String indent) Writes the XML representation of the inner operators.
IOContainer	getInput() Returns the complete input.
protected <T extends IOObject> T	getInput(java.lang.Class<T> cls) Returns an IOObject of class cls.
protected <T extends IOObject> T	getInput(java.lang.Class<T> cls, int nr) Returns the nr-th IOObject of class cls.
abstract java.lang.Class[]	getInputClasses() Returns the classes that are needed as input.
InputDescription	getInputDescription(java.lang.Class inputClass) The default implementation returns an input description that consumes the input IOObject without a user parameter.
protected IOContainer	getIOContainerForInApplyLoopBreakpoint() Returns the intermediate results of an in-apply-loop which will be displayed in case of a BreakpointListener.BREAKPOINT_WITHIN.
private IODescription	getIODescription() If you find the getInputClasses() and getOuputClasses() methods for some reason not useful, you may override this method.
java.lang.String	getName() Returns the name of the operator.
int	getNumberOfSteps() Returns the number of steps (e.g. loops) the operator performs, e.g. 10 for a tenfold cross validation.
java.lang.String	getOperatorClassName() Returns the "class name" of this operator from the operator description of the operator.
OperatorDescription	getOperatorDescription() Returns the operator description of this operator.
abstract java.lang.Class[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.lang.Object	getParameter(java.lang.String key) Returns a single parameter retrieved from the Parameters of this Operator.
boolean	getParameterAsBoolean(java.lang.String key) Returns a single named parameter and casts it to boolean.
java.awt.Color	getParameterAsColor(java.lang.String key) Returns a single named parameter and casts it to Color.
double	getParameterAsDouble(java.lang.String key) Returns a single named parameter and casts it to double.
java.io.File	getParameterAsFile(java.lang.String key) Returns a single named parameter and casts it to File.
int	getParameterAsInt(java.lang.String key) Returns a single named parameter and casts it to int.
java.lang.String	getParameterAsString(java.lang.String key) Returns a single named parameter and casts it to String.
java.util.List	getParameterList(java.lang.String key) Returns a single named parameter and casts it to List.
Parameters	getParameters() Returns a collection of all parameters of this operator.
ParameterType	getParameterType(java.lang.String name) Returns the parameter type with the given name.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
OperatorChain	getParent() Returns the parent of this operator which must be an operator chain.
long	getStartTime() Returns the system time when the operator was started.
java.lang.String	getStatus() Returns human readable status information.
java.lang.String	getUserDescription() The user specified comment for this operator.
double	getValue(java.lang.String key) Returns the value of the Value with the given key.
java.util.Collection<Value>	getValues() Returns all Values sorted by key.
java.lang.String	getXML(java.lang.String indent) Returns the XML representation of this operator.
private IOContainer	handleAdditionalOutput(IOContainer container, IOObject[] additional) The method appends the given additional IOObjects to the container.
boolean	hasBreakpoint() Returns true iff this operator has a breakpoint at any possible position.
boolean	hasBreakpoint(int position) Returns true iff a breakpoint is set at the given position
protected boolean	hasInput(java.lang.Class<? extends IOObject> cls) Returns true if this operator has an input object of the desired class.
void	inApplyLoop() Should be called if this operator performs a loop (for the loop time resetting used for Value creation used by DataTables).
private java.lang.String	indent(int indent) Returns a whitespace with length indent.
boolean	isEnabled() Returns true if this operator is enabled.
boolean	isParameterSet(java.lang.String key) Returns true iff the parameter with the given name is set.
void	logMessage(java.lang.String message, int verbosityLevel) Convenience method for logging a message prefixed by the operator name.
void	performAdditionalChecks() This method is invoked during the validation checks.
private void	processBreakpoint(IOContainer container, int breakpointType)
void	register(Experiment experiment, java.lang.String name) Registers this operator in an experiment.
void	remove() Removes this operator from its parent.
void	rename(java.lang.String name) Renames this operator updating the name map.
private java.lang.String	replaceMacros(java.lang.String value) Replaces existing macros in the given value string by the macro values defined for the experiment.
void	resume() This method should only be called by the command line breakpoint listener to resume the experiment after a breakpoint.
void	setBreakpoint(int position, boolean on) Sets or clears a breakpoint at the given position.
void	setEnabled(boolean enabled) Sets the activation mode.
protected void	setExperiment(Experiment experiment) Sets the experiment of this operator.
protected void	setInput(IOContainer input) ATTENTION: Use this method only if you are ABSOLUTELY sure what you are doing!
void	setListParameter(java.lang.String key, java.util.List list) Sets the given parameter list to the Parameters object of this operator.
private void	setName(java.lang.String name) Sets the name of the operator.
void	setOperatorParameters(org.w3c.dom.Element element) Sets all parameters of this operator (including inner operators and their parameters).
void	setParameter(java.lang.String key, java.lang.String value) Sets the given single parameter to the Parameters object of this operator.
void	setParameters(Parameters parameters) Sets all parameters of this operator.
void	setParent(OperatorChain parent) Sets the enclosing operator chain.
void	setUserDescription(java.lang.String description) Sets the user specified comment for this operator.
private void	stop()
java.lang.String	toString() Returns the name.
void	writeXML(java.io.PrintWriter out, java.lang.String indent) Writes the XML representation of this operator.

Methods inherited from class java.lang.Object

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

Field Detail

breakPoint

private boolean[] breakPoint

Indicates if before / within / after this operator a breakpoint is set.

breakpointThread

private java.lang.Thread breakpointThread

The thread which runs this operator. Must be notified when the experiment is resumed.

enabled

private boolean enabled

Indicates if this operator is enabled.

name

private java.lang.String name

Name of the operators (for logging).

userDescription

private java.lang.String userDescription

A user defined description for this operator instance. Will be filled from comments in the XML files.

experiment

private Experiment experiment

The experiment the operator belongs to.

parent

private OperatorChain parent

Its parent, if part of an operator chain.

inputContainer

private IOContainer inputContainer

Its input as set by the apply method.

applyCount

private int applyCount

Number of times the operator was applied.

startTime

private long startTime

System time when execution started.

loopStartTime

private long loopStartTime

System time when the current loop of execution started.

parameters

private Parameters parameters

Parameters for this Operator.

valueMap

private java.util.Map<java.lang.String,Value> valueMap

The values for this operator. The current value of a Value can be asked by the ExperimentLogOperator.

errorList

private java.util.List<java.lang.String> errorList

The list which stores the errors of this operator (parameter not set, wrong children number, wrong IO).

operatorDescription

private OperatorDescription operatorDescription

The operator description of this operator (icon, classname, description, ...).

Constructor Detail

Operator

public Operator(OperatorDescription description)

Creates an unnamed operator. This operator must be registered in an experiment by using the method register(Experiment, String). Subclasses must pass the given description object to this super-constructor (i.e. invoking super(OperatorDescription)). They might also add additional values for experiment logging.

NOTE: the preferred way for operator creation is using one of the factory methods of OperatorService.

Method Detail

getOperatorDescription

public final OperatorDescription getOperatorDescription()

Returns the operator description of this operator.

getOperatorClassName

public final java.lang.String getOperatorClassName()

Returns the "class name" of this operator from the operator description of the operator. This is the name which is defined in the operator.xml file.

register

public final void register(Experiment experiment,
                           java.lang.String name)

Registers this operator in an experiment. This sets the experiment and the name of the operator and must be invoked before the operator is applied.

getExperiment

public final Experiment getExperiment()

Returns the experiment of this operator. Each operator must be part of an experiment.

setExperiment

protected void setExperiment(Experiment experiment)

Sets the experiment of this operator.

setName

private void setName(java.lang.String name)

Sets the name of the operator.

getName

public java.lang.String getName()

Returns the name of the operator.

rename

public final void rename(java.lang.String name)

Renames this operator updating the name map.

setUserDescription

public void setUserDescription(java.lang.String description)

Sets the user specified comment for this operator.

getUserDescription

public java.lang.String getUserDescription()

The user specified comment for this operator.

getDeprecationInfo

public final java.lang.String getDeprecationInfo()

Returns null if this operator is not deprecated. This implementation returns the return value of OperatorDescription.getDeprecationInfo() which is usually null. If a non-null value is returned this should describe a a workaround for a user. In this case the workaround is displayed during the validation of experiments and in the experiment info dialog.

setParent

public final void setParent(OperatorChain parent)

Sets the enclosing operator chain.

getParent

public final OperatorChain getParent()

Returns the parent of this operator which must be an operator chain.

remove

public void remove()

Removes this operator from its parent.

delete

protected void delete()

Deletes this operator removing it from the name map.

setEnabled

public void setEnabled(boolean enabled)

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

isEnabled

public boolean isEnabled()

Returns true if this operator is enabled.

getStatus

public java.lang.String getStatus()

Returns human readable status information.

getApplyCount

public int getApplyCount()

Returns the number of times this operator was already applied.

cloneOperator

public Operator cloneOperator(java.lang.String name)

Performs a deep clone on the most parts of this operator. The experiment, the in- and output containers and the error list are only cloned by reference copying. Use this method only if you are sure what you are doing.

apply

public abstract IOObject[] apply()
                          throws OperatorException

Implement this method in subclasses.

Throws:

OperatorException

getInputClasses

public abstract java.lang.Class[] getInputClasses()

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 getOutputClasses() and apply() if this is necessary. This default behavior can be changed by overriding 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.

getOutputClasses

public abstract java.lang.Class[] getOutputClasses()

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

getDesiredInputClasses

public final java.lang.Class[] getDesiredInputClasses()

Returns the classes that are needed as input. Returns the result of getInputClasses().

getDeliveredOutputClasses

public final java.lang.Class[] getDeliveredOutputClasses()

Returns the classes that are guaranteed to be returned by apply(). These are all input classes which are not consumed and all guranteed additional output classes.

getInputDescription

public InputDescription getInputDescription(java.lang.Class inputClass)

The default implementation returns an input description that consumes the input IOObject without a user parameter. Subclasses may override this method to allow other input handling behaviors.

getNumberOfSteps

public int getNumberOfSteps()

Returns the number of steps (e.g. loops) the operator performs, e.g. 10 for a tenfold cross validation. The default implementation returns 1. If an operator can not estimate the number of times it is applied, it should return 1.

getIODescription

private IODescription getIODescription()

If you find the getInputClasses() and getOuputClasses() methods for some reason not useful, you may override this method. Otherwise it returns a default IODescription containing the classes returned by the first.

checkIO

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

Subclasses will throw an exception if something isn't ok. Returns the output that this operator returns when provided with the given input.

Throws:

IllegalInputException

WrongNumberOfInnerOperatorsException

performAdditionalChecks

public void performAdditionalChecks()
                             throws UserError

This method is invoked during the validation checks. It is invoked as a last check. The default implementation does nothing. Subclasses might want to override this method to perform some specialized checks, e.g. if an inner operator is of a specific class.

Throws:

UserError

checkProperties

public int checkProperties()

Will count an error if a non optional property has no default value and is not defined by user. Returns the total number of errors.

checkDeprecations

public int checkDeprecations()

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

stop

private void stop()
           throws ExperimentStoppedException

Throws:

ExperimentStoppedException

apply

public final IOContainer apply(IOContainer input)
                        throws OperatorException

Applies the operator. Don't override this method, but apply().

Returns:

An IOContainer containing all IOObjects returned by apply() plus the unused IOObjects of input, i.e. those IOObjects that were not returned by one of input.getInput(Class) or input.getInput(Class, int).

Throws:

OperatorException

resume

public final void resume()

This method should only be called by the command line breakpoint listener to resume the experiment after a breakpoint.

processBreakpoint

private void processBreakpoint(IOContainer container,
                               int breakpointType)
                        throws ExperimentStoppedException

Throws:

ExperimentStoppedException

handleAdditionalOutput

private final IOContainer handleAdditionalOutput(IOContainer container,
                                                 IOObject[] additional)

The method appends the given additional IOObjects to the container. If one of the new objects is a model this method tries to add the model into an existing model. If such a model exists a ContainerModel might be added to embed both models. If the existing model already is a ContainerModel the new model is simply added. Attention: This method depends on the result of the method getAddOnlyAdditionalOutput() in order to decide if simply a new IOContainer should be created from the additional output objects or if these objects should be added to the given container (default).

getAddOnlyAdditionalOutput

public boolean getAddOnlyAdditionalOutput()

Indicates how additional output should be added to the IOContainer. Usually the additional output should be preprended to the input container but some operators, especially operator chains might override this method in order add only the additional output instead of the complete IOContainer. This prevents doubling the IOObjects e.g. for SimpleOperatorChains. The default implementation returns false.

getInput

protected <T extends IOObject> T getInput(java.lang.Class<T> cls)
                               throws MissingIOObjectException

Returns an IOObject of class cls. The object is removed from the input IOContainer if the input description defines this behavior (default).

Throws:

MissingIOObjectException

getInput

protected <T extends IOObject> T getInput(java.lang.Class<T> cls,
                                          int nr)
                               throws MissingIOObjectException

Returns the nr-th IOObject of class cls. The object is removed from the input IOContainer if the input description defines this behavior (default).

Throws:

MissingIOObjectException

hasInput

protected boolean hasInput(java.lang.Class<? extends IOObject> cls)

Returns true if this operator has an input object of the desired class. The object will not be removed by using this method.

getInput

public IOContainer getInput()

Returns the complete input. Operators should usually not directly use this method but should use getInput(Class). However, some operator chains must handle their inner input and have to use the IOContainer directly.

setInput

protected void setInput(IOContainer input)

ATTENTION: Use this method only if you are ABSOLUTELY sure what you are doing! This method might be useful for some meta optimization operators but wrong usage can cause serious errors.

experimentStarts

public void experimentStarts()

Called when the experiment starts. Resets all counters.

experimentFinished

public void experimentFinished()

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

setBreakpoint

public void setBreakpoint(int position,
                          boolean on)

Sets or clears a breakpoint at the given position.

Parameters:

position - One out of BREAKPOINT_BEFORE and BREAKPOINT_AFTER

hasBreakpoint

public boolean hasBreakpoint()

Returns true iff this operator has a breakpoint at any possible position.

hasBreakpoint

public boolean hasBreakpoint(int position)

Returns true iff a breakpoint is set at the given position

Parameters:

position - One out of BREAKPOINT_BEFORE and BREAKPOINT_AFTER

inApplyLoop

public void inApplyLoop()
                 throws ExperimentStoppedException

Should be called if this operator performs a loop (for the loop time resetting used for Value creation used by DataTables). Also allows for intermediate results delivered by getIOContainerForInApplyLoopBreakpoint() in case of a BreakpointListener.BREAKPOINT_WITHIN. Subclasses should invoke this method in case of a loop in their method apply().

Throws:

ExperimentStoppedException

getIOContainerForInApplyLoopBreakpoint

protected IOContainer getIOContainerForInApplyLoopBreakpoint()

Returns the intermediate results of an in-apply-loop which will be displayed in case of a BreakpointListener.BREAKPOINT_WITHIN.

addValue

public void addValue(Value value)

Adds an implementation of Value.

getValue

public final double getValue(java.lang.String key)

Returns the value of the Value with the given key.

getValues

public java.util.Collection<Value> getValues()

Returns all Values sorted by key.

getParameters

public Parameters getParameters()

Returns a collection of all parameters of this operator.

Specified by:

getParameters in interface ConfigurationListener

setParameters

public void setParameters(Parameters parameters)

Sets all parameters of this operator. The given parameters are not allowed to be null and must correspond to the parameter types defined by this operator.

Specified by:

setParameters in interface ConfigurationListener

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Sets the given single parameter to the Parameters object of this operator. For parameter list the method setListParameter(String, List) should be used.

setListParameter

public void setListParameter(java.lang.String key,
                             java.util.List list)

Sets the given parameter list to the Parameters object of this operator. For single parameters the method setParameter(String, String) should be used.

getParameter

public java.lang.Object getParameter(java.lang.String key)
                              throws UndefinedParameterError

Returns a single parameter retrieved from the Parameters of this Operator.

Throws:

UndefinedParameterError

isParameterSet

public boolean isParameterSet(java.lang.String key)
                       throws UndefinedParameterError

Returns true iff the parameter with the given name is set.

Throws:

UndefinedParameterError

getParameterAsString

public java.lang.String getParameterAsString(java.lang.String key)
                                      throws UndefinedParameterError

Returns a single named parameter and casts it to String.

Throws:

UndefinedParameterError

getParameterAsInt

public int getParameterAsInt(java.lang.String key)
                      throws UndefinedParameterError

Returns a single named parameter and casts it to int.

Throws:

UndefinedParameterError

getParameterAsDouble

public double getParameterAsDouble(java.lang.String key)
                            throws UndefinedParameterError

Returns a single named parameter and casts it to double.

Throws:

UndefinedParameterError

getParameterAsBoolean

public boolean getParameterAsBoolean(java.lang.String key)

Returns a single named parameter and casts it to boolean. This method never throws an exception since there are no non-optional boolean parameters.

getParameterList

public java.util.List getParameterList(java.lang.String key)
                                throws UndefinedParameterError

Returns a single named parameter and casts it to List. The list returned by this method contains the user defined key-value pairs. Each element is an Object array of length 2. The first element is the key (String) the second the parameter value object, e.g. a Double object for ParameterTypeDouble. Since the definition of typed lists for arrays is not possible the caller have to perform the casts to the object arrays and from there to the actual types himself.

Throws:

UndefinedParameterError

getParameterAsColor

public java.awt.Color getParameterAsColor(java.lang.String key)
                                   throws UndefinedParameterError

Returns a single named parameter and casts it to Color.

Throws:

UndefinedParameterError

getParameterAsFile

public java.io.File getParameterAsFile(java.lang.String key)
                                throws UndefinedParameterError

Returns a single named parameter and casts it to File. This file is already resolved against the experiment. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Experiment.resolveFileName(String).

Throws:

UndefinedParameterError

expandString

private java.lang.String expandString(java.lang.String str)

Replaces

• %n with the name of this operator
• %c with the class of this operator
• %a with the number of times the operator was applied
• %b with the number of times the operator was applied plus one (a shortcut for %p[1])
• %p[number] with the number of times the operator was applied plus number
• %t with the system time
• %% with %

Returns null if str is null.

replaceMacros

private java.lang.String replaceMacros(java.lang.String value)

Replaces existing macros in the given value string by the macro values defined for the experiment. Please note that this is basically only supported for string type parameter values. This method replaces the predefined macros like %{experiment_name}, %{experiment_file}, and %{experiment_path} and tries to replace macros surrounded by "%{" and "}" with help of the MacroHandler of the Experiment. These macros might have been defined with help of a MacroDefinitionOperator. If any exception would be thrown it is catched and just the input string is returned. TODO: allow macros for numerical and other parameter types.

getParameterTypes

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

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.

getParameterType

public ParameterType getParameterType(java.lang.String name)

Returns the parameter type with the given name. Will return null if this operator does not have a parameter with the given name.

writeXML

public void writeXML(java.io.PrintWriter out,
                     java.lang.String indent)
              throws java.io.IOException

Writes the XML representation of this operator.

Throws:

java.io.IOException

getXML

public java.lang.String getXML(java.lang.String indent)

Returns the XML representation of this operator.

getInnerOperatorsXML

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

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.

createDescriptionFromXML

private static java.lang.String createDescriptionFromXML(org.w3c.dom.Element element)
                                                  throws XMLException

Throws:

XMLException

createParameterFromXML

private static java.lang.Object[] createParameterFromXML(org.w3c.dom.Element element)
                                                  throws XMLException

Throws:

XMLException

createParameterListFromXML

private static java.lang.Object[] createParameterListFromXML(org.w3c.dom.Element element)
                                                      throws XMLException

Throws:

XMLException

createFromXML

public static Operator createFromXML(org.w3c.dom.Element element,
                                     Experiment experiment)
                              throws XMLException

Throws:

XMLException

setOperatorParameters

public void setOperatorParameters(org.w3c.dom.Element element)
                           throws XMLException

Sets all parameters of this operator (including inner operators and their parameters).

Throws:

XMLException

clearErrorList

public void clearErrorList()

Clears the list of errors.

See Also:

addError(String)

addError

public void addError(java.lang.String message)

Adds an error message.

See Also:

getErrorList()

addWarning

public void addWarning(java.lang.String message)

Adds a warning message to the error list.

See Also:

getErrorList()

getErrorList

public java.util.List getErrorList()

Returns a List of Strings containing error messages.

See Also:

addError(String)

getStartTime

public long getStartTime()

Returns the system time when the operator was started.

logMessage

public void logMessage(java.lang.String message,
                       int verbosityLevel)

Convenience method for logging a message prefixed by the operator name.

See Also:

LogService

toString

public java.lang.String toString()

Returns the name.

Overrides:

toString in class java.lang.Object

createExperimentTree

public java.lang.String createExperimentTree(int indent)

Returns this operator's name and class.

createMarkedExperimentTree

public java.lang.String createMarkedExperimentTree(int indent,
                                                   java.lang.String mark,
                                                   Operator markOperator)

Returns this operator's name and class.

createExperimentTree

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

Returns this operator's name and class.

indent

private java.lang.String indent(int indent)

Returns a whitespace with length indent.