|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.config.AbstractConfigEntry
org.knime.core.node.config.Config
org.knime.core.node.NodeSettings
public final class NodeSettings
This class overwrites the general Config
object and
specializes some method to access NodeSettings
object. This
object is used within the node packages.
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. |
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.AbstractConfigEntry |
---|
equals, getAllowsChildren, getKey, getParent, hashCode, isIdentical |
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 |
---|
containsKey, copyTo, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getByte, getByte, getByteArray, getByteArray, getChar, getChar, getCharArray, getCharArray, getConfig, getDataCell, getDataCell, getDataCellArray, getDataCellArray, getDataType, getDataType, getDataTypeArray, getDataTypeArray, getDouble, getDouble, getDoubleArray, getDoubleArray, getFloat, getFloat, getFloatArray, getFloatArray, getInt, getInt, getIntArray, getIntArray, getKey, getLong, getLong, getLongArray, getLongArray, getRowKey, getRowKey, getRowKeyArray, getRowKeyArray, getShort, getShort, getShortArray, getShortArray, getString, getString, getStringArray, getStringArray, iterator, 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 |
---|
addBoolean, addBooleanArray, addByte, addByteArray, addChar, addCharArray, addConfig, addDataCell, addDataCellArray, addDataType, addDataTypeArray, addDouble, addDoubleArray, addFloat, addFloatArray, addInt, addIntArray, addLong, addLongArray, addRowKey, addRowKeyArray, addShort, addShortArray, addString, addStringArray, getKey |
Constructor Detail |
---|
public NodeSettings(String key)
key
- An identifier.Method Detail |
---|
public Config getInstance(String key)
getInstance
in class Config
key
- The new Config's key.
public static NodeSettings readFromFile(ObjectInputStream ois) throws IOException
IOException
Config.readFromFile(java.io.ObjectInputStream)
public static NodeSettingsRO loadFromXML(InputStream in) throws IOException
NodeSettings
object from a given XML input stream and
writes them into the given NodeSettings
object.
in
- XML input stream to read settings from.
IOException
- If the stream could not be read.
NullPointerException
- If one of the arguments is
null
.public NodeSettingsWO addNodeSettings(String key)
NodeSettingsWO
object for the given key and
returns it.
addNodeSettings
in interface NodeSettingsWO
key
- The identifier for the given config.
NodeSettingsWO
object.public void addNodeSettings(NodeSettings settings)
NodeSettings
object to this Config using the
key of the argument's NodeSettings
.
addNodeSettings
in interface NodeSettingsWO
settings
- The object to add to this Config
.public NodeSettings getNodeSettings(String key) throws InvalidSettingsException
NodeSettingsRO
object from this config.
getNodeSettings
in interface NodeSettingsRO
key
- The identifier.
NodeSettingsRO
object.
InvalidSettingsException
- If the object can't be accessed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |