org.knime.base.node.flowvariable.appendvariabletotable2

Class AppendVariableToTable2NodeModel

java.lang.Object

org.knime.core.node.NodeModel

org.knime.core.node.streamable.simple.SimpleStreamableFunctionNodeModel

org.knime.base.node.flowvariable.appendvariabletotable2.AppendVariableToTable2NodeModel

All Implemented Interfaces:

StreamableFunctionProducer

public class AppendVariableToTable2NodeModel
extends SimpleStreamableFunctionNodeModel

NodeModel for the "Variable To TableColumn" node which adds variables as new columns to the input table.

Since:

2.9

Author:

Bernd Wiswedel, KNIME.com, Zurich, Switzerland, Patrick Winter, KNIME.com, Zurich, Switzerland

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	CFG_KEY_FILTER Key for the filter configuration.

Constructor Summary

Constructors

Constructor and Description
AppendVariableToTable2NodeModel() One input, one output.

Method Summary

Modifier and Type	Method and Description
protected PortObjectSpec[]	configure(PortObjectSpec[] inSpecs) Configure method for general port types.
protected ColumnRearranger	createColumnRearranger(DataTableSpec spec) Creates a column rearranger that describes the changes to the input table.
protected PortObject[]	execute(PortObject[] inData, ExecutionContext exec) Execute method for general port types.
protected void	loadInternals(File nodeInternDir, ExecutionMonitor exec) Load internals into the derived NodeModel.
protected void	loadValidatedSettingsFrom(NodeSettingsRO settings) Sets new settings from the passed object in the model.
protected void	reset() Override this function in the derived model and reset your NodeModel.
protected void	saveInternals(File nodeInternDir, ExecutionMonitor exec) Save internals of the derived NodeModel.
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.core.node.streamable.simple.SimpleStreamableFunctionNodeModel

configure, createStreamableOperator, execute, getInputPortRoles, getOutputPortRoles, getStreamableInPortIdx, getStreamableOutPortIdx, isDistributable

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CFG_KEY_FILTER

static final String CFG_KEY_FILTER

Key for the filter configuration.

See Also:

Constant Field Values

Constructor Detail

AppendVariableToTable2NodeModel

public AppendVariableToTable2NodeModel()

One input, one output.

Method Detail

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 NodeModel

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.

configure

protected PortObjectSpec[] 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 NodeModel

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.

createColumnRearranger

protected ColumnRearranger createColumnRearranger(DataTableSpec spec)
                                           throws InvalidSettingsException

Description copied from class: SimpleStreamableFunctionNodeModel

Creates a column rearranger that describes the changes to the input table. Sub classes will check the consistency of the input table with their settings (fail with InvalidSettingsException if necessary) and then return a customized ColumnRearranger.

Specified by:

createColumnRearranger in class SimpleStreamableFunctionNodeModel

Parameters:

spec - The spec of the input table.

Returns:

A column rearranger describing the changes, never null.

Throws:

InvalidSettingsException - If the settings or the input are invalid.

reset

protected void reset()

Override this function in the derived model and reset your NodeModel. All components should unregister themselves from any observables (at least from the hilite handler right now). All internally stored data structures should be released. User settings should not be deleted/reset though.

Overrides:

reset in class SimpleStreamableFunctionNodeModel

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.

Specified by:

loadValidatedSettingsFrom in class NodeModel

Parameters:

settings - The settings to read.

Throws:

InvalidSettingsException - If a property is not available.

See Also:

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

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.

Specified by:

saveSettingsTo in class NodeModel

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.

Specified by:

validateSettings in class NodeModel

Parameters:

settings - The settings to validate.

Throws:

InvalidSettingsException - If the validation of the settings failed.

See Also:

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

loadInternals

protected void loadInternals(File nodeInternDir,
                             ExecutionMonitor exec)
                      throws IOException,
                             CanceledExecutionException

Load internals into the derived NodeModel. This method is only called if the Node was executed. Read all your internal structures from the given file directory to create your internal data structure which is necessary to provide all node functionalities after the workflow is loaded, e.g. view content and/or hilite mapping.

Overrides:

loadInternals in class SimpleStreamableFunctionNodeModel

Parameters:

nodeInternDir - The directory to read from.

exec - Used to report progress and to cancel the load process.

Throws:

IOException - If an error occurs during reading from this dir.

CanceledExecutionException - If the loading has been canceled.

See Also:

NodeModel.saveInternals(File,ExecutionMonitor)

saveInternals

protected void saveInternals(File nodeInternDir,
                             ExecutionMonitor exec)
                      throws IOException,
                             CanceledExecutionException

Save internals of the derived NodeModel. This method is only called if the Node is executed. Write all your internal structures into the given file directory which are necessary to recreate this model when the workflow is loaded, e.g. view content and/or hilite mapping.

Overrides:

saveInternals in class SimpleStreamableFunctionNodeModel

Parameters:

nodeInternDir - The directory to write into.

exec - Used to report progress and to cancel the save process.

Throws:

IOException - If an error occurs during writing to this dir.

CanceledExecutionException - If the saving has been canceled.

See Also:

NodeModel.loadInternals(File,ExecutionMonitor)