com.rapidminer.operator.meta
Class ValueSubgroupIteration

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class ValueSubgroupIteration
extends OperatorChain

In each iteration step, this meta operator applies its inner operators to a subset of the input example set. The subsets represent subgroups which are defined by the values of the specified attributes. If an attribute is specified which has 'male' or 'female' as possible values the first iteration subset will consist of all males, the second of all females, respectively. Please note that no attribute value combinations are supported and hence only subgroups defined by exactly one attribute are considered at a time.

A subset is build (and an inner operator application is executed) for each possible attribute value of the specified attributes if all is selected for the values parameter. If above p is selected, a subset is only build for that values which exhibit an occurance ratio of at least p. This may be helpful, if only large subgroups should be considered.

The parameter filter_attribute specifies, if the subgroup defining attribute should be filtered from the subsets.

The parameter apply_on_complete_set specifies, if the inner operators should be applied on the completed example set in addition to the subset iterations.

The current value of the loop can be accessed with the specified macro name.

Author:

Tobias Malbrecht

Field Summary

static java.lang.String	DEFAULT_ITERATION_MACRO_NAME
static java.lang.String	PARAMETER_APPLY_ON_COMPLETE_SET
static java.lang.String	PARAMETER_ATTRIBUTES
static java.lang.String	PARAMETER_FILTER_ATTRIBUTE
static java.lang.String	PARAMETER_ITERATION_MACRO
static java.lang.String	PARAMETER_P
static java.lang.String	PARAMETER_VALUES
static int	VALUE_OPTION_ABOVE_P
static int	VALUE_OPTION_ALL
static java.lang.String[]	VALUE_OPTIONS

Constructor Summary

ValueSubgroupIteration(OperatorDescription description)

Method Summary

IOObject[]	apply() Applies all inner operators.
InnerOperatorCondition	getInnerOperatorCondition() All inner operators must be able to handle an example set.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
int	getMaxNumberOfInnerOperators() Returns the maximum number of innner operators.
int	getMinNumberOfInnerOperators() Returns the minimum number of innner 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_ATTRIBUTES

public static final java.lang.String PARAMETER_ATTRIBUTES

See Also:

Constant Field Values

PARAMETER_VALUES

public static final java.lang.String PARAMETER_VALUES

See Also:

Constant Field Values

VALUE_OPTIONS

public static final java.lang.String[] VALUE_OPTIONS

VALUE_OPTION_ALL

public static final int VALUE_OPTION_ALL

See Also:

Constant Field Values

VALUE_OPTION_ABOVE_P

public static final int VALUE_OPTION_ABOVE_P

See Also:

Constant Field Values

PARAMETER_P

public static final java.lang.String PARAMETER_P

See Also:

Constant Field Values

PARAMETER_FILTER_ATTRIBUTE

public static final java.lang.String PARAMETER_FILTER_ATTRIBUTE

See Also:

Constant Field Values

PARAMETER_APPLY_ON_COMPLETE_SET

public static final java.lang.String PARAMETER_APPLY_ON_COMPLETE_SET

See Also:

Constant Field Values

PARAMETER_ITERATION_MACRO

public static final java.lang.String PARAMETER_ITERATION_MACRO

See Also:

Constant Field Values

DEFAULT_ITERATION_MACRO_NAME

public static final java.lang.String DEFAULT_ITERATION_MACRO_NAME

See Also:

Constant Field Values

Constructor Detail

ValueSubgroupIteration

public ValueSubgroupIteration(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()

All inner operators must be able to handle an example set.

Specified by:

getInnerOperatorCondition in class OperatorChain

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Returns the maximum number of innner operators.

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Returns the minimum number of innner operators.

Specified by:

getMinNumberOfInnerOperators 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 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

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

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