org.knime.base.node.preproc.rank

Class RankNodeModel

java.lang.Object

org.knime.core.node.NodeModel

org.knime.base.node.preproc.rank.RankNodeModel

public class RankNodeModel
extends NodeModel

This is the model implementation of Rank. This node ranks the input data based on the selected ranking field and ranking mode

Author:

Adrian Nembach, KNIME GmbH Konstanz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	RankNodeModel.RankMode

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static boolean	DEFAULT_RANKASLONG
(package private) static RankNodeModel.RankMode	DEFAULT_RANKMODE initial default values.
(package private) static String	DEFAULT_RANKOUTCOLNAME
(package private) static boolean	DEFAULT_RETAINROWORDER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RankNodeModel() Constructor for the node model.

Method Summary

Modifier and Type	Method and Description
protected DataTableSpec[]	configure(DataTableSpec[] inSpecs) This function is called whenever the derived model should re-configure and generate the expected output specs.
(package private) static SettingsModelStringArray	createGroupColumnsModel()
(package private) static SettingsModelBoolean	createRankAsLongModel()
(package private) static SettingsModelStringArray	createRankColumnsModel()
(package private) static SettingsModelString	createRankModeModel()
(package private) static SettingsModelStringArray	createRankOrderModel()
(package private) static SettingsModelString	createRankOutColNameModel()
(package private) static SettingsModelBoolean	createRetainRowOrderModel()
protected BufferedDataTable[]	execute(BufferedDataTable[] inData, ExecutionContext exec) This function is invoked by the Node#executeNode() method of the node (through the #executeModel(BufferedDataTable[],ExecutionMonitor) method) only after all predecessor nodes have been successfully executed and all data is therefore available at the input ports.
protected void	loadInternals(File internDir, 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 internDir, 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.NodeModel

addWarningListener, computeFinalOutputSpecs, configure, continueLoop, createInitialStreamableOperatorInternals, createMergeOperator, createStreamableOperator, execute, finishStreamableExecution, getAvailableFlowVariables, getAvailableInputFlowVariables, getCredentialsProvider, getInHiLiteHandler, getInPortType, getInputPortRoles, getInteractiveNodeView, getLogger, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getOutPortType, getOutputPortRoles, 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

DEFAULT_RANKMODE

static final RankNodeModel.RankMode DEFAULT_RANKMODE

initial default values.

DEFAULT_RANKOUTCOLNAME

static final String DEFAULT_RANKOUTCOLNAME

See Also:

Constant Field Values

DEFAULT_RETAINROWORDER

static final boolean DEFAULT_RETAINROWORDER

See Also:

Constant Field Values

DEFAULT_RANKASLONG

static final boolean DEFAULT_RANKASLONG

See Also:

Constant Field Values

Constructor Detail

RankNodeModel

protected RankNodeModel()

Constructor for the node model.

Method Detail

createRankColumnsModel

static SettingsModelStringArray createRankColumnsModel()

createGroupColumnsModel

static SettingsModelStringArray createGroupColumnsModel()

createRankModeModel

static SettingsModelString createRankModeModel()

createRankOutColNameModel

static SettingsModelString createRankOutColNameModel()

createRetainRowOrderModel

static SettingsModelBoolean createRetainRowOrderModel()

createRankOrderModel

static SettingsModelStringArray createRankOrderModel()

createRankAsLongModel

static SettingsModelBoolean createRankAsLongModel()

execute

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

This function is invoked by the Node#executeNode() method of the node (through the #executeModel(BufferedDataTable[],ExecutionMonitor) method) only after all predecessor nodes have been successfully executed and all data is therefore available at the input ports. Implement this function with your task in the derived model.

The input data is available in the given array argument inData and is ensured to be neither null nor contain null elements (with few non-standard exception, which are described in more detail in NodeModel.execute(PortObject[], ExecutionContext)).

In order to create output data, you need to create objects of class BufferedDataTable. Use the execution context argument to create BufferedDataTable.

Overrides:

execute in class NodeModel

Parameters:

inData - An array holding DataTable elements, one for each input.

exec - The execution monitor for this execute method. It provides us with means to create new BufferedDataTable. Additionally, it should be asked frequently if the execution should be interrupted and throws an exception then. This exception might me caught, and then after closing all data streams, been thrown again. Also, if you can tell the progress of your task, just set it in this monitor.

Returns:

An array of non- null DataTable elements with the size of the number of outputs. The result of this execution.

Throws:

Exception - If you must fail the execution. Try to provide a meaningful error message in the exception as it will be displayed to the user.Please be advised to check frequently the canceled status by invoking ExecutionMonitor#checkCanceled which will throw an CanceledExcecutionException and abort the execution.

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.

Specified by:

reset in class NodeModel

configure

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

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.

(*)For nodes that support optional inputs or may have inactive outputs it's better to override NodeModel.configure(PortObjectSpec[]).

Implementation note: This method is called from the NodeModel.configure(PortObjectSpec[]) method unless that method is overwritten.

Overrides:

configure in class NodeModel

Parameters:

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.

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)

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)

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 internDir,
                             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.

Specified by:

loadInternals in class NodeModel

Parameters:

internDir - 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 internDir,
                             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.

Specified by:

saveInternals in class NodeModel

Parameters:

internDir - 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)