com.rapidminer.operator.preprocessing.filter
Class FeatureFilter

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.features.AbstractFeatureProcessing
              com.rapidminer.operator.features.selection.AbstractFeatureSelection
                  com.rapidminer.operator.preprocessing.filter.FeatureFilter

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

Direct Known Subclasses:

FeatureBlockTypeFilter, FeatureNameFilter, FeatureValueTypeFilter

public abstract class FeatureFilter
extends AbstractFeatureSelection

This is an abstract superclass for feature filters. These operators take an ExampleSet as input and switch off all features that fulfill a condition. Subclasses must implement the condition in the method switchOffFeature(), which returns a boolean.

Author:

Ingo Mierswa

Field Summary

static java.lang.String

PARAMETER_FILTER_SPECIAL_FEATURES The parameter name for "Filter also special attributes (label, id...)

Constructor Summary

FeatureFilter(OperatorDescription description)

Method Summary

ExampleSet	apply(ExampleSet eSet) Applies filtering of features by looping through all features and checking switchOffFeature().
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
abstract boolean	switchOffFeature(AttributeRole theFeature) Must be implemented by subclasses.

Methods inherited from class com.rapidminer.operator.AbstractExampleSetProcessing

apply, getInputClasses, getOutputClasses

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, 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, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_FILTER_SPECIAL_FEATURES

public static final java.lang.String PARAMETER_FILTER_SPECIAL_FEATURES

The parameter name for "Filter also special attributes (label, id...)"

See Also:

Constant Field Values

Constructor Detail

FeatureFilter

public FeatureFilter(OperatorDescription description)

Method Detail

switchOffFeature

public abstract boolean switchOffFeature(AttributeRole theFeature)
                                  throws OperatorException

Must be implemented by subclasses. When operators extending this class are applied, they loop through the set of features and switch off all features for which this method returns TRUE, while keeping the status of the other features.

Parameters:

theFeature - Feature to check.

Returns:

TRUE if this feature should not be active in the output example set of this operator. FALSE otherwise.

Throws:

OperatorException

apply

public ExampleSet apply(ExampleSet eSet)
                 throws OperatorException

Applies filtering of features by looping through all features and checking switchOffFeature(). If TRUE is returned, the feature is switched off, ie it won't be used by the following operators in the chain. If FALSE is returned by switchOffFeature(), the feature will keep its previous status.

Specified by:

apply in class AbstractExampleSetProcessing

Returns:

An array of IOObjects, with the output example set as the only member.

Throws:

OperatorException

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