org.knime.base.data.aggregation
Class OperatorData

java.lang.Object
  org.knime.base.data.aggregation.OperatorData

public class OperatorData
extends Object

This class holds all information of an AggregationOperator such as its name and the supported data types. These informations are used to register the operator and to provide information about the operator for the user.

Author:

Tobias Koetter, University of Konstanz

Constructor Summary

OperatorData(String label, boolean usesLimit, boolean keepColSpec, Class<? extends DataValue> supportedClass, boolean supportMissingValsOption)
Constructor for class OperatorData.

OperatorData(String label, String colName, boolean usesLimit, boolean keepColSpec, Class<? extends DataValue> supportedClass, boolean supportMissingValsOption)
Constructor for class OperatorData.

OperatorData(String id, String label, String colName, boolean usesLimit, boolean keepColSpec, Class<? extends DataValue> supportedClass, boolean supportMissingValsOption)
Constructor for class OperatorData.

Method Summary

String	getColumnLabel()
String	getId()
String	getLabel()
Class<? extends DataValue>	getSupportedType()
boolean	keepColumnSpec()
boolean	supportsMissingValueOption()
boolean	usesLimit()

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorData

public OperatorData(String label,
                    boolean usesLimit,
                    boolean keepColSpec,
                    Class<? extends DataValue> supportedClass,
                    boolean supportMissingValsOption)

Constructor for class OperatorData.

Parameters:

label - unique user readable label. The label need to be unique since it is used for registration and column name generation. It is also displayed to the user in the aggregation method selection box.

usesLimit - true if the method checks the number of unique values limit.

keepColSpec - true if the original column specification should be kept if possible

supportedClass - the DataValue class supported by this method

supportMissingValsOption - true if the operator supports the alternation of the missing value flag

OperatorData

public OperatorData(String label,
                    String colName,
                    boolean usesLimit,
                    boolean keepColSpec,
                    Class<? extends DataValue> supportedClass,
                    boolean supportMissingValsOption)

Constructor for class OperatorData.

Parameters:

label - unique user readable label. The label need to be unique since it is used for registration. It is also displayed to the user in the aggregation method selection box.

colName - the name of the result column

usesLimit - true if the method checks the number of unique values limit.

keepColSpec - true if the original column specification should be kept if possible

supportedClass - the DataValue class supported by this method

supportMissingValsOption - true if the operator supports the alternation of the missing value flag

OperatorData

public OperatorData(String id,
                    String label,
                    String colName,
                    boolean usesLimit,
                    boolean keepColSpec,
                    Class<? extends DataValue> supportedClass,
                    boolean supportMissingValsOption)

Constructor for class OperatorData.

Parameters:

id - the unique identifier used for registration

label - user readable label

colName - the name of the result column

usesLimit - true if the method checks the number of unique values limit.

keepColSpec - true if the original column specification should be kept if possible

supportedClass - the DataValue class supported by this method

supportMissingValsOption - true if the operator supports the alternation of the missing value flag

Method Detail

getSupportedType

public Class<? extends DataValue> getSupportedType()

Returns:

the supported DataValue class

supportsMissingValueOption

public boolean supportsMissingValueOption()

Returns:

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

keepColumnSpec

public boolean keepColumnSpec()

Returns:

true if the original DataColumnSpec should be kept.

getId

public String getId()

Returns:

the unique identifier

getLabel

public String getLabel()

Returns:

the unique label that is displayed to the user and that is used for registration

getColumnLabel

public String getColumnLabel()

Returns:

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

usesLimit

public boolean usesLimit()

Returns:

true if this method checks the maximum unique values limit.