com.rapidminer.operator.preprocessing.transformation
Class AggregationOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.AbstractDataProcessing
              com.rapidminer.operator.preprocessing.transformation.AggregationOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class AggregationOperator
extends AbstractDataProcessing

This operator creates a new example set from the input example set showing the results of arbitrary aggregation functions (as SUM, COUNT etc. known from SQL). Before the values of different rows are aggregated into a new row the rows might be grouped by the values of a multiple attributes (similar to the group-by clause known from SQL). In this case a new line will be created for each group.

Please note that the known HAVING clause from SQL can be simulated by an additional ExampleFilter operator following this one.

Author:

Tobias Malbrecht, Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_AGGREGATION_ATTRIBUTES
static java.lang.String	PARAMETER_AGGREGATION_FUNCTIONS
static java.lang.String	PARAMETER_GROUP_BY_ATTRIBUTES
static java.lang.String	PARAMETER_IGNORE_MISSINGS
static java.lang.String	PARAMETER_ONLY_DISTINCT

Constructor Summary

AggregationOperator(OperatorDescription desc)

Method Summary

ExampleSet	apply(ExampleSet exampleSet) Delegate for the apply method.
InputDescription	getInputDescription(java.lang.Class cls) Indicates that the consumption of example sets can be user defined (default: no consumption).
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, 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_AGGREGATION_ATTRIBUTES

public static final java.lang.String PARAMETER_AGGREGATION_ATTRIBUTES

See Also:

Constant Field Values

PARAMETER_AGGREGATION_FUNCTIONS

public static final java.lang.String PARAMETER_AGGREGATION_FUNCTIONS

See Also:

Constant Field Values

PARAMETER_GROUP_BY_ATTRIBUTES

public static final java.lang.String PARAMETER_GROUP_BY_ATTRIBUTES

See Also:

Constant Field Values

PARAMETER_ONLY_DISTINCT

public static final java.lang.String PARAMETER_ONLY_DISTINCT

See Also:

Constant Field Values

PARAMETER_IGNORE_MISSINGS

public static final java.lang.String PARAMETER_IGNORE_MISSINGS

See Also:

Constant Field Values

Constructor Detail

AggregationOperator

public AggregationOperator(OperatorDescription desc)

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

getInputDescription

public InputDescription getInputDescription(java.lang.Class cls)

Indicates that the consumption of example sets can be user defined (default: no consumption).

Overrides:

getInputDescription 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