org.knime.base.node.preproc.pivot

Class Pivot2NodeModel

java.lang.Object

org.knime.core.node.NodeModel

org.knime.base.node.preproc.groupby.GroupByNodeModel

org.knime.base.node.preproc.pivot.Pivot2NodeModel

public class Pivot2NodeModel
extends GroupByNodeModel

The NodeModel implementation of the pivot node which uses the GroupByNodeModel class implementations to create an intermediate group-by table from which the pivoting table is extracted.

Author:

Thomas Gabriel, KNIME.com AG, Switzerland

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CFG_PIVOT_COLUMNS Configuration key of the selected group by columns.

Fields inherited from class org.knime.base.node.preproc.groupby.GroupByNodeModel

CFG_COLUMN_NAME_POLICY, CFG_ENABLE_HILITE, CFG_GROUP_BY_COLUMNS, CFG_IN_MEMORY, CFG_MAX_UNIQUE_VALUES, CFG_RETAIN_ORDER, CFG_SORT_IN_MEMORY, CFG_VALUE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
Pivot2NodeModel() Create a new pivot node model.

Method Summary

Modifier and Type	Method and Description
protected DataTableSpec[]	configure(PortObjectSpec[] inSpecs) Configure method for general port types.
protected PortObject[]	execute(PortObject[] inData, ExecutionContext exec) Execute method for general port types.
protected HiLiteHandler	getOutHiLiteHandler(int outIndex) Returns the HiLiteHandler for the given output index.
protected void	loadValidatedSettingsFrom(NodeSettingsRO settings) Sets new settings from the passed object in the model.
protected void	saveSettingsTo(NodeSettingsWO settings) Adds to the given NodeSettings the model specific settings.
protected void	validateSettings(NodeSettingsRO settings) Validates the settings in the passed NodeSettings object.

Methods inherited from class org.knime.base.node.preproc.groupby.GroupByNodeModel

checkDuplicateAggregators, compGetColumnMethods, compGetColumnNamePolicy, createGlobalSettings, createGroupBySpec, createGroupByTable, createGroupByTable, createGroupByTable, getAggregators, getColumnAggregators, getColumnNamePolicy, getDefaultValueDelimiter, getExcludeList, getGroupByColumns, inMemoryChanged, isProcessInMemory, isRetainOrder, isSortInMemory, loadInternals, reset, saveInternals, setHiliteMapping, setInHiLiteHandler

Methods inherited from class org.knime.core.node.NodeModel

addWarningListener, computeFinalOutputSpecs, configure, continueLoop, createInitialStreamableOperatorInternals, createMergeOperator, createStreamableOperator, execute, finishStreamableExecution, getAvailableFlowVariables, getAvailableInputFlowVariables, getCredentialsProvider, getInHiLiteHandler, getInPortType, getInputPortRoles, getInteractiveNodeView, getLogger, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutPortType, getOutputPortRoles, getWarningMessage, iterate, notifyViews, notifyWarningListeners, onDispose, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, removeWarningListener, resetAndConfigureLoopBody, setWarningMessage, stateChanged

Methods inherited from class java.lang.Object

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

Field Detail

CFG_PIVOT_COLUMNS

protected static final String CFG_PIVOT_COLUMNS

Configuration key of the selected group by columns.

See Also:

Constant Field Values

Constructor Detail

Pivot2NodeModel

public Pivot2NodeModel()

Create a new pivot node model.

Method Detail

configure

protected DataTableSpec[] configure(PortObjectSpec[] inSpecs)
                             throws InvalidSettingsException

Configure method for general port types. The argument specs represent the input object specs and are guaranteed to be subclasses of the PortObjectSpecs that are defined through the PortTypes given in the constructor unless this model is an InactiveBranchConsumer (most nodes are not). Similarly, the returned output specs need to comply with their port types spec class (otherwise an error is reported by the framework). They may also be null (out spec not known at time of configuration) or inactive (output and downstream nodes are inactive).

For a general description of the configure method refer to the description of the specialized NodeModel.configure(DataTableSpec[]) methods as it addresses more use cases.

Overrides:

configure in class GroupByNodeModel

Parameters:

inSpecs - The input data table specs. Items of the array could be null if no spec is available from the corresponding input port (i.e. not connected or upstream node does not produce an output spec). If a port is of type BufferedDataTable.TYPE and no spec is available the framework will replace null by an empty DataTableSpec (no columns) unless the port is marked as optional as per constructor.

Returns:

The output objects specs or null.

Throws:

InvalidSettingsException - If this node can't be configured.

execute

protected PortObject[] execute(PortObject[] inData,
                               ExecutionContext exec)
                        throws Exception

Execute method for general port types. The argument inObjects represent the input objects and the returned array represents the output objects. The elements in the argument array are generally guaranteed to be not null and subclasses of the PortObject classes that are defined through the PortTypes given in the constructor. Similarly, the returned output objects need to comply with their port types object class (otherwise an error is reported by the framework) and must not be null. There are few exceptions to these rules:

• Nodes with optional inputs (as specified in the constructor) may find null elements in the array.
• Node that implement InactiveBranchConsumer may find instances of InactiveBranchPortObject in case the corresponding input is inactive.
• All nodes are allowed to return InactiveBranchPortObject elements in case the output should be inactivated.
• Loop end nodes may return null in case they restart the loop by setting the corresponding flags.

For a general description of the execute method refer to the description of the specialized NodeModel.execute(BufferedDataTable[], ExecutionContext) methods as it addresses more use cases.

Overrides:

execute in class GroupByNodeModel

Parameters:

inData - The input objects.

exec - For BufferedDataTable creation and progress.

Returns:

The output objects.

Throws:

Exception - If the node execution fails for any reason.

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)

Adds to the given NodeSettings the model specific settings. The settings don't need to be complete or consistent. If, right after startup, no valid settings are available this method can write either nothing or invalid settings.

Method is called by the Node if the current settings need to be saved or transfered to the node's dialog.

Overrides:

saveSettingsTo in class GroupByNodeModel

Parameters:

settings - The object to write settings into.

See Also:

NodeModel.loadValidatedSettingsFrom(NodeSettingsRO), NodeModel.validateSettings(NodeSettingsRO)

validateSettings

protected void validateSettings(NodeSettingsRO settings)
                         throws InvalidSettingsException

Validates the settings in the passed NodeSettings object. The specified settings should be checked for completeness and consistency. It must be possible to load a settings object validated here without any exception in the #loadValidatedSettings(NodeSettings) method. The method must not change the current settings in the model - it is supposed to just check them. If some settings are missing, invalid, inconsistent, or just not right throw an exception with a message useful to the user.

Overrides:

validateSettings in class GroupByNodeModel

Parameters:

settings - The settings to validate.

Throws:

InvalidSettingsException - If the validation of the settings failed.

See Also:

NodeModel.saveSettingsTo(NodeSettingsWO), NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)

loadValidatedSettingsFrom

protected void loadValidatedSettingsFrom(NodeSettingsRO settings)
                                  throws InvalidSettingsException

Sets new settings from the passed object in the model. You can safely assume that the object passed has been successfully validated by the #validateSettings(NodeSettings) method. The model must set its internal configuration according to the settings object passed.

Overrides:

loadValidatedSettingsFrom in class GroupByNodeModel

Parameters:

settings - The settings to read.

Throws:

InvalidSettingsException - If a property is not available.

See Also:

NodeModel.saveSettingsTo(NodeSettingsWO), NodeModel.validateSettings(NodeSettingsRO)

getOutHiLiteHandler

protected HiLiteHandler getOutHiLiteHandler(int outIndex)

Returns the HiLiteHandler for the given output index. This default implementation simply passes on the handler of input port 0 or generates a new one if this node has no inputs.

This method is intended to be overridden

Overrides:

getOutHiLiteHandler in class GroupByNodeModel

Parameters:

outIndex - The output index.

Returns:

HiLiteHandler for the given output port.