org.knime.core.node.workflow
Class MetaNodeDialogPane

java.lang.Object
  org.knime.core.node.NodeDialogPane
      org.knime.core.node.workflow.MetaNodeDialogPane

public final class MetaNodeDialogPane
extends NodeDialogPane

An empty dialog, which is used to create dialogs with only miscellaneous tabs (such as memory policy and job selector panel).

Author:

Bernd Wiswedel, University of Konstanz

Constructor Summary

MetaNodeDialogPane()
Constructor.

Method Summary

protected void	addFlowVariablesTab() Add the flow variables tab.
protected void	loadSettingsFrom(NodeSettingsRO settings, PortObjectSpec[] specs) Invoked before the dialog window is opened.
protected void	saveSettingsTo(NodeSettingsWO settings) Invoked when the settings need to be applied.
(package private) void	setQuickformNodes(Map<NodeID,QuickFormInputNode> nodes) Set quickform nodes into this dialog; called just before NodeDialogPane.loadSettingsFrom(NodeSettingsRO, org.knime.core.data.DataTableSpec[]) is called.

Methods inherited from class org.knime.core.node.NodeDialogPane

addJobMgrTab, addTab, addTabAt, closeOnESC, createFlowVariableModel, createFlowVariableModel, createFlowVariableModel, finishEditingAndSaveSettingsTo, getAvailableFlowVariables, getCredentialsNames, getCredentialsProvider, getPanel, getTab, getTabIndex, internalLoadSettingsFrom, isWriteProtected, loadSettingsFrom, loadSettingsFrom, onCancel, onClose, onOpen, removeTab, renameTab, saveSettingsTo, setEnabled, setSelected

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaNodeDialogPane

public MetaNodeDialogPane()

Constructor.

Method Detail

addFlowVariablesTab

protected void addFlowVariablesTab()

Add the flow variables tab. Override to disable this tab.

Overrides:

addFlowVariablesTab in class NodeDialogPane

setQuickformNodes

final void setQuickformNodes(Map<NodeID,QuickFormInputNode> nodes)

Set quickform nodes into this dialog; called just before NodeDialogPane.loadSettingsFrom(NodeSettingsRO, org.knime.core.data.DataTableSpec[]) is called.

Parameters:

nodes - the quickform nodes to show settings for

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)
                       throws InvalidSettingsException

Invoked when the settings need to be applied. The implementation should write the current user settings from its components into the passed object. It should not check consistency or completeness of the settings - this is part of the model's load method. The only situation this method would throw an exception is when a component contains an invalid value that can't be stored in the settings object.
The settings must be written in a way the model is able to load in, i.e. with the model's keys.

Specified by:

saveSettingsTo in class NodeDialogPane

Parameters:

settings - The settings object to write into.

Throws:

InvalidSettingsException - If the settings are not applicable to the model.

See Also:

NodeModel.loadSettingsFrom(NodeSettingsRO)

loadSettingsFrom

protected void loadSettingsFrom(NodeSettingsRO settings,
                                PortObjectSpec[] specs)
                         throws NotConfigurableException

Invoked before the dialog window is opened. The settings object passed, contains the current settings of the corresponding node model. The model and the dialog must agree on a mutual contract on how settings are stored in the spec. I.e. they must able to read each other's settings.

The implementation must be able to handle invalid or incomplete settings as the model may not have any reasonable values yet (for example when the dialog is opened for the first time). When an empty/invalid settings object is passed the dialog should set default values in its components.

Overrides:

loadSettingsFrom in class NodeDialogPane

Parameters:

settings - The settings to load into the dialog. Could be an empty object or contain invalid settings. But will never be null.

specs - The input data table specs. Items of the array could be null if no spec is available from the corresponding input port (i.e. not connected or upstream node does not produce an output spec). If a port is of type BufferedDataTable.TYPE and no spec is available the framework will replace null by an empty DataTableSpec (no columns) unless the port is marked as optional.

Throws:

NotConfigurableException - if the dialog cannot be opened because of real invalid settings or if any preconditions are not fulfilled, e.g. no predecessor node, no nominal column in input table, etc.

See Also:

NodeModel.loadSettingsFrom(NodeSettingsRO)