org.knime.core.node.defaultnodesettings
Class SettingsModelDouble

java.lang.Object
  extended by org.knime.core.node.defaultnodesettings.SettingsModel
      extended by org.knime.core.node.defaultnodesettings.SettingsModelNumber
          extended by org.knime.core.node.defaultnodesettings.SettingsModelDouble
All Implemented Interfaces:
SettingsModelFlowVariableCompatible
Direct Known Subclasses:
SettingsModelDoubleBounded

public class SettingsModelDouble
extends SettingsModelNumber
implements SettingsModelFlowVariableCompatible

A settingsmodel for double default components.

Author:
ohl, University of Konstanz

Constructor Summary
SettingsModelDouble(String configName, double defaultValue)
          Creates a new object holding a double value.
 
Method Summary
protected  SettingsModelDouble createClone()
          
protected  String getConfigName()
          
 double getDoubleValue()
           
 FlowVariable.Type getFlowVariableType()
          
 String getKey()
          
protected  String getModelTypeID()
          Each settings model provides an ID which will be stored with its values.
(package private)  String getNumberValueStr()
          
protected  void loadSettingsForDialog(NodeSettingsRO settings, PortObjectSpec[] specs)
          Read the value(s) of this settings model from configuration object.
protected  void loadSettingsForModel(NodeSettingsRO settings)
          Read value(s) of this settings model from the configuration object.
protected  void saveSettingsForDialog(NodeSettingsWO settings)
          Write value(s) of this component model to configuration object.
protected  void saveSettingsForModel(NodeSettingsWO settings)
          Write value(s) of this settings model to configuration object.
NOTE: Don't call this method directly, rather call saveSettingsTo.
 void setDoubleValue(double newValue)
          set the value stored to the new value.
(package private)  void setNumberValueStr(String newValueStr)
          Allows to set a new value by passing a string that will be parsed and, if valid, set as new value.
 String toString()
          Derived classes should print their class name plus the config name for nice and useful error messages.
protected  void validateSettingsForModel(NodeSettingsRO settings)
          Read the expected values from the settings object, without assigning them to the internal variables! (Is not called when the model was disabled at the time the settings were saved.)
protected  void validateValue(double value)
          Called during validateSettingsForModel(org.knime.core.node.NodeSettingsRO), can be overwritten by derived classes.
 
Methods inherited from class org.knime.core.node.defaultnodesettings.SettingsModel
addChangeListener, createCloneWithValidatedValue, dlgLoadSettingsFrom, dlgSaveSettingsTo, isEnabled, loadSettingsFrom, notifyChangeListeners, prependChangeListener, removeChangeListener, saveSettingsTo, setEnabled, validateSettings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SettingsModelDouble

public SettingsModelDouble(String configName,
                           double defaultValue)
Creates a new object holding a double value.

Parameters:
configName - the identifier the value is stored with in the NodeSettings object
defaultValue - the initial value
Method Detail

createClone

protected SettingsModelDouble createClone()

Specified by:
createClone in class SettingsModel
Returns:
a new instance of the same object with identical state and value(s).

getModelTypeID

protected String getModelTypeID()
Each settings model provides an ID which will be stored with its values. This is to ensure that the same type of model is used to read the values back. Otherwise an assertion will go off. Make sure to provide a unique ID - and to re-use that ID in all compatible models. IntegerModels for example should use the same ID as BoundedInteger models.

Specified by:
getModelTypeID in class SettingsModel
Returns:
a string that identifies all models that are able (and empowered) to read the values stored by this model.

getConfigName

protected String getConfigName()

Specified by:
getConfigName in class SettingsModel
Returns:
the name provided at settings model construction time. The id associated with the value.

setDoubleValue

public void setDoubleValue(double newValue)
set the value stored to the new value.

Parameters:
newValue - the new value to store.

getDoubleValue

public double getDoubleValue()
Returns:
the current value stored.

setNumberValueStr

void setNumberValueStr(String newValueStr)
Allows to set a new value by passing a string that will be parsed and, if valid, set as new value.

Specified by:
setNumberValueStr in class SettingsModelNumber
Parameters:
newValueStr - the new value to be set, as string representation

getNumberValueStr

String getNumberValueStr()

Specified by:
getNumberValueStr in class SettingsModelNumber
Returns:
a string representation of the current value

loadSettingsForDialog

protected void loadSettingsForDialog(NodeSettingsRO settings,
                                     PortObjectSpec[] specs)
                              throws NotConfigurableException
Read the value(s) of this settings model from configuration object. If the value is not stored in the config, the objects value must remain unchanged. Called only from within the components using this model. If the model is disabled it should not throw the exception.
This method must always notify change listeners!!
NOTE: Do not call this method directly, rather call dlgLoadSettingsFrom

Specified by:
loadSettingsForDialog in class SettingsModel
Parameters:
settings - The NodeSettings to read from.
specs - The input specs.
Throws:
NotConfigurableException - if the specs are not good enough to

saveSettingsForDialog

protected void saveSettingsForDialog(NodeSettingsWO settings)
                              throws InvalidSettingsException
Write value(s) of this component model to configuration object. Called only from within the components using this model.
NOTE: Don't call this method directly, rather use dlgSaveSettingsTo.

Specified by:
saveSettingsForDialog in class SettingsModel
Parameters:
settings - The NodeSettings to read from.
Throws:
InvalidSettingsException - if the user has entered wrong values.

validateSettingsForModel

protected void validateSettingsForModel(NodeSettingsRO settings)
                                 throws InvalidSettingsException
Read the expected values from the settings object, without assigning them to the internal variables! (Is not called when the model was disabled at the time the settings were saved.)

Specified by:
validateSettingsForModel in class SettingsModel
Parameters:
settings - the object to read the value(s) from
Throws:
InvalidSettingsException - if the value(s) in the settings object are invalid.

validateValue

protected void validateValue(double value)
                      throws InvalidSettingsException
Called during validateSettingsForModel(org.knime.core.node.NodeSettingsRO), can be overwritten by derived classes.

Parameters:
value - the value to validate
Throws:
InvalidSettingsException - if the value is not valid and should be rejected

loadSettingsForModel

protected void loadSettingsForModel(NodeSettingsRO settings)
                             throws InvalidSettingsException
Read value(s) of this settings model from the configuration object. If the value is not stored in the config, an exception will be thrown.
NOTE: Don't call this method directly, rather call loadSettingsFrom.

Specified by:
loadSettingsForModel in class SettingsModel
Parameters:
settings - The NodeSettings to read from.
Throws:
InvalidSettingsException - if load fails.

saveSettingsForModel

protected void saveSettingsForModel(NodeSettingsWO settings)
Write value(s) of this settings model to configuration object.
NOTE: Don't call this method directly, rather call saveSettingsTo.

Specified by:
saveSettingsForModel in class SettingsModel
Parameters:
settings - The NodeSettings to write into.

toString

public String toString()
Derived classes should print their class name plus the config name for nice and useful error messages. Like that,
return getClass().getSimpleName() + " ('" + m_configName + "')";

Specified by:
toString in class SettingsModel

getKey

public String getKey()

Specified by:
getKey in interface SettingsModelFlowVariableCompatible
Returns:
key of the settings object.

getFlowVariableType

public FlowVariable.Type getFlowVariableType()

Specified by:
getFlowVariableType in interface SettingsModelFlowVariableCompatible
Returns:
required type of the FlowVariable replacing these settings.


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.