com.rapidminer.operator.preprocessing.filter.attributes
Class AttributeFilter

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.attributes.AttributeFilter

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class AttributeFilter
extends AbstractFeatureSelection

This operator filters the attributes of an exampleSet. Therefore, different conditions may be selected as parameter and only attributes fulfilling this condition are kept. The rest will be removed from the exampleSet The conditions may be inverted. The conditions are tested over all attributes and for every attribute over all examples. For example the numeric_value_filter with the parameter string "> 6" will keep all nominal attributes and all numeric attributes having a value of greater 6 in every example. A combination of conditions is possible: "> 6 ANDAND < 11" or "<= 5 || < 0". But ANDAND and || must not be mixed. Please note that ANDAND has to be replaced by two ampers ands.

The attribute_name_filter keeps all attributes which names match the given regular expression. The nominal_value_filter keeps all numeric attribute and all nominal attributes containing at least one of specified nominal values. "rainy ANDAND cloudy" would keep all attributes containing at least one time "rainy" and one time "cloudy". "rainy || sunny" would keep all attributes containing at least one time "rainy" or one time "sunny". ANDAND and || are not allowed to be mixed. And again, ANDAND has to be replaced by two ampers ands.

Author:

Sebastian Land, Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_APPLY_ON_SPECIAL
static java.lang.String	PARAMETER_INVERT_FILTER The parameter name for "Indicates if only examples should be accepted which would normally filtered.

Constructor Summary

AttributeFilter(OperatorDescription description)

Method Summary

ExampleSet	apply(ExampleSet exampleSet) Delegate for the apply method.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

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_INVERT_FILTER

public static final java.lang.String PARAMETER_INVERT_FILTER

The parameter name for "Indicates if only examples should be accepted which would normally filtered."

See Also:

Constant Field Values

PARAMETER_APPLY_ON_SPECIAL

public static final java.lang.String PARAMETER_APPLY_ON_SPECIAL

See Also:

Constant Field Values

Constructor Detail

AttributeFilter

public AttributeFilter(OperatorDescription description)

Method Detail

apply

public ExampleSet apply(ExampleSet exampleSet)
                 throws OperatorException

Description copied from class: AbstractExampleSetProcessing

Delegate for the apply method. In most cases, the returned example set will be the same as the example set or a modified clone.

Specified by:

apply in class AbstractExampleSetProcessing

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