org.knime.core.node.defaultnodesettings
Class SettingsModelString

java.lang.Object
  org.knime.core.node.defaultnodesettings.SettingsModel
      org.knime.core.node.defaultnodesettings.SettingsModelString

All Implemented Interfaces:

SettingsModelFlowVariableCompatible

Direct Known Subclasses:

SettingsModelColumnName, SettingsModelOptionalString

public class SettingsModelString
extends SettingsModel
implements SettingsModelFlowVariableCompatible

Author:

ohl, University of Konstanz

Constructor Summary

SettingsModelString(String configName, String defaultValue)
Creates a new object holding a string value.

Method Summary

protected SettingsModelString	createClone()
protected String	getConfigName()
FlowVariable.Type	getFlowVariableType()
String	getKey()
protected String	getModelTypeID() Each settings model provides an ID which will be stored with its values.
String	getStringValue()
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	setStringValue(String newValue) set the value stored to the 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.)

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

SettingsModelString

public SettingsModelString(String configName,
                           String defaultValue)

Creates a new object holding a string value.

Parameters:

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

defaultValue - the initial value

Method Detail

createClone

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

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.

setStringValue

public void setStringValue(String newValue)

set the value stored to the new value.

Parameters:

newValue - the new value to store.

getStringValue

public String getStringValue()

Returns:

the current value stored.

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

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.