org.knime.base.data.aggregation
Interface AggregationMethod

All Superinterfaces:

Comparable<AggregationMethod>

All Known Implementing Classes:

AggregationOperator, AndElementCountOperator, AndElementOperator, ConcatenateOperator, ConcatenateOperator, CountOperator, DateMeanOperator, DayRangeOperator, ElementCountOperator, FalseCountOperator, FirstOperator, GeometricMeanOperator, LastOperator, ListCellOperator, MaxOperator, MeanOperator, MedianDateOperator, MedianOperator, MillisRangeOperator, MinOperator, MissingValueCountOperator, ModeOperator, OrElementCountOperator, OrElementOperator, PercentOperator, ProductOperator, RangeOperator, SetCellOperator, SortedListCellOperator, StdDeviationOperator, SumOperator, SumOperator, TrueCountOperator, UniqueConcatenateOperator, UniqueConcatenateOperator, UniqueConcatenateWithCountOperator, UniqueConcatenateWithCountOperator, UniqueCountOperator, VarianceOperator, XORElementCountOperator, XORElementOperator

public interface AggregationMethod
extends Comparable<AggregationMethod>

Interface that implements the main methods of an aggregation method. However the main work is done by the AggregationOperator that can be created using the createOperator(GlobalSettings, OperatorColumnSettings) method. A new AggregationOperator should be created per column. AggregationMethods are sorted first by the supported data type and then by the label.

Author:

Tobias Koetter, University of Konstanz

Method Summary

DataColumnSpec	createColumnSpec(String colName, DataColumnSpec origSpec)
AggregationOperator	createOperator(GlobalSettings globalSettings, OperatorColumnSettings opColSettings) Creates a new instance of this operator and returns it.
String	getColumnLabel()
String	getDescription()
String	getId() The unique identifier of the method that is used for registration and identification of the aggregation method.
String	getLabel()
Class<? extends DataValue>	getSupportedType()
String	getSupportedTypeLabel()
boolean	inclMissingCells()
boolean	isCompatible(DataColumnSpec origColSpec)
boolean	supportsMissingValueOption()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

String getId()

The unique identifier of the method that is used for registration and identification of the aggregation method. The id is an internal used variable that is not displayed to the user.

Returns:

the unique id of the method that is used to register and identify the method.

getLabel

String getLabel()

Returns:

the label that is displayed to the user

createColumnSpec

DataColumnSpec createColumnSpec(String colName,
                                DataColumnSpec origSpec)

Parameters:

colName - the unique name of the column

origSpec - the original DataColumnSpec

Returns:

the new DataColumnSpecCreator for the aggregated column

getColumnLabel

String getColumnLabel()

Returns:

the label of the aggregation method which is used in the column name

isCompatible

boolean isCompatible(DataColumnSpec origColSpec)

Parameters:

origColSpec - the DataColumnSpec of the column to check for compatibility

Returns:

true if the aggregation method is compatible

createOperator

AggregationOperator createOperator(GlobalSettings globalSettings,
                                   OperatorColumnSettings opColSettings)

Creates a new instance of this operator and returns it. A new instance must be created for each column.

Parameters:

globalSettings - the global settings

opColSettings - the operator column specific settings

Returns:

a new instance of this operator

supportsMissingValueOption

boolean supportsMissingValueOption()

Returns:

true if the operator supports the alteration of the missing cell option

inclMissingCells

boolean inclMissingCells()

Returns:

true if missing cells are considered during aggregation

getDescription

String getDescription()

Returns:

a description that explains the used aggregation method to the user

getSupportedType

Class<? extends DataValue> getSupportedType()

Returns:

the supported DataValue class

getSupportedTypeLabel

String getSupportedTypeLabel()

Returns:

the user friendly label of the supported DataValue class