com.ibm.di.config.base
Class SchemaConfigImpl

java.lang.Object
  com.ibm.di.config.base.BaseConfigurationImpl
      com.ibm.di.config.base.SchemaConfigImpl

All Implemented Interfaces:

BaseConfiguration, MetamergeConfigChangeListener, SchemaConfig, Serializable

public class SchemaConfigImpl
extends BaseConfigurationImpl
implements SchemaConfig

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl

NAME

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

Constructor Summary

SchemaConfigImpl()

SchemaConfigImpl(Object config)

Method Summary

boolean	flatten(List excludedNS) flatten - combines all values from this object and its inherited objects into one single config object.
SchemaItemConfig	getItem(Object name) Gets the item attribute of the SchemaConfig object
List	getItemNames() Gets a List of all of the names.
String	getUserComment() Override since the user comment may be a schema item
SchemaItemConfig	newItem(Object name) Constructs a new SchemaItemConfig object.
void	removeItem(Object name) Removes an item attribute from the schema
void	setInheritsFrom(BaseConfiguration inheritFrom) We override this method to change the inherited object if we inherit from a connector.
void	setItem(Object name, SchemaItemConfig item) Sets the item attribute of the SchemaConfig object
void	setUserComment(String comment) v Sets the user defined comment string

Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl

addListener, configurationChanged, deepClone, expandPropertyValue, expandPropertyValue, 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, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, hasParameter, init, isParameterLocal, nameForChild, notifyChange, notifyChange, performNotifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, size, toEntry, toString, updateInheritsFrom, willExpandProps, willFlatten, willUseInherited

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addListener, 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, hasParameter, init, isParameterLocal, nameForChild, notifyChange, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, size, toEntry, updateInheritsFrom, willFlatten

Constructor Detail

SchemaConfigImpl

public SchemaConfigImpl()

SchemaConfigImpl

public SchemaConfigImpl(Object config)

Method Detail

getUserComment

public String getUserComment()

Override since the user comment may be a schema item

Specified by:

getUserComment in interface BaseConfiguration

Overrides:

getUserComment in class BaseConfigurationImpl

setUserComment

public void setUserComment(String comment)

Description copied from class: BaseConfigurationImpl

v Sets the user defined comment string

Specified by:

setUserComment in interface BaseConfiguration

Overrides:

setUserComment in class BaseConfigurationImpl

getItemNames

public List getItemNames()

Description copied from interface: SchemaConfig

Gets a List of all of the names.

Specified by:

getItemNames in interface SchemaConfig

Returns:

The item value

getItem

public SchemaItemConfig getItem(Object name)

Gets the item attribute of the SchemaConfig object

Specified by:

getItem in interface SchemaConfig

Parameters:

name - The name of the item of the schema

Returns:

The item value

removeItem

public void removeItem(Object name)

Removes an item attribute from the schema

Specified by:

removeItem in interface SchemaConfig

Parameters:

name - The name of the item to remove

setItem

public void setItem(Object name,
                    SchemaItemConfig item)

Sets the item attribute of the SchemaConfig object

Specified by:

setItem in interface SchemaConfig

Parameters:

name - The name of the new item

item - The SchemaConfig object to put in

newItem

public SchemaItemConfig newItem(Object name)
                         throws Exception

Constructs a new SchemaItemConfig object. The object contains an item attribute with name and default value

Specified by:

newItem in interface SchemaConfig

Parameters:

name - The name of the item attribute

Returns:

New SchemaItemConfig object

Throws:

Exception - if the construction does not succeed or there is an already existing item with such name

setInheritsFrom

public void setInheritsFrom(BaseConfiguration inheritFrom)

We override this method to change the inherited object if we inherit from a connector.

Specified by:

setInheritsFrom in interface BaseConfiguration

Overrides:

setInheritsFrom in class BaseConfigurationImpl

Parameters:

inheritFrom - The new inheritsFrom value

flatten

public boolean flatten(List excludedNS)
                throws Exception

Description copied from class: BaseConfigurationImpl

flatten - combines all values from this object and its inherited objects into one single config object. After flattening, the object is a complete object with no inherited values except those from the excludedNS list.

Specified by:

flatten in interface BaseConfiguration

Overrides:

flatten in class BaseConfigurationImpl

Parameters:

excludedNS - List of namespaces to exclude from flattening

Returns:

TRUE if object attempted flattening, FALSE is this object inherits from an excluded namespace or has no inheritance

Throws:

Exception