org.knime.base.data.aggregation.general
Class ModeOperator

java.lang.Object
  org.knime.base.data.aggregation.AggregationOperator
      org.knime.base.data.aggregation.general.ModeOperator

All Implemented Interfaces:

Comparable<AggregationMethod>, AggregationMethod

public class ModeOperator
extends AggregationOperator

Returns the most frequent entry per group.

Author:

Tobias Koetter, University of Konstanz

Constructor Summary

	ModeOperator(GlobalSettings globalSettings, OperatorColumnSettings opColSettings) Constructor for class ModeOperator.
protected	ModeOperator(OperatorData operatorData, GlobalSettings globalSettings, OperatorColumnSettings opColSettings) Constructor for class ModeOperator.

Method Summary

protected boolean	computeInternal(DataCell cell)
AggregationOperator	createInstance(GlobalSettings globalSettings, OperatorColumnSettings opColSettings) Creates a new instance of this operator.
protected DataType	getDataType(DataType origType)
String	getDescription()
protected DataCell	getResultInternal()
protected void	resetInternal() Should reset the operator to the start values.

Methods inherited from class org.knime.base.data.aggregation.AggregationOperator

compareTo, compute, createColumnSpec, createOperator, getColumnLabel, getGlobalSettings, getId, getLabel, getMaxUniqueValues, getOperatorData, getResult, getSkipMessage, getSupportedType, getSupportedTypeLabel, getValueDelimiter, inclMissingCells, isCompatible, isCompatible, isSkipped, isUsesLimit, keepColumnSpec, reset, setSkipMessage, setSkipped, supportsMissingValueOption, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ModeOperator

public ModeOperator(GlobalSettings globalSettings,
                    OperatorColumnSettings opColSettings)

Constructor for class ModeOperator.

Parameters:

globalSettings - the global settings

opColSettings - the operator column specific settings

ModeOperator

protected ModeOperator(OperatorData operatorData,
                       GlobalSettings globalSettings,
                       OperatorColumnSettings opColSettings)

Constructor for class ModeOperator.

Parameters:

operatorData - the operator data

globalSettings - the global settings

opColSettings - the operator column specific settings

Method Detail

getDataType

protected DataType getDataType(DataType origType)

Specified by:

getDataType in class AggregationOperator

Parameters:

origType - the DataType of the original column to aggregate

Returns:

the DataType of the aggregation result

createInstance

public AggregationOperator createInstance(GlobalSettings globalSettings,
                                          OperatorColumnSettings opColSettings)

Creates a new instance of this operator. A new instance is created for each column.

Specified by:

createInstance in class AggregationOperator

Parameters:

globalSettings - the global settings

opColSettings - the operator column specific settings

Returns:

a new instance of this operator

computeInternal

protected boolean computeInternal(DataCell cell)

Specified by:

computeInternal in class AggregationOperator

Parameters:

cell - the DataCell to consider during computing the cell can't be null but can be a missing cell DataCell.isMissing() if the option is AggregationOperator.inclMissingCells() option is set to true.

Returns:

true if this column should be skipped in further calculations

getResultInternal

protected DataCell getResultInternal()

Specified by:

getResultInternal in class AggregationOperator

Returns:

the result DataCell

resetInternal

protected void resetInternal()

Should reset the operator to the start values.

Specified by:

resetInternal in class AggregationOperator

getDescription

public String getDescription()

Returns:

a description that explains the used aggregation method to the user