org.knime.base.node.viz.table
Class TableNodeModel

java.lang.Object
  org.knime.core.node.NodeModel
      org.knime.base.node.viz.table.TableNodeModel

All Implemented Interfaces:

BufferedDataTableHolder

public class TableNodeModel
extends NodeModel
implements BufferedDataTableHolder

Node model for a table view. This class is implemented in first place to comply with the model-view-controller concept. Thus, this implementation does not have any further functionality than its super class NodeModel. The content itself resides in TableContentModel.

Author:

Bernd Wiswedel, University of Konstanz

See Also:

TableContentModel

Field Summary

protected static int

INPORT Index of the input port (only one anyway).

Constructor Summary

	TableNodeModel() Constructs a new (but empty) model.
protected	TableNodeModel(PortType[] inPortTypes) Subclass constructor which overrides the port types.

Method Summary

protected DataTableSpec[]	configure(DataTableSpec[] inSpecs) This function is called whenever the derived model should re-configure its output DataTableSpecs.
protected BufferedDataTable[]	execute(BufferedDataTable[] data, ExecutionContext exec) Called when new data is available.
TableContentModel	getContentModel() Get reference to the underlying content model.
BufferedDataTable[]	getInternalTables()
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.
void	setInternalTables(BufferedDataTable[] tables) Allows the WorkflowManager to set information about new BDTs, for instance after load.
protected void	validateSettings(NodeSettingsRO settings) Validates the settings in the passed NodeSettings object.

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

addWarningListener, configure, continueLoop, execute, executeModel, getAvailableFlowVariables, getCredentialsProvider, getInHiLiteHandler, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutgoingFlowObjectStack, getOutHiLiteHandler, getWarningMessage, notifyViews, notifyWarningListeners, onDispose, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, peekScopeVariableDouble, peekScopeVariableInt, peekScopeVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, pushScopeVariableDouble, pushScopeVariableInt, pushScopeVariableString, 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

INPORT

protected static final int INPORT

Index of the input port (only one anyway).

See Also:

Constant Field Values

Constructor Detail

TableNodeModel

public TableNodeModel()

Constructs a new (but empty) model. The model has one input port and no output port.

TableNodeModel

protected TableNodeModel(PortType[] inPortTypes)

Subclass constructor which overrides the port types. Subclasses must also override the execute and configure methods.

Parameters:

inPortTypes - the input port types

Method Detail

getContentModel

public TableContentModel getContentModel()

Get reference to the underlying content model. This model will be the same for successive calls and never be null.

Returns:

reference to underlying content model

execute

protected BufferedDataTable[] execute(BufferedDataTable[] data,
                                      ExecutionContext exec)

Called when new data is available. Accesses the input data table and the property handler, sets them in the TableContentModel and starts event firing to inform listeners. Do not call this method separately, it is invoked by this model's node.

Overrides:

execute in class NodeModel

Parameters:

data - the data table at the (single) input port, wrapped in a one-dimensional array

exec - the execution monitor

Returns:

an empty table

See Also:

NodeModel.execute(BufferedDataTable[],ExecutionContext)

loadInternals

protected void loadInternals(File internDir,
                             ExecutionMonitor exec)
                      throws IOException

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.

See Also:

NodeModel.saveInternals(File,ExecutionMonitor)

saveInternals

protected void saveInternals(File internDir,
                             ExecutionMonitor exec)
                      throws IOException

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.

See Also:

NodeModel.loadInternals(File,ExecutionMonitor)

getInternalTables

public BufferedDataTable[] getInternalTables()

Specified by:

getInternalTables in interface BufferedDataTableHolder

Returns:

array of BDTs which are held and used internally.

setInternalTables

public void setInternalTables(BufferedDataTable[] tables)

Allows the WorkflowManager to set information about new BDTs, for instance after load.

Specified by:

setInternalTables in interface BufferedDataTableHolder

Parameters:

tables - the array of new tables

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)

This function is called whenever the derived model should re-configure its output DataTableSpecs. 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.

The passed DataTableSpec elements are never null but can be empty. The model may return null data table spec(s) for the outputs. But still, the model may be in an executable state. 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.

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.

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)