org.knime.core.node.defaultnodesettings

Class SettingsModelDuration

java.lang.Object

org.knime.core.node.defaultnodesettings.SettingsModel

org.knime.core.node.defaultnodesettings.SettingsModelDuration

public class SettingsModelDuration
extends SettingsModel

The SettingsModel for the default time dialog component.

Since:

3.3

Author:

Ole Ostergaard, KNIME.com GmbH

Field Summary

Fields inherited from class org.knime.core.node.defaultnodesettings.SettingsModel

CFGKEY_INTERNAL

Constructor Summary

Constructors

Constructor and Description
SettingsModelDuration(String configName) Creates a new object holding with default values 0 days, 0 hours, 0 minutes, 0 seconds
SettingsModelDuration(String configName, Duration duration) Create a new object with the given values for days, hours, minutes, seconds

Method Summary

Modifier and Type	Method and Description
protected SettingsModelDuration	createClone()
protected String	getConfigName()
Duration	getDuration() Returns the total duration
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.
void	setDuration(Duration duration)
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

SettingsModelDuration

public SettingsModelDuration(String configName)

Creates a new object holding with default values 0 days, 0 hours, 0 minutes, 0 seconds

Parameters:

configName - the identifier the value is stored with in the NodeSettings object

SettingsModelDuration

public SettingsModelDuration(String configName,
                             Duration duration)

Create a new object with the given values for days, hours, minutes, seconds

Parameters:

configName - the identifier the value is stored with in the org.knime.core.node NodeSettings object

duration - The initial duration value

Method Detail

createClone

protected SettingsModelDuration 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.

getDuration

public Duration getDuration()

Returns the total duration

Returns:

the total duration

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.

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

setDuration

public void setDuration(Duration duration)

Parameters:

duration -