org.knime.base.data.aggregation.numerical

Class QuantileOperator

java.lang.Object

org.knime.base.data.aggregation.AggregationOperator

org.knime.base.data.aggregation.numerical.StoreResizableDoubleArrayOperator

org.knime.base.data.aggregation.numerical.QuantileOperator

All Implemented Interfaces:

Comparable<AggregationMethod>, AggregationMethod, AggregationFunction

public class QuantileOperator
extends StoreResizableDoubleArrayOperator

Computes the pth quantile per group.

Since:

2.12

Author:

Lara Gorini

Field Summary

Fields inherited from interface org.knime.base.data.aggregation.AggregationMethod

ASC_NAME_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	QuantileOperator(GlobalSettings globalSettings, OperatorColumnSettings opColSettings) Constructor for class QuantileOperator.
protected	QuantileOperator(OperatorData operatorData, GlobalSettings globalSettings, OperatorColumnSettings opColSettings, double quantile, String estimation) Constructor for class QuantileOperator.

Method Summary

Modifier and Type	Method and Description
AggregationOperator	createInstance(GlobalSettings globalSettings, OperatorColumnSettings opColSettings) Creates a new instance of this operator.
String	getColumnLabel()
protected DataType	getDataType(DataType origType)
String	getDescription()
String	getDetailedDescription()
protected DataCell	getResultInternal()
org.knime.base.data.aggregation.numerical.QuantileOperator.QuantileSettingsPanel	getSettingsPanel() Override this method if the operator requires additional settings.
boolean	hasOptionalSettings() Override this method and return true if the operator requires additional settings.
void	loadSettingsFrom(NodeSettingsRO settings, DataTableSpec spec) Override this method if the operator requires additional settings.
void	loadValidatedSettings(NodeSettingsRO settings) Override this method if the operator requires additional settings.
void	saveSettingsTo(NodeSettingsWO settings) Override this method if the operator requires additional settings.
void	validate() Override this method if the operator requires additional settings.
void	validateSettings(NodeSettingsRO settings) Override this method if the operator requires additional settings.

Methods inherited from class org.knime.base.data.aggregation.numerical.StoreResizableDoubleArrayOperator

computeInternal, getCells, resetInternal

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

compareTo, compute, compute, computeInternal, configure, createColumnSpec, createOperator, equals, getAdditionalColumnNames, getGlobalSettings, getId, getLabel, getMaxUniqueValues, getOperatorColumnSettings, getOperatorData, getResult, getSkipMessage, getSupportedType, getSupportedTypeLabel, getValueDelimiter, hashCode, inclMissingCells, isCompatible, isCompatible, isSkipped, isUsesLimit, keepColumnSpec, reset, setInclMissingFlag, setSkipMessage, setSkipped, supportsMissingValueOption, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QuantileOperator

protected QuantileOperator(OperatorData operatorData,
                           GlobalSettings globalSettings,
                           OperatorColumnSettings opColSettings,
                           double quantile,
                           String estimation)

Constructor for class QuantileOperator.

Parameters:

operatorData - the operator data

globalSettings - the global settings

opColSettings - the operator column specific settings

quantile - the quantile value

estimation - the type of estimation

QuantileOperator

public QuantileOperator(GlobalSettings globalSettings,
                        OperatorColumnSettings opColSettings)

Constructor for class QuantileOperator.

Parameters:

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. Remember to copy all operator specific settings when creating a new instance!

Specified by:

createInstance in class AggregationOperator

Parameters:

globalSettings - the global settings

opColSettings - the operator column specific settings

Returns:

a new instance of this operator

getColumnLabel

public String getColumnLabel()

Specified by:

getColumnLabel in interface AggregationMethod

Overrides:

getColumnLabel in class AggregationOperator

Returns:

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

getResultInternal

protected DataCell getResultInternal()

Specified by:

getResultInternal in class AggregationOperator

Returns:

the result DataCell

getDescription

public String getDescription()

Returns:

the description for this function

getDetailedDescription

public String getDetailedDescription()

Overrides:

getDetailedDescription in class AggregationOperator

Returns:

a detailed operator description that can also contain html elements such as hyper-links but no html and body tag. The description can be opened in the operator settings dialog.

hasOptionalSettings

public boolean hasOptionalSettings()

Override this method and return true if the operator requires additional settings. Override this method and return true if the operator requires additional settings. This method indicates if the operator requires additional settings. If that is the case the operator should return true. It must also override the corresponding methods (#getSettingsPanel(DataTableSpec), #validateSettings(NodeSettingsRO), #loadValidatedSettings(NodeSettingsRO), #saveSettingsTo(NodeSettingsWO) and #resetSettings()).

Specified by:

hasOptionalSettings in interface AggregationFunction

Overrides:

hasOptionalSettings in class AggregationOperator

Returns:

true if the operator requires additional settings

See Also:

AggregationFunction.getSettingsPanel(), AggregationFunction.validateSettings(NodeSettingsRO), AggregationFunction.loadValidatedSettings(NodeSettingsRO), AggregationFunction.loadSettingsFrom(NodeSettingsRO, DataTableSpec), AggregationFunction.saveSettingsTo(NodeSettingsWO)

getSettingsPanel

public org.knime.base.data.aggregation.numerical.QuantileOperator.QuantileSettingsPanel getSettingsPanel()

Override this method if the operator requires additional settings. Override this method if the operator requires additional settings. Returns the optional Component that allows the user to adjust all DBAggregationFunction specific settings. Methods that do need additional settings must override this method in order to return their settings panel.

Specified by:

getSettingsPanel in interface AggregationFunction

Overrides:

getSettingsPanel in class AggregationOperator

Returns:

the Component that contains all necessary settings

loadValidatedSettings

public void loadValidatedSettings(NodeSettingsRO settings)
                           throws InvalidSettingsException

Description copied from class: AggregationOperator

Override this method if the operator requires additional settings. This method is called in the NodeModel to load the settings that have been saved (AggregationFunction.saveSettingsTo(NodeSettingsWO)) by the DBAggregationFunction used in the in the additional settings panel (AggregationFunction.getSettingsPanel()) into the DBAggregationFunction that is actually used in the NodeModel. Each operator gets its own NodeSettingsRO object to ensure the uniqueness of the settings keys.

Specified by:

loadValidatedSettings in interface AggregationFunction

Overrides:

loadValidatedSettings in class AggregationOperator

Parameters:

settings - NodeSettingsRO that contains the optional settings

Throws:

InvalidSettingsException - if a property is not available

loadSettingsFrom

public void loadSettingsFrom(NodeSettingsRO settings,
                             DataTableSpec spec)
                      throws NotConfigurableException

Description copied from class: AggregationOperator

Override this method if the operator requires additional settings. This method is called prior the AggregationFunction.getSettingsPanel() method is called and the dialog is opened. This method should be used to load all settings form the provided settings object and to adjust the corresponding dialog components accordingly. Each operator gets its own NodeSettingsRO object to ensure the uniqueness of the settings keys.

Specified by:

loadSettingsFrom in interface AggregationFunction

Overrides:

loadSettingsFrom in class AggregationOperator

Parameters:

settings - NodeSettingsRO that contains the optional settings

spec - the DataTableSpec of the input table

Throws:

NotConfigurableException - if the dialog cannot be opened because of invalid settings or if any preconditions are not fulfilled, e.g. no nominal column in input table, etc.

saveSettingsTo

public void saveSettingsTo(NodeSettingsWO settings)

Description copied from class: AggregationOperator

Override this method if the operator requires additional settings. This method is called from the NodeDialog and NodeModel in order to save the additional settings. It is also called prior the AggregationFunction.getSettingsPanel() method in order to save the current settings. The saved settings are used to initialize the settings panel by calling AggregationFunction.loadSettingsFrom(NodeSettingsRO, DataTableSpec) prior calling AggregationFunction.getSettingsPanel() and to restore the previous (default) setting by calling the AggregationFunction.loadValidatedSettings(NodeSettingsRO) when the user closes the dialog in any other way then by clicking on the OK button! Each operator gets its own NodeSettingsRO object to ensure the uniqueness of the settings keys.

Specified by:

saveSettingsTo in interface AggregationFunction

Overrides:

saveSettingsTo in class AggregationOperator

Parameters:

settings - the NodeSettingsWO to save the optional settings

validateSettings

public void validateSettings(NodeSettingsRO settings)
                      throws InvalidSettingsException

Description copied from class: AggregationOperator

Override this method if the operator requires additional settings. This method is called from the NodeDialog when the user closes the additional settings dialog by clicking on the OK button. It is also called from the NodeModel prior the settings are loaded calling the AggregationFunction.loadValidatedSettings(NodeSettingsRO). Each operator gets its own NodeSettingsRO object to ensure the uniqueness of the settings keys. This function has been replaced by the AggregationFunction.validate() method.

Specified by:

validateSettings in interface AggregationFunction

Overrides:

validateSettings in class AggregationOperator

Parameters:

settings - the NodeSettingsRO that contains the optional settings to validate

Throws:

InvalidSettingsException - if the settings are invalid

See Also:

AggregationFunction.validate()

validate

public void validate()
              throws InvalidSettingsException

Description copied from class: AggregationOperator

Override this method if the operator requires additional settings. Validates the internal state (e.g. settings) of the function. This method is typically called in the node dialog in order to validate the settings of each AggregationFunction before saving it.

Specified by:

validate in interface AggregationFunction

Overrides:

validate in class AggregationOperator

Throws:

InvalidSettingsException - if the internal state is invalid