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

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

public class HistogramNodeModel
extends AbstractHistogramNodeModel

The NodeModel class of the interactive histogram plotter.

Author:

Tobias Koetter, University of Konstanz

Field Summary

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

HistogramNodeModel()

Method Summary

protected DataTableSpec[]	configure(PortObjectSpec[] inSpecs) Configure method for general port types.
protected void	createHistogramModel(ExecutionContext exec, int noOfRows, BufferedDataTable data) 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	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.

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

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

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

Constructor Detail

HistogramNodeModel

public HistogramNodeModel()

Method Detail

createHistogramModel

protected void createHistogramModel(ExecutionContext exec,
                                    int noOfRows,
                                    BufferedDataTable data)
                             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

data - the DataTable which contains the rows

Throws:

CanceledExecutionException - if the user has canceled the node 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.

Overrides:

reset in class AbstractHistogramNodeModel

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.

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