Package org.knime.core.webui.node.dialog.defaultdialog

Class DefaultNodeSettingsServiceWithVariables

java.lang.Object

org.knime.core.webui.node.dialog.defaultdialog.DefaultNodeSettingsServiceWithVariables

All Implemented Interfaces:

NodeSettingsService

public final class DefaultNodeSettingsServiceWithVariables
extends Object
implements NodeSettingsService

A NodeSettingsService decorator that can be used to enable saving and loading flow variables of NodeDialog using the DefaultNodeDialog.getPage() page.

Author:

Paul Bärnreuther

Constructor Summary

Constructors

Constructor	Description
DefaultNodeSettingsServiceWithVariables(NodeSettingsService delegate)	Constructor

Method Summary

Modifier and Type	Method	Description
String	fromNodeSettings(Map<SettingsType,NodeAndVariableSettingsRO> settings, org.knime.core.node.port.PortObjectSpec[] specs)	Called when a dialog is initialized.
void	toNodeSettings(String textSettings, Map<SettingsType,NodeAndVariableSettingsWO> settings)	Called when dialog settings are applied.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.knime.core.webui.node.dialog.NodeSettingsService

deactivate, validateNodeSettingsAndVariables

Constructor Details

DefaultNodeSettingsServiceWithVariables

public DefaultNodeSettingsServiceWithVariables(NodeSettingsService delegate)

Constructor

Parameters:

delegate - that will be used after saving and before loading the flow variable settings.

Method Details

toNodeSettings

public void toNodeSettings(String textSettings,
 Map<SettingsType,NodeAndVariableSettingsWO> settings)

Description copied from interface: NodeSettingsService

Called when dialog settings are applied. Translates text-based settings to NodeAndVariableSettingsWO-instances of certain SettingsType.

Specified by:

toNodeSettings in interface NodeSettingsService

Parameters:

textSettings - the text-based settings object

settings - the settings instances to write into

fromNodeSettings

public String fromNodeSettings(Map<SettingsType,NodeAndVariableSettingsRO> settings,
 org.knime.core.node.port.PortObjectSpec[] specs)

Description copied from interface: NodeSettingsService

Called when a dialog is initialized. Infers a single text-based settings representation from possibly multiple NodeAndVariableSettingsRO-instances (one per SettingsType).

Specified by:

fromNodeSettings in interface NodeSettingsService

Parameters:

settings - the settings to read from; if there are no settings with the node stored, yet, the default node settings will be supplied (see #getDefaultNodeSettings(Map, PortObjectSpec[]))

specs - the specs for configuring the settings (includes the flow variable port). NOTE: can contain null-values, e.g., in case an input port is not connected

Returns:

a new text-based settings representation