org.knime.core.node.config

Interface ConfigRO

All Superinterfaces:

ConfigBaseRO, Iterable<String>, TreeNode

All Known Subinterfaces:

ModelContentRO, NodeSettingsRO

All Known Implementing Classes:

Config, ModelContent, NodeSettings

public interface ConfigRO
extends ConfigBaseRO, TreeNode, Iterable<String>

Interface implements only access functions for Config objects. In addition, it implements the TreeNode and Iterable interface.

Author:

Thomas Gabriel, University of Konstanz

Method Summary

Modifier and Type	Method and Description
Config	getConfig(String key) Returns a Config for the given key.
DataCell	getDataCell(String key) Return DataCell for key.
DataCell	getDataCell(String key, DataCell def) Return a DataCell which can be null, or the default value if the key is not available.
DataCell[]	getDataCellArray(String key) Return DataCell array.
DataCell[]	getDataCellArray(String key, DataCell... def) Return DataCell array which can be null for key, or the default array if the key is not available.
DataType	getDataType(String key) Return DataType for key.
DataType	getDataType(String key, DataType def) Return a DataType elements or null for key, or the default value if not available.
DataType[]	getDataTypeArray(String key) Returns an array of DataType objects which can be null.
DataType[]	getDataTypeArray(String key, DataType... v) Returns the array of DataType objects for the given key or if not available the given array.
RowKey	getRowKey(String key) Return RowKey for key.
RowKey	getRowKey(String key, RowKey def) Return a RowKey which can be null, or the default value if the key is not available.
RowKey[]	getRowKeyArray(String key) Return RowKey array for the given key.
RowKey[]	getRowKeyArray(String key, RowKey... def) Return a RowKey array which can be null, or the default value if the key is not available.
Iterator<String>	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, getPassword, getPassword, getShort, getShort, getShortArray, getShortArray, getString, getString, getStringArray, getStringArray, getTransientString, keySet, saveToXML

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface javax.swing.tree.TreeNode

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

Method Detail

getConfig

Config getConfig(String key)
          throws InvalidSettingsException

Returns a Config for the given key.

Parameters:

key - The identifier for the Config.

Returns:

A new Config object.

Throws:

InvalidSettingsException - If the Config could not be accessed.

getDataCell

DataCell getDataCell(String key)
              throws InvalidSettingsException

Return DataCell for key.

Parameters:

key - The key.

Returns:

A DataCell.

Throws:

InvalidSettingsException - If the key is not available.

getRowKey

RowKey getRowKey(String key)
          throws InvalidSettingsException

Return RowKey for key.

Parameters:

key - the identifier used to store the RowKey before

Returns:

the store RowKey

Throws:

InvalidSettingsException - if the key is not available

getRowKeyArray

RowKey[] getRowKeyArray(String key)
                 throws InvalidSettingsException

Return RowKey array for the given key.

Parameters:

key - the identifier used to store the RowKey array before

Returns:

the store RowKey array

Throws:

InvalidSettingsException - if the key is not available

getDataType

DataType getDataType(String key)
              throws InvalidSettingsException

Return DataType for key.

Parameters:

key - The key.

Returns:

A DataType.

Throws:

InvalidSettingsException - If the key is not available.

getDataCell

DataCell getDataCell(String key,
                     DataCell def)

Return a DataCell which can be null, or the default value if the key is not available.

Parameters:

key - The key.

def - The default value, returned id the key is not available.

Returns:

A DataCell object.

getRowKey

RowKey getRowKey(String key,
                 RowKey def)

Return a RowKey which can be null, or the default value if the key is not available.

Parameters:

key - identifier used to store the RowKey before

def - default value, returned if the key is not available

Returns:

the stored RowKey

getRowKeyArray

RowKey[] getRowKeyArray(String key,
                        RowKey... def)

Return a RowKey array which can be null, or the default value if the key is not available.

Parameters:

key - identifier used to store the RowKey array before

def - default value, returned if the key is not available

Returns:

the stored RowKey array

getDataType

DataType getDataType(String key,
                     DataType def)

Return a DataType elements or null for key, or the default value if not available.

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A DataType object or null, or the def value. generic boolean.

getDataCellArray

DataCell[] getDataCellArray(String key)
                     throws InvalidSettingsException

Return DataCell array. The array an the elements can be null.

Parameters:

key - The key.

Returns:

A DataCell array.

Throws:

InvalidSettingsException - If the the key is not available.

getDataCellArray

DataCell[] getDataCellArray(String key,
                            DataCell... def)

Return DataCell array which can be null for key, or the default array if the key is not available.

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A char array.

getDataTypeArray

DataType[] getDataTypeArray(String key)
                     throws InvalidSettingsException

Returns an array of DataType objects which can be null.

Parameters:

key - The key.

Returns:

An array of DataType objects.

Throws:

InvalidSettingsException - The the object is not available for the given key.

getDataTypeArray

DataType[] getDataTypeArray(String key,
                            DataType... v)

Returns the array of DataType objects for the given key or if not available the given array.

Parameters:

key - The key.

v - The default array, returned if no entry available for the key.

Returns:

An array of DataType objects.

iterator

Iterator<String> iterator()

Specified by:

iterator in interface ConfigBaseRO

Specified by:

iterator in interface Iterable<String>