com.rapidminer.operator.meta
Class ParameterIteratingOperatorChain

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.OperatorChain
          com.rapidminer.operator.meta.ParameterIteratingOperatorChain

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

Direct Known Subclasses:

ParameterIteration, ParameterOptimizationOperator

public abstract class ParameterIteratingOperatorChain
extends OperatorChain

Provides an operator chain which operates on given parameters depending on specified values for these parameters.

Author:

Tobias Malbrecht

Field Summary

static java.lang.String	PARAMETER_PARAMETERS The parameter name for "Parameters to optimize in the format OPERATORNAME.PARAMETERNAME.
static java.lang.String	PARAMETER_VALUES A specification of the parameter values for a parameter.
static int	VALUE_MODE_CONTINUOUS Means that the parameter iteration scheme can only handle intervals of numerical values.
static int	VALUE_MODE_DISCRETE Means that the parameter iteration scheme can only handle discrete parameter values (i.e. lists or numerical grids).

Constructor Summary

ParameterIteratingOperatorChain(OperatorDescription description)

Method Summary

int	getMaxNumberOfInnerOperators() Returns the highest possible value for the maximum number of inner operators.
int	getMinNumberOfInnerOperators() Returns 1 for the minimum number of inner operators.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
abstract int	getParameterValueMode() Has to return one of the predefined modes which indicate whether the operator takes discrete values or intervals as basis for optimization.
java.util.List<ParameterValues>	parseParameterValues(java.util.List<java.lang.String[]> parameterList) Parses a parameter list and creates the corresponding data structures.
boolean	shouldAddNonConsumedInput()

Methods inherited from class com.rapidminer.operator.OperatorChain

addAddListener, addOperator, addOperator, apply, checkDeprecations, checkIO, checkNumberOfInnerOperators, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createProcessTree, getAllInnerOperators, getIndexOfOperator, getInnerOperatorCondition, getInnerOperatorForName, getInnerOperatorsXML, getNumberOfAllOperators, getNumberOfOperators, getOperator, getOperatorFromAll, getOperators, performAdditionalChecks, processFinished, processStarts, registerOperator, removeAddListener, removeOperator, shouldReturnInnerOutput, unregisterOperator

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkForStop, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInput, getInput, getInput, getInputClasses, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getOutputClasses, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, register, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, 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

PARAMETER_PARAMETERS

public static final java.lang.String PARAMETER_PARAMETERS

The parameter name for "Parameters to optimize in the format OPERATORNAME.PARAMETERNAME."

See Also:

Constant Field Values

PARAMETER_VALUES

public static final java.lang.String PARAMETER_VALUES

A specification of the parameter values for a parameter."

See Also:

Constant Field Values

VALUE_MODE_DISCRETE

public static final int VALUE_MODE_DISCRETE

Means that the parameter iteration scheme can only handle discrete parameter values (i.e. lists or numerical grids).

See Also:

Constant Field Values

VALUE_MODE_CONTINUOUS

public static final int VALUE_MODE_CONTINUOUS

Means that the parameter iteration scheme can only handle intervals of numerical values.

See Also:

Constant Field Values

Constructor Detail

ParameterIteratingOperatorChain

public ParameterIteratingOperatorChain(OperatorDescription description)

Method Detail

getParameterValueMode

public abstract int getParameterValueMode()

Has to return one of the predefined modes which indicate whether the operator takes discrete values or intervals as basis for optimization. The first option is to be taken for all strategies that iterate over the given parameters. The latter option is to be taken for strategies such as an evolutionary one in which allowed ranges of parameters have to be specified.

parseParameterValues

public java.util.List<ParameterValues> parseParameterValues(java.util.List<java.lang.String[]> parameterList)
                                                     throws OperatorException

Parses a parameter list and creates the corresponding data structures.

Throws:

OperatorException

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

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

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Returns 1 for the minimum number of inner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

shouldAddNonConsumedInput

public boolean shouldAddNonConsumedInput()

Overrides:

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

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator