com.rapidminer.operator.meta
Class FeatureIterator

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class FeatureIterator
extends OperatorChain

This operator takes an input data set and applies its inner operators as often as the number of features of the input data is. Inner operators can access the current feature name by a macro, whose name can be specified via the parameter iteration_macro.

The user can specify with a parameter if this loop should iterate over all features or only over features with a specific value type, i.e. only over numerical or over nominal features. A regular expression can also be specified which is used as a filter, i.e. the inner operators are only applied for feature names fulfilling the filter expression.

Author:

Ingo Mierswa, Tobias Malbrecht

Field Summary

static java.lang.String	DEFAULT_ITERATION_MACRO_NAME
static java.lang.String	PARAMETER_FILTER
static java.lang.String	PARAMETER_INVERT_SELECTION
static java.lang.String	PARAMETER_ITERATION_MACRO
static java.lang.String	PARAMETER_TYPE_FILTER
static java.lang.String	PARAMETER_WORK_ON_INPUT
static java.lang.String	PARAMETER_WORK_ON_SPECIAL
static int	TYPE_FILTER_NOMINAL
static int	TYPE_FILTER_NONE
static int	TYPE_FILTER_NUMERICAL
static java.lang.String[]	TYPE_FILTERS

Constructor Summary

FeatureIterator(OperatorDescription description)

Method Summary

IOObject[]	apply() Applies all inner operators.
InnerOperatorCondition	getInnerOperatorCondition() Must return a condition of the IO behaviour of all desired inner operators.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
int	getMaxNumberOfInnerOperators() Returns the maximum number of inner operators.
int	getMinNumberOfInnerOperators() Returns the minimum number of inner operators.
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 com.rapidminer.operator.OperatorChain

addAddListener, addOperator, addOperator, checkDeprecations, checkIO, checkNumberOfInnerOperators, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createProcessTree, getAllInnerOperators, getIndexOfOperator, getInnerOperatorForName, getInnerOperatorsXML, getNumberOfAllOperators, getNumberOfOperators, getOperator, getOperatorFromAll, getOperators, performAdditionalChecks, processFinished, processStarts, registerOperator, removeAddListener, removeOperator, shouldAddNonConsumedInput, 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, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, 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_FILTER

public static final java.lang.String PARAMETER_FILTER

See Also:

Constant Field Values

PARAMETER_TYPE_FILTER

public static final java.lang.String PARAMETER_TYPE_FILTER

See Also:

Constant Field Values

PARAMETER_WORK_ON_SPECIAL

public static final java.lang.String PARAMETER_WORK_ON_SPECIAL

See Also:

Constant Field Values

PARAMETER_INVERT_SELECTION

public static final java.lang.String PARAMETER_INVERT_SELECTION

See Also:

Constant Field Values

PARAMETER_ITERATION_MACRO

public static final java.lang.String PARAMETER_ITERATION_MACRO

See Also:

Constant Field Values

TYPE_FILTERS

public static final java.lang.String[] TYPE_FILTERS

TYPE_FILTER_NONE

public static final int TYPE_FILTER_NONE

See Also:

Constant Field Values

TYPE_FILTER_NOMINAL

public static final int TYPE_FILTER_NOMINAL

See Also:

Constant Field Values

TYPE_FILTER_NUMERICAL

public static final int TYPE_FILTER_NUMERICAL

See Also:

Constant Field Values

DEFAULT_ITERATION_MACRO_NAME

public static final java.lang.String DEFAULT_ITERATION_MACRO_NAME

See Also:

Constant Field Values

PARAMETER_WORK_ON_INPUT

public static final java.lang.String PARAMETER_WORK_ON_INPUT

See Also:

Constant Field Values

Constructor Detail

FeatureIterator

public FeatureIterator(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

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.

Overrides:

apply in class OperatorChain

Returns:

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

Throws:

OperatorException

getInnerOperatorCondition

public InnerOperatorCondition getInnerOperatorCondition()

Description copied from class: OperatorChain

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.

Specified by:

getInnerOperatorCondition in class OperatorChain

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Description copied from class: OperatorChain

Returns the maximum number of inner operators.

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Description copied from class: OperatorChain

Returns the minimum number of inner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

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 objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). 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 (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

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.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator