org.knime.base.node.viz.plotter.node
Class DefaultVisualizationNodeModel

java.lang.Object
  org.knime.core.node.NodeModel
      org.knime.base.node.viz.plotter.node.DefaultVisualizationNodeModel

All Implemented Interfaces:

DataProvider

public class DefaultVisualizationNodeModel
extends NodeModel
implements DataProvider

Implementation of a NodeModel which provides all functionality that is needed for a default plotter implementation. That is: converting the incoming data of inport 0 into a DataArray with the maximum number of rows specified in the DefaultVisualizationNodeDialog, loading and saving this DataArray in the load- and saveInternals and providing it via the getDataArray(int) method of the DataProvider interface.

Author:

Fabian Dill, University of Konstanz

Field Summary

static String	CFG_ANTIALIAS Config key for dis- or enabling antialiasing.
static String	CFG_END Config key for the last displayed row.
static String	CFG_MAX_NOMINAL Config key for the maximal number of nominal values.
(package private) static int	DEFAULT_NR_NOMINAL_VALUES Per default columns with nominal values more than this value are ignored.

Fields inherited from interface org.knime.base.node.viz.plotter.DataProvider

END, START

Constructor Summary

DefaultVisualizationNodeModel()
Creates a NodeModel with one data inport and no outport.

DefaultVisualizationNodeModel(int nrInports, int nrOutports)
Constructor for extending classes to define an arbitrary number of in- and outports.

Method Summary

protected DataTableSpec[]	configure(DataTableSpec[] inSpecs) All nominal columns without possible values or with more than 60 possible values are ignored.
(package private) static SettingsModelIntegerBounded	createLastDisplayedRowModel(int end)
(package private) static SettingsModelIntegerBounded	createMaxNominalValuesModel()
protected BufferedDataTable[]	execute(BufferedDataTable[] inData, ExecutionContext exec) Converts the input data at inport 0 into a DataArray with maximum number of rows as defined in the DefaultVisualizationNodeDialog.
DataArray	getDataArray(int index) Provides the data that should be visualized.
int	getEndIndex()
int[]	getExcludedColumns()
protected void	loadInternals(File nodeInternDir, ExecutionMonitor exec) Loads the converted DataArray.
protected void	loadValidatedSettingsFrom(NodeSettingsRO settings) Loads the maximum number of rows.
protected void	reset() Sets the input data null.
protected void	saveInternals(File nodeInternDir, ExecutionMonitor exec) Saves the converted DataArray.
protected void	saveSettingsTo(NodeSettingsWO settings) Saves the maximum number of rows.
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

CFG_END

public static final String CFG_END

Config key for the last displayed row.

See Also:

Constant Field Values

CFG_ANTIALIAS

public static final String CFG_ANTIALIAS

Config key for dis- or enabling antialiasing.

See Also:

Constant Field Values

CFG_MAX_NOMINAL

public static final String CFG_MAX_NOMINAL

Config key for the maximal number of nominal values.

See Also:

Constant Field Values

DEFAULT_NR_NOMINAL_VALUES

static final int DEFAULT_NR_NOMINAL_VALUES

Per default columns with nominal values more than this value are ignored.

See Also:

Constant Field Values

Constructor Detail

DefaultVisualizationNodeModel

public DefaultVisualizationNodeModel()

Creates a NodeModel with one data inport and no outport.

DefaultVisualizationNodeModel

public DefaultVisualizationNodeModel(int nrInports,
                                     int nrOutports)

Constructor for extending classes to define an arbitrary number of in- and outports.

Parameters:

nrInports - number of data inports

nrOutports - number of data outports

Method Detail

createMaxNominalValuesModel

static SettingsModelIntegerBounded createMaxNominalValuesModel()

Returns:

the settings model for max nominal values

createLastDisplayedRowModel

static SettingsModelIntegerBounded createLastDisplayedRowModel(int end)

Parameters:

end - The last row index to display.

Returns:

settings model for the max row count property.

getDataArray

public DataArray getDataArray(int index)

Provides the data that should be visualized. The index can be used, if a NodeModel has two inports and both data should be visualized. Then the index provides means to determine which DataArray should be returned.

Specified by:

getDataArray in interface DataProvider

Parameters:

index - if the data of more than one data table should be visualized.

Returns:

the data as a data array.

configure

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

All nominal columns without possible values or with more than 60 possible values are ignored. A warning is set if so. 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.

Throws:

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

execute

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

Converts the input data at inport 0 into a DataArray with maximum number of rows as defined in the DefaultVisualizationNodeDialog. Thereby nominal columns are irgnored whose possible values are null or more than 60. 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.

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.

loadInternals

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

Loads the converted DataArray. 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:

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)

loadValidatedSettingsFrom

protected void loadValidatedSettingsFrom(NodeSettingsRO settings)
                                  throws InvalidSettingsException

Loads the maximum number of rows. 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)

reset

protected void reset()

Sets the input data null. 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

saveInternals

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

Saves the converted DataArray. 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:

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)

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)

Saves the maximum number of rows. 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)

getExcludedColumns

public int[] getExcludedColumns()

Returns:

the excluded column indices

getEndIndex

public int getEndIndex()

Returns:

the last row index