com.rapidminer.operator.preprocessing.filter
Class Sorting

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.AbstractDataProcessing
              com.rapidminer.operator.preprocessing.filter.Sorting

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class Sorting
extends AbstractDataProcessing

This operator sorts the given example set according to a single attribute. The example set is sorted according to the natural order of the values of this attribute either in increasing or in decreasing direction.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_ATTRIBUTE_NAME The parameter name for "Indicates the attribute which should be used for determining the sorting.
static java.lang.String	PARAMETER_SORTING_DIRECTION The parameter name for "Indicates the direction of the sorting.

Constructor Summary

Sorting(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_ATTRIBUTE_NAME

public static final java.lang.String PARAMETER_ATTRIBUTE_NAME

The parameter name for "Indicates the attribute which should be used for determining the sorting."

See Also:

Constant Field Values

PARAMETER_SORTING_DIRECTION

public static final java.lang.String PARAMETER_SORTING_DIRECTION

The parameter name for "Indicates the direction of the sorting."

See Also:

Constant Field Values

Constructor Detail

Sorting

public Sorting(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