org.knime.core.node.defaultnodesettings
Class SettingsModelDoubleRange

java.lang.Object
  extended by org.knime.core.node.defaultnodesettings.SettingsModel
      extended by org.knime.core.node.defaultnodesettings.SettingsModelDoubleRange

public class SettingsModelDoubleRange
extends SettingsModel

Settings model for a double range [min, max]. It stores two floating point numbers. It ensures that the minimum is smaller than the maximum at any time.

Author:
M. Berthold, University of Konstanz

Constructor Summary
SettingsModelDoubleRange(String configName, double minRange, double maxRange)
          Create setting object.
 
Method Summary
protected  SettingsModelDoubleRange createClone()
          
protected  String getConfigName()
          
 double getMaxRange()
           
 double getMinRange()
           
protected  String getModelTypeID()
          Each settings model provides an ID which will be stored with its values.
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.
(package private)  void setMaxRange(double maxRange)
          Sets a new max value of the range.
(package private)  void setMinRange(double minRange)
          Sets a new min value of the range.
(package private)  void setRange(double newMin, double newMax)
          Sets a new min and a new max 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.)
 
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

SettingsModelDoubleRange

public SettingsModelDoubleRange(String configName,
                                double minRange,
                                double maxRange)
                         throws IllegalArgumentException
Create setting object.

Parameters:
configName - identifier in the config file.
minRange - minimum default minimum value
maxRange - maximum default maximum value
Throws:
IllegalArgumentException - if the specified configName is invalid
IllegalArgumentException - if the specified range is invalid
Method Detail

getMinRange

public double getMinRange()
Returns:
the current min value of the range

getMaxRange

public double getMaxRange()
Returns:
the current max value of the range.

setRange

void setRange(double newMin,
              double newMax)
        throws IllegalArgumentException
Sets a new min and a new max value.

Parameters:
newMin - the new min value
newMax - the new max value
Throws:
IllegalArgumentException - if the min is larger than the max or those numbers are not really numbers (NaN).

setMinRange

void setMinRange(double minRange)
           throws IllegalArgumentException
Sets a new min value of the range.

Parameters:
minRange - the new min vale of the range
Throws:
IllegalArgumentException - if the new min is larger than the current max
See Also:
setRange(double, double)

setMaxRange

void setMaxRange(double maxRange)
           throws IllegalArgumentException
Sets a new max value of the range.

Parameters:
maxRange - the new max value of the range
Throws:
IllegalArgumentException - if the current min is larger than the new max
See Also:
setRange(double, double)

createClone

protected SettingsModelDoubleRange createClone()

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

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.

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.

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

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.

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.

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

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.


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.