org.knime.core.node
Class NodeSettings

java.lang.Object
  org.knime.core.node.config.base.AbstractConfigEntry
      org.knime.core.node.config.base.ConfigBase
          org.knime.core.node.config.Config
              org.knime.core.node.NodeSettings

All Implemented Interfaces:

Serializable, Iterable<String>, TreeNode, ConfigBaseRO, ConfigBaseWO, ConfigRO, ConfigWO, NodeSettingsRO, NodeSettingsWO

public final class NodeSettings
extends Config
implements NodeSettingsRO, NodeSettingsWO

This class overwrites the general Config object and specializes some method to access NodeSettings object. This object is used within the node packages.

Author:

Thomas Gabriel, University of Konstanz

See Also:

Serialized Form

Constructor Summary

NodeSettings(String key)
Creates a new instance of this object with the given key.

Method Summary

void	addNodeSettings(NodeSettings settings) Add the given NodeSettings object to this Config using the key of the argument's NodeSettings.
NodeSettingsWO	addNodeSettings(String key) Creates new NodeSettingsWO object for the given key and returns it.
void	copyTo(ConfigWO dest) Makes a deep copy of this Config and all sub-configs.
Config	getInstance(String key) Creates a new Config of this type.
NodeSettings	getNodeSettings(String key) Returns a read-only NodeSettingsRO object from this config.
static NodeSettingsRO	loadFromXML(InputStream in) Reads NodeSettings object from a given XML input stream and writes them into the given NodeSettings object.
static NodeSettings	readFromFile(ObjectInputStream ois)

Methods inherited from class org.knime.core.node.config.Config

addConfig, addConfig, addDataCell, addDataCellArray, addDataType, addDataTypeArray, addEntry, addRowKey, addRowKeyArray, getConfig, getDataCell, getDataCell, getDataCellArray, getDataCellArray, getDataType, getDataType, getDataTypeArray, getDataTypeArray, getRowKey, getRowKey, getRowKeyArray, getRowKeyArray, load, loadFromXML, toString

Methods inherited from class org.knime.core.node.config.base.ConfigBase

addBoolean, addBooleanArray, addByte, addByteArray, addChar, addCharArray, addConfigBase, addConfigBase, addDouble, addDoubleArray, addFloat, addFloatArray, addInt, addIntArray, addLong, addLongArray, addShort, addShortArray, addString, addStringArray, children, containsKey, copyTo, get, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getByte, getByte, getByteArray, getByteArray, getChar, getChar, getCharArray, getCharArray, getChildAt, getChildCount, getConfigBase, getDouble, getDouble, getDoubleArray, getDoubleArray, getEntry, getFloat, getFloat, getFloatArray, getFloatArray, getIndex, getInt, getInt, getIntArray, getIntArray, getLong, getLong, getLongArray, getLongArray, getShort, getShort, getShortArray, getShortArray, getString, getString, getStringArray, getStringArray, hasIdenticalValue, isLeaf, iterator, keySet, loadFromXML, put, saveToXML, toString, toStringValue, writeToFile

Methods inherited from class org.knime.core.node.config.base.AbstractConfigEntry

equals, getAllowsChildren, getKey, getParent, getType, hashCode, isIdentical, setParent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.knime.core.node.config.ConfigRO

getConfig, getDataCell, getDataCell, getDataCellArray, getDataCellArray, getDataType, getDataType, getDataTypeArray, getDataTypeArray, getRowKey, getRowKey, getRowKeyArray, getRowKeyArray, iterator

Methods inherited from interface org.knime.core.node.config.base.ConfigBaseRO

containsKey, copyTo, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getByte, getByte, getByteArray, getByteArray, getChar, getChar, getCharArray, getCharArray, getConfigBase, getDouble, getDouble, getDoubleArray, getDoubleArray, getFloat, getFloat, getFloatArray, getFloatArray, getInt, getInt, getIntArray, getIntArray, getKey, getLong, getLong, getLongArray, getLongArray, getShort, getShort, getShortArray, getShortArray, getString, getString, getStringArray, getStringArray, keySet, saveToXML

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface org.knime.core.node.config.ConfigWO

addConfig, addDataCell, addDataCellArray, addDataType, addDataTypeArray, addRowKey, addRowKeyArray

Methods inherited from interface org.knime.core.node.config.base.ConfigBaseWO

addBoolean, addBooleanArray, addByte, addByteArray, addChar, addCharArray, addConfigBase, addDouble, addDoubleArray, addFloat, addFloatArray, addInt, addIntArray, addLong, addLongArray, addShort, addShortArray, addString, addStringArray, getKey

Constructor Detail

NodeSettings

public NodeSettings(String key)

Creates a new instance of this object with the given key.

Parameters:

key - An identifier.

Method Detail

getInstance

public Config getInstance(String key)

Creates a new Config of this type.

Specified by:

getInstance in class Config

Parameters:

key - The new Config's key.

Returns:

A new instance of this Config.

readFromFile

public static NodeSettings readFromFile(ObjectInputStream ois)
                                 throws IOException

Throws:

IOException

See Also:

Config.readFromFile(java.io.ObjectInputStream)

loadFromXML

public static NodeSettingsRO loadFromXML(InputStream in)
                                  throws IOException

Reads NodeSettings object from a given XML input stream and writes them into the given NodeSettings object. The stream will be closed by this call.

Parameters:

in - XML input stream to read settings from.

Returns:

A new settings object.

Throws:

IOException - If the stream could not be read.

NullPointerException - If one of the arguments is null.

copyTo

public void copyTo(ConfigWO dest)

Makes a deep copy of this Config and all sub-configs.

Specified by:

copyTo in interface NodeSettingsRO

Parameters:

dest - the destination this Config object is copied to.

addNodeSettings

public NodeSettingsWO addNodeSettings(String key)

Creates new NodeSettingsWO object for the given key and returns it.

Specified by:

addNodeSettings in interface NodeSettingsWO

Parameters:

key - The identifier for the given config.

Returns:

A new NodeSettingsWO object.

addNodeSettings

public void addNodeSettings(NodeSettings settings)

Add the given NodeSettings object to this Config using the key of the argument's NodeSettings.

Specified by:

addNodeSettings in interface NodeSettingsWO

Parameters:

settings - The object to add to this Config.

getNodeSettings

public NodeSettings getNodeSettings(String key)
                             throws InvalidSettingsException

Returns a read-only NodeSettingsRO object from this config.

Specified by:

getNodeSettings in interface NodeSettingsRO

Parameters:

key - The identifier.

Returns:

A new NodeSettingsRO object.

Throws:

InvalidSettingsException - If the object can't be accessed.