org.knime.core.node
Class NoSettingsNodeModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.core.node.NoSettingsNodeModel

public abstract class NoSettingsNodeModel
extends NodeModel

Convenience model class that make some empty stub implementations of methods that are not used by nodes that are not configurable (e.g. have no settings)

Author:
Florian Georg, University of Konstanz

Constructor Summary
protected NoSettingsNodeModel(int nrInputs, int nrOutputs)
          Creates a NodeModel based on data in- and outports.
 
Method Summary
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 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.core.node.NodeModel
addWarningListener, clearLoopStatus, configure, configure, configureModel, continueLoop, execute, execute, executeModel, getFlowObjectStack, getInHiLiteHandler, getInPortType, getLoopEndNode, getLoopStartNode, getLoopStatus, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getOutPortType, getSimulatedHiliteHandlerPortIndex, getTrueHiliteHandlerPortIndex, getViews, getWarningMessage, hasContent, loadInternals, loadSettingsFrom, notifyViews, notifyWarningListeners, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, peekScopeVariableDouble, peekScopeVariableInt, peekScopeVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, pushScopeVariableDouble, pushScopeVariableInt, pushScopeVariableString, registerView, removeWarningListener, resetModel, restoreWarningMessage, saveInternals, setFlowObjectStack, setHasContent, setInHiLiteHandler, setLoopEndNode, setLoopStartNode, setNewInHiLiteHandler, setWarningMessage, stateChanged, unregisterAllViews, unregisterView
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NoSettingsNodeModel

protected NoSettingsNodeModel(int nrInputs,
                              int nrOutputs)
Creates a NodeModel based on data in- and outports.

Parameters:
nrInputs - number of in ports
nrOutputs - number of out ports
Method Detail

saveSettingsTo

protected final 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 final 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 final 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)

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


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.