org.knime.core.node.defaultnodesettings
Class DialogComponent.EmptySettingsModel

java.lang.Object
  org.knime.core.node.defaultnodesettings.SettingsModel
      org.knime.core.node.defaultnodesettings.DialogComponent.EmptySettingsModel

Enclosing class:

DialogComponent

protected static final class DialogComponent.EmptySettingsModel
extends SettingsModel

------------------------------------------------------------------------- Components deriving from DialogComponent can use this model if they don't need or want to store any value (but are only displaying stuff). Do not call any of the methods of this model. No value will be stored in this model, no value will be saved or loaded. You cannot change the value of the component through this model.

Author:

ohl, University of Konstanz

Constructor Summary

DialogComponent.EmptySettingsModel()
Creates an empty settings model, that will not hold any value.

Method Summary

void	addChangeListener(ChangeListener l) Adds a listener (to the end of the listener list) which is notified, whenever a new values is set in the model or the enable status changes.
protected DialogComponent.EmptySettingsModel	createClone()
protected String	getConfigName()
protected String	getModelTypeID() Each settings model provides an ID which will be stored with its values.
boolean	isEnabled()
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	notifyChangeListeners() Notifies all registered listeners about a new model content.
protected void	prependChangeListener(ChangeListener l) Adds a listener (to the beginning of the listener list) which is notified, whenever a new values is set in the model or the enable status changes.
void	removeChangeListener(ChangeListener l) Remove a specific listener.
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	setEnabled(boolean enabled) Sets the enabled status of the model.
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

createCloneWithValidatedValue, dlgLoadSettingsFrom, dlgSaveSettingsTo, loadSettingsFrom, saveSettingsTo, validateSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DialogComponent.EmptySettingsModel

public DialogComponent.EmptySettingsModel()

Creates an empty settings model, that will not hold any value.

Method Detail

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

addChangeListener

public void addChangeListener(ChangeListener l)

Adds a listener (to the end of the listener list) which is notified, whenever a new values is set in the model or the enable status changes. Does nothing if the listener is already registered.

Overrides:

addChangeListener in class SettingsModel

Parameters:

l - listener to add.

prependChangeListener

protected void prependChangeListener(ChangeListener l)

Adds a listener (to the beginning of the listener list) which is notified, whenever a new values is set in the model or the enable status changes. Does nothing if the listener is already registered.

Overrides:

prependChangeListener in class SettingsModel

Parameters:

l - listener to add.

notifyChangeListeners

protected void notifyChangeListeners()

Notifies all registered listeners about a new model content. Call this, whenever the value in the model changes!

Overrides:

notifyChangeListeners in class SettingsModel

removeChangeListener

public void removeChangeListener(ChangeListener l)

Remove a specific listener.

Overrides:

removeChangeListener in class SettingsModel

Parameters:

l - listener to remove.

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class SettingsModel

Returns:

the current enable status of the model.

See Also:

SettingsModel.setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled status of the model. If a model is disabled it doesn't validate new values or save it's current value into a settings object. Also loading will be skipped. (The model does store its enable status in the settings object though.)

Overrides:

setEnabled in class SettingsModel

Parameters:

enabled - the new enable status. If true the model saves/validates/loads its value, if false, all these operations are skipped.

createClone

protected DialogComponent.EmptySettingsModel 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.

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.