com.ibm.di.config.base
Class AttributeMapConfigImpl

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

All Implemented Interfaces:

AttributeMapConfig, BaseConfiguration, MetamergeConfigChangeListener, Serializable

Direct Known Subclasses:

HooksConfigImpl

public class AttributeMapConfigImpl
extends BaseConfigurationImpl
implements AttributeMapConfig, MetamergeConfigChangeListener

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

AttributeMapConfigImpl()

AttributeMapConfigImpl(Object config)

Method Summary

void	configurationChanged(MetamergeConfigChange mcc)
boolean	flatten(List excludedNS) flatten - combines all values from this object and its inherited objects into one single config object.
AttributeMapItem	getAttributeMapItem(Object attrName) Returns the AttributeMapItem for attribute
List	getAttributeNames() Returns a list of attribute names in this object.
Object	getClone() Returns a cloned version of this object.
boolean	hasAttributeMapItem(Object attribute) Checks if a named attribute is local (not inherited or null) to this object.
void	init() init - method called after internal data structure is set
AttributeMapItem	newAttributeMapItem(Object name) Creates and adds a new attribute map item to this object.
void	removeAttributeMapItem(Object attribute) Removes a named attribute from this map.
void	renameAttributeMapItem(Object newName, AttributeMapItem map) Changes the name of an existing attributemapitem
void	setAttributeMapItem(AttributeMapItem map) Sets a attributeMapItem attribute of the AttributeMapConfig object
void	setInheritsFrom(BaseConfiguration inheritFrom) We override this method to change the inherited object if we inherit from a connector.
void	setupInheritanceChain() Established the inheritance chain for this object.

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

addListener, deepClone, expandPropertyValue, expandPropertyValue, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, 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, getUserComment, hasParameter, 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, setUseListeners, setUserComment, 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, 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, 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, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Constructor Detail

AttributeMapConfigImpl

public AttributeMapConfigImpl()

AttributeMapConfigImpl

public AttributeMapConfigImpl(Object config)

Method Detail

init

public void init()
          throws Exception

Description copied from class: BaseConfigurationImpl

init - method called after internal data structure is set

Specified by:

init in interface BaseConfiguration

Overrides:

init in class BaseConfigurationImpl

Throws:

Exception - if the initialization fails

setupInheritanceChain

public void setupInheritanceChain()
                           throws Exception

Description copied from class: BaseConfigurationImpl

Established the inheritance chain for this object.

Specified by:

setupInheritanceChain in interface BaseConfiguration

Overrides:

setupInheritanceChain in class BaseConfigurationImpl

Throws:

Exception - if the operation does not succeed

setInheritsFrom

public void setInheritsFrom(BaseConfiguration inheritFrom)

We override this method to change the inherited object if we inherit from a connector. Also we need to set up inheritance for all the attribute map items.

Specified by:

setInheritsFrom in interface BaseConfiguration

Overrides:

setInheritsFrom in class BaseConfigurationImpl

Parameters:

inheritFrom - The new inheritsFrom value

configurationChanged

public void configurationChanged(MetamergeConfigChange mcc)

Specified by:

configurationChanged in interface MetamergeConfigChangeListener

Overrides:

configurationChanged in class BaseConfigurationImpl

newAttributeMapItem

public AttributeMapItem newAttributeMapItem(Object name)
                                     throws Exception

Description copied from interface: AttributeMapConfig

Creates and adds a new attribute map item to this object.

Specified by:

newAttributeMapItem in interface AttributeMapConfig

Parameters:

name - The attribute name

Returns:

The newly created AttributeMapItem

Throws:

Exception - Any errors encountered by the underlying driver

setAttributeMapItem

public void setAttributeMapItem(AttributeMapItem map)

Description copied from interface: AttributeMapConfig

Sets a attributeMapItem attribute of the AttributeMapConfig object

Specified by:

setAttributeMapItem in interface AttributeMapConfig

Parameters:

map - The new AttributeMapItem

removeAttributeMapItem

public void removeAttributeMapItem(Object attribute)

Description copied from interface: AttributeMapConfig

Removes a named attribute from this map.

Specified by:

removeAttributeMapItem in interface AttributeMapConfig

Parameters:

attribute - The attribute name

renameAttributeMapItem

public void renameAttributeMapItem(Object newName,
                                   AttributeMapItem map)
                            throws Exception

Description copied from interface: AttributeMapConfig

Changes the name of an existing attributemapitem

Specified by:

renameAttributeMapItem in interface AttributeMapConfig

Parameters:

newName - The new name

map - The existing AttributeMapItem

Throws:

Exception - Any errors encountered by the underlying driver

getAttributeMapItem

public AttributeMapItem getAttributeMapItem(Object attrName)

Description copied from interface: AttributeMapConfig

Returns the AttributeMapItem for attribute

Specified by:

getAttributeMapItem in interface AttributeMapConfig

Parameters:

attrName - The attribute name

Returns:

The attributeMapItem value

hasAttributeMapItem

public boolean hasAttributeMapItem(Object attribute)

Description copied from interface: AttributeMapConfig

Checks if a named attribute is local (not inherited or null) to this object.

Specified by:

hasAttributeMapItem in interface AttributeMapConfig

Parameters:

attribute - The attribute name

Returns:

True if this object contains the attribute

getAttributeNames

public List getAttributeNames()

Description copied from interface: AttributeMapConfig

Returns a list of attribute names in this object.

Specified by:

getAttributeNames in interface AttributeMapConfig

Returns:

The list of attribute names including inherited attributes

flatten

public boolean flatten(List excludedNS)
                throws Exception

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

getClone

public Object getClone()
                throws Exception

Description copied from interface: BaseConfiguration

Returns a cloned version of this object.

Specified by:

getClone in interface BaseConfiguration

Overrides:

getClone in class BaseConfigurationImpl

Throws:

Exception