org.knime.base.node.mine.scorer.entrop

Class EntropyNodeDialogPane

java.lang.Object

org.knime.core.node.NodeDialogPane

org.knime.base.node.mine.scorer.entrop.EntropyNodeDialogPane

public class EntropyNodeDialogPane
extends NodeDialogPane

This class represents the dialog for the entropy scorer node.

Author:

Bernd Wiswedel, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
EntropyNodeDialogPane() Creates a new dialog for the entropy scorer.
EntropyNodeDialogPane(boolean flowVar) The dialog for the entropy scorer.

Method Summary

Modifier and Type	Method and Description
static SettingsModelString	createFlowPrefixModel(SettingsModelBoolean useNamePrefixModel)
protected void	loadSettingsFrom(NodeSettingsRO settings, DataTableSpec[] specs) Invoked before the dialog window is opened.
protected void	saveSettingsTo(NodeSettingsWO settings) Invoked when the settings need to be applied.

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

addFlowVariablesTab, addJobMgrTab, addTab, addTab, addTabAt, addTabAt, callOnCancel, callOnClose, closeOnESC, createFlowVariableModel, createFlowVariableModel, createFlowVariableModel, finishEditingAndSaveSettingsTo, getAvailableFlowVariables, getCredentialsNames, getCredentialsProvider, getLogger, getNodeContext, getPanel, getTab, getTabIndex, 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

EntropyNodeDialogPane

public EntropyNodeDialogPane()

Creates a new dialog for the entropy scorer.

EntropyNodeDialogPane

public EntropyNodeDialogPane(boolean flowVar)

The dialog for the entropy scorer.

Parameters:

flowVar - whether the flow variable dialog options should be displayed or not

Since:

3.2 Added support for flow variable output, by using new flag

Method Detail

createFlowPrefixModel

public static SettingsModelString createFlowPrefixModel(SettingsModelBoolean useNamePrefixModel)

Parameters:

useNamePrefixModel - TODO

Returns:

A new SettingsModelString for the flow variable prefix

Since:

3.2 Creates the settings model for the flow variable prefix

loadSettingsFrom

protected void loadSettingsFrom(NodeSettingsRO settings,
                                DataTableSpec[] 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. If no spec is available for any given port (because the port is not connected or the previous node does not produce a spec) the framework will pass an empty DataTableSpec (no columns) unless the port is marked as optional (in which case the array element is null).

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)

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)