Method Detail

configure

This function is called whenever the derived model should re-configure and generate the expected output specs.
Based on the given input data table spec(s) and the current model's settings, the derived model has to calculate
the output data table spec and return them.

For ordinary(*) nodes the passed DataTableSpec elements are never null but can be empty. The model
may return null data table spec(s) for the outputs. Note, after the model has been executed this
function will not be called anymore, as the output DataTableSpecs are then being pulled from the output
DataTables. A derived NodeModel that cannot provide any DataTableSpecs at its outputs before
execution (because the table structure is unknown at this point) can return an array containing just
null elements. As an example consider a "Transpose" node that flips columns to rows -- there is no
way to determine the table spec at time of configuration as the number of rows (which is the number of new
columns at the output) is unknown though the node is still executable.

inSpecs - The input data table specs (as many as this model has inputs). Do NOT modify the contents of this
array. If no spec is available for any given port (because the port is not connected or the previous
node does not produce a spec) the framework will pass an empty DataTableSpec (no columns)
unless the port is marked as optional (in which case the array element
is null).

Returns:

An array of DataTableSpecs (as many as this model has outputs) They will be propagated to connected
successor nodes. null DataTableSpec elements are changed to empty once.

Throws:

InvalidSettingsException - if the #configure() failed, that is, the settings are inconsistent
with given DataTableSpec elements.

execute

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.

loadInternals

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.

saveInternals

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.

saveSettingsTo

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.

validateSettings

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.

loadValidatedSettingsFrom

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.

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.

Copyright, 2003 - 2016. All rights reserved.KNIME GmbH, Konstanz, GermanyYou may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.