com.ibm.di.config.interfaces
Interface SchemaConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

SchemaConfigImpl

public interface SchemaConfig
extends BaseConfiguration

Describes a Schema, the information about which which fields are available or needed when reading from or writing to e.g. a Connector.

Field Summary

Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE

Method Summary

SchemaItemConfig	getItem(Object name) Gets the item attribute of the SchemaConfig object
List<String>	getItemNames() Gets a List of all of the names.
SchemaItemConfig	newItem(Object name) Constructs a new SchemaItemConfig object
void	removeItem(Object name) Removes and item from the schema
void	setItem(Object name, SchemaItemConfig item) Sets the item attribute of the SchemaConfig object

Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

getItemNames

List<String> getItemNames()

Gets a List of all of the names.

Returns:

The item names in a List.

getItem

SchemaItemConfig getItem(Object name)

Gets the item attribute of the SchemaConfig object

Parameters:

name - The name of the schema item object

Returns:

The item value

removeItem

void removeItem(Object name)

Removes and item from the schema

Parameters:

name - The name of the item to remove

setItem

void setItem(Object name,
             SchemaItemConfig item)

Sets the item attribute of the SchemaConfig object

Parameters:

name - The new item value

item - The new item value

newItem

SchemaItemConfig newItem(Object name)
                         throws Exception

Constructs a new SchemaItemConfig object

Parameters:

name - The name of the new Object

Returns:

The new constructed object

Throws:

Exception - if the operation does not succeed