org.knime.base.node.viz.histogram.node
Class FixedColumnHistogramNodeModel

java.lang.Object
  org.knime.core.node.NodeModel
      org.knime.base.node.viz.histogram.node.AbstractHistogramNodeModel
          org.knime.base.node.viz.histogram.node.FixedColumnHistogramNodeModel

public class FixedColumnHistogramNodeModel
extends AbstractHistogramNodeModel

The NodeModel class of the histogram plotter.

Author:

Tobias Koetter, University of Konstanz

Field Summary

protected static String

CFGKEY_NO_OF_BINS The number of bins configuration key.

Fields inherited from class org.knime.base.node.viz.histogram.node.AbstractHistogramNodeModel

CFG_DATA_DIR_NAME, CFGKEY_AGGR_COLNAME, CFGKEY_ALL_ROWS, CFGKEY_NO_OF_ROWS, CFGKEY_X_COLNAME, DEFAULT_NO_OF_ROWS

Constructor Summary

protected

FixedColumnHistogramNodeModel() The constructor.

Method Summary

protected DataTableSpec[]	configure(PortObjectSpec[] inSpecs) Configure method for general port types.
protected void	createHistogramModel(ExecutionContext exec, int noOfRows, BufferedDataTable table) This method should use the given information to create the internal histogram data model.
protected AbstractHistogramVizModel	getHistogramVizModel() This method creates a new AbstractHistogramVizModel each time it is called.
protected void	loadHistogramInternals(File dataDir, ExecutionMonitor exec) Called from the AbstractHistogramNodeModel.loadInternals(File, ExecutionMonitor) method to let the histogram implementation load own internal data.
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	saveHistogramInternals(File dataDir, ExecutionMonitor exec) Called from the AbstractHistogramNodeModel.saveInternals(File, ExecutionMonitor) method to let the histogram implementation save own internal data.
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.base.node.viz.histogram.node.AbstractHistogramNodeModel

execute, getAggrColumns, getSelectedXColumnName, getTableSpec, getXColIdx, getXColSpec, loadInternals, saveInternals, setAllRowsDefault, setSelectedAggrColumns, setSelectedXColumnName

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

CFGKEY_NO_OF_BINS

protected static final String CFGKEY_NO_OF_BINS

The number of bins configuration key.

See Also:

Constant Field Values

Constructor Detail

FixedColumnHistogramNodeModel

protected FixedColumnHistogramNodeModel()

The constructor.

Method Detail

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.

Overrides:

validateSettings in class AbstractHistogramNodeModel

Parameters:

settings - The settings to validate.

Throws:

InvalidSettingsException - If the validation of the settings failed.

See Also:

NodeModel.saveSettingsTo(NodeSettingsWO), NodeModel.loadValidatedSettingsFrom(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.

Overrides:

loadValidatedSettingsFrom in class AbstractHistogramNodeModel

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.

Overrides:

saveSettingsTo in class AbstractHistogramNodeModel

Parameters:

settings - The object to write settings into.

See Also:

NodeModel.loadValidatedSettingsFrom(NodeSettingsRO), NodeModel.validateSettings(NodeSettingsRO)

createHistogramModel

protected void createHistogramModel(ExecutionContext exec,
                                    int noOfRows,
                                    BufferedDataTable table)
                             throws CanceledExecutionException

This method should use the given information to create the internal histogram data model.

Specified by:

createHistogramModel in class AbstractHistogramNodeModel

Parameters:

exec - the ExecutionContext for progress information

noOfRows - the number of rows to display

table - the DataTable which contains the rows

Throws:

CanceledExecutionException - if the user has canceled the node execution

configure

protected DataTableSpec[] 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. 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.

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 AbstractHistogramNodeModel

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.

Returns:

The output objects specs or null.

Throws:

InvalidSettingsException - If this node can't be configured.

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 AbstractHistogramNodeModel

getHistogramVizModel

protected AbstractHistogramVizModel getHistogramVizModel()

This method creates a new AbstractHistogramVizModel each time it is called.

Specified by:

getHistogramVizModel in class AbstractHistogramNodeModel

Returns:

the histogram viz model or null if not all information are available yet

loadHistogramInternals

protected void loadHistogramInternals(File dataDir,
                                      ExecutionMonitor exec)
                               throws Exception

Called from the AbstractHistogramNodeModel.loadInternals(File, ExecutionMonitor) method to let the histogram implementation load own internal data.

Specified by:

loadHistogramInternals in class AbstractHistogramNodeModel

Parameters:

dataDir - the directory to write to

exec - the ExecutionMonitor to provide progress message

Throws:

Exception - if an exception occurs

saveHistogramInternals

protected void saveHistogramInternals(File dataDir,
                                      ExecutionMonitor exec)
                               throws Exception

Called from the AbstractHistogramNodeModel.saveInternals(File, ExecutionMonitor) method to let the histogram implementation save own internal data.

Specified by:

saveHistogramInternals in class AbstractHistogramNodeModel

Parameters:

dataDir - the directory to write to

exec - the ExecutionMonitor to provide progress message

Throws:

Exception - if an exception occurs