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

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.viz.histogram.node.AbstractHistogramNodeModel
Direct Known Subclasses:
FixedColumnHistogramNodeModel, HistogramNodeModel

public abstract class AbstractHistogramNodeModel
extends NodeModel

Author:
Tobias Koetter, University of Konstanz

Field Summary
static String CFG_DATA_DIR_NAME
          The name of the directory which holds the optional data of the different histogram implementations.
protected static String CFGKEY_AGGR_COLNAME
          Settings name of the aggregation column name.
protected static String CFGKEY_ALL_ROWS
          Settings name for the take all rows select box.
protected static String CFGKEY_NO_OF_ROWS
          Settings name of the number of rows.
protected static String CFGKEY_X_COLNAME
          Used to store the attribute column name in the settings.
protected static int DEFAULT_NO_OF_ROWS
          Default number of rows to use.
 
Constructor Summary
AbstractHistogramNodeModel()
          Constructor for class AbstractHistogramNodeModel.
 
Method Summary
protected  DataTableSpec[] configure(PortObjectSpec[] inSpecs)
          Configure method for general port types.
protected abstract  void createHistogramModel(ExecutionContext exec, int noOfRows, BufferedDataTable table)
          This method should use the given information to create the internal histogram data model.
protected  PortObject[] execute(PortObject[] inData, ExecutionContext exec)
          Execute method for general port types.
protected  Collection<ColorColumn> getAggrColumns()
           
protected abstract  AbstractHistogramVizModel getHistogramVizModel()
          This method creates a new AbstractHistogramVizModel each time it is called.
protected  String getSelectedXColumnName()
           
protected  DataTableSpec getTableSpec()
           
protected  int getXColIdx()
           
protected  DataColumnSpec getXColSpec()
           
protected abstract  void loadHistogramInternals(File dataDir, ExecutionMonitor exec)
          Called from the loadInternals(File, ExecutionMonitor) method to let the histogram implementation load own internal data.
protected  void loadInternals(File nodeInternDir, 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 abstract  void saveHistogramInternals(File dataDir, ExecutionMonitor exec)
          Called from the saveInternals(File, ExecutionMonitor) method to let the histogram implementation save own internal data.
protected  void saveInternals(File nodeInternDir, ExecutionMonitor exec)
          Save internals of the derived NodeModel.
protected  void saveSettingsTo(NodeSettingsWO settings)
          Adds to the given NodeSettings the model specific settings.
protected  void setAllRowsDefault(boolean allRows)
           
protected  void setSelectedAggrColumns(ColorColumn... aggrCols)
           
protected  void setSelectedXColumnName(String name)
           
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, getInHiLiteHandler, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getWarningMessage, notifyViews, notifyWarningListeners, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, peekScopeVariableDouble, peekScopeVariableInt, peekScopeVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, pushScopeVariableDouble, pushScopeVariableInt, pushScopeVariableString, removeWarningListener, setInHiLiteHandler, setWarningMessage, stateChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_NO_OF_ROWS

protected static final int DEFAULT_NO_OF_ROWS
Default number of rows to use.

See Also:
Constant Field Values

CFGKEY_ALL_ROWS

protected static final String CFGKEY_ALL_ROWS
Settings name for the take all rows select box.

See Also:
Constant Field Values

CFGKEY_NO_OF_ROWS

protected static final String CFGKEY_NO_OF_ROWS
Settings name of the number of rows.

See Also:
Constant Field Values

CFGKEY_X_COLNAME

protected static final String CFGKEY_X_COLNAME
Used to store the attribute column name in the settings.

See Also:
Constant Field Values

CFGKEY_AGGR_COLNAME

protected static final String CFGKEY_AGGR_COLNAME
Settings name of the aggregation column name.

See Also:
Constant Field Values

CFG_DATA_DIR_NAME

public static final String CFG_DATA_DIR_NAME
The name of the directory which holds the optional data of the different histogram implementations.

See Also:
Constant Field Values
Constructor Detail

AbstractHistogramNodeModel

public AbstractHistogramNodeModel()
Constructor for class AbstractHistogramNodeModel.

Method Detail

setAllRowsDefault

protected void setAllRowsDefault(boolean allRows)
Parameters:
allRows - set the default value of the all rows select box.

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)

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)

loadInternals

protected void loadInternals(File nodeInternDir,
                             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:
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.
See Also:
NodeModel.saveInternals(File,ExecutionMonitor)

loadHistogramInternals

protected abstract void loadHistogramInternals(File dataDir,
                                               ExecutionMonitor exec)
                                        throws Exception
Called from the loadInternals(File, ExecutionMonitor) method to let the histogram implementation load own internal data.

Parameters:
dataDir - the directory to write to
exec - the ExecutionMonitor to provide progress message
Throws:
Exception - if an exception occurs

saveInternals

protected void saveInternals(File nodeInternDir,
                             ExecutionMonitor exec)
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.
See Also:
NodeModel.loadInternals(File,ExecutionMonitor)

saveHistogramInternals

protected abstract void saveHistogramInternals(File dataDir,
                                               ExecutionMonitor exec)
                                        throws Exception
Called from the saveInternals(File, ExecutionMonitor) method to let the histogram implementation save own internal data.

Parameters:
dataDir - the directory to write to
exec - the ExecutionMonitor to provide progress message
Throws:
Exception - if an exception occurs

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

getHistogramVizModel

protected abstract AbstractHistogramVizModel getHistogramVizModel()
This method creates a new AbstractHistogramVizModel each time it is called.

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

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 NodeModel
Parameters:
inSpecs - The input object specs.
Returns:
The output objects specs or null.
Throws:
InvalidSettingsException - If this node can't be configured.

execute

protected PortObject[] execute(PortObject[] inData,
                               ExecutionContext exec)
                        throws Exception
Execute method for general port types. The argument objects represent the input objects and are guaranteed to be subclasses of the PortObject classes that are defined through the PortTypes given in the constructor. Similarly, the returned output objects need to comply with their port types object class (otherwise an error is reported by the framework).

For a general description of the execute method refer to the description of the specialized NodeModel.execute(BufferedDataTable[], ExecutionContext) methods as it addresses more use cases.

Overrides:
execute in class NodeModel
Parameters:
inData - The input objects.
exec - For BufferedDataTable creation and progress.
Returns:
The output objects.
Throws:
Exception - If the node execution fails for any reason.

createHistogramModel

protected abstract void createHistogramModel(ExecutionContext exec,
                                             int noOfRows,
                                             BufferedDataTable table)
                                      throws CanceledExecutionException
This method should use the given information to create the internal histogram data model.

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

getTableSpec

protected DataTableSpec getTableSpec()
Returns:
the DataTableSpec of the input table

getAggrColumns

protected Collection<ColorColumn> getAggrColumns()
Returns:
the aggregation columns to use or null if the user hasn't selected a aggregation column

getSelectedXColumnName

protected String getSelectedXColumnName()
Returns:
the name of the selected x column or null if none is selected

setSelectedXColumnName

protected void setSelectedXColumnName(String name)
Parameters:
name - the new selected x column name

setSelectedAggrColumns

protected void setSelectedAggrColumns(ColorColumn... aggrCols)
Parameters:
aggrCols - the new selected aggregation column

getXColSpec

protected DataColumnSpec getXColSpec()
Returns:
the DataColumnSpec of the selected x column

getXColIdx

protected int getXColIdx()
Returns:
the index of the selected x column in the given DataTableSpec


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.