com.ibm.di.config.interfaces
Interface ConnectorSchemaConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

ConnectorSchemaConfigImpl

public interface ConnectorSchemaConfig
extends BaseConfiguration

This class represents the configuration of the Connector schema. The Connector schema describes what the input/output conn Entry contains.

Field Summary

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

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, SUBTREE

Method Summary

ConnectorSchemaItemConfig	getItem(Object name) Gets the item attribute of the ConnectorSchemaConfig object
ConnectorSchemaItemConfig	getItem(Object name, boolean create)
List	getItemNames() Gets the List of Items names.
ConnectorSchemaItemConfig	newItem(Object name) Creates a new schema item.
void	removeItem(Object name) Deletes the specified schema item.
void	setItem(Object name, ConnectorSchemaItemConfig item) Sets the item attribute of the ConnectorSchemaConfig object

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

addListener, 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, isParameterLocal, nameForChild, notifyChange, notifyChange, 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 getItemNames()

Gets the List of Items names.

Returns:

The item value

getItem

ConnectorSchemaItemConfig getItem(Object name,
                                  boolean create)

Parameters:

name - the name of the schema item

create - a boolean value specifying if the item should be created if it does not exist

Returns:

The item value

getItem

ConnectorSchemaItemConfig getItem(Object name)

Gets the item attribute of the ConnectorSchemaConfig object

Parameters:

name - the name of the schema item

Returns:

The item value

removeItem

void removeItem(Object name)

Deletes the specified schema item.

Parameters:

name - the name of the schema item to delete.

setItem

void setItem(Object name,
             ConnectorSchemaItemConfig item)

Sets the item attribute of the ConnectorSchemaConfig object

Parameters:

name - The new item value

item - The new item value

newItem

ConnectorSchemaItemConfig newItem(Object name)
                                  throws Exception

Creates a new schema item.

Parameters:

name - the name of the new schema item

Returns:

the config object for the new item

Throws:

Exception - An exception is thrown if this method fails.