com.ibm.di.config.base
Class AttributeMapItemImpl

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

All Implemented Interfaces:

AttributeMapItem, BaseConfiguration, MetamergeConfigChangeListener, Serializable

public class AttributeMapItemImpl
extends BaseConfigurationImpl
implements AttributeMapItem

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.AttributeMapItem

ADVANCED_MAPPING, SIMPLE_MAPPING, SUBSTITUTION_MAPPING

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

AttributeMapItemImpl()

AttributeMapItemImpl(Object config)

Method Summary

static AttributeMapItem	clone(AttributeMapItem ami)
boolean	flatten(List excludedNS) flatten - combines all values from this object and its inherited objects into one single config object.
boolean	getAdd() Gets the add attribute of the AttributeMapItem object
boolean	getEnabled() Gets the enabled attribute of the BaseConfiguration object
boolean	getModify() Gets the modify attribute of the AttributeMapItem object
String	getScript() Gets the script attribute of the BaseConfiguration object
String	getSimple() Gets the simple attribute of the AttributeMapItem object
String	getSubstitution() Gets the substitution template attribute of the AttributeMapItem object
String	getType() Gets the type attribute of the AttributeMapItem object
boolean	isAdvanced() Returns true if this AttributeMapItem is an advanced attribute map (mapped by a script)
boolean	isSimple() Returns true if this AttributeMapItem is a simple attribute map
boolean	isSubstitution() Returns true if this attribute map item is subject to property expansion
void	notifyChange(Object source, Object key, int operation, Object userObject) Signal a change event to listeners.
void	setAdd(boolean add) Sets the add attribute of the AttributeMapItem object
void	setEnabled(boolean enabled) Gets the enabled attribute of the BaseConfiguration object
void	setModify(boolean modify) Sets the modify attribute of the AttributeMapItem object
void	setScript(String script) Sets the script attribute of the BaseConfiguration object
void	setSimple(String attribute) Sets the simple attribute of the AttributeMapItem object
void	setSubstitution(String str) Sets the substitution template attribute of the AttributeMapItem object
void	setType(String type) Sets the type attribute of the AttributeMapItem object

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, 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, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isParameterLocal, nameForChild, notifyChange, performNotifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, 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, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isParameterLocal, nameForChild, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Constructor Detail

AttributeMapItemImpl

public AttributeMapItemImpl()

AttributeMapItemImpl

public AttributeMapItemImpl(Object config)

Method Detail

clone

public static AttributeMapItem clone(AttributeMapItem ami)

getEnabled

public boolean getEnabled()

Description copied from interface: BaseConfiguration

Gets the enabled attribute of the BaseConfiguration object

Specified by:

getEnabled in interface AttributeMapItem

Specified by:

getEnabled in interface BaseConfiguration

Overrides:

getEnabled in class BaseConfigurationImpl

Returns:

The nullBehaviorValue value

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: BaseConfiguration

Gets the enabled attribute of the BaseConfiguration object

Specified by:

setEnabled in interface AttributeMapItem

Specified by:

setEnabled in interface BaseConfiguration

Overrides:

setEnabled in class BaseConfigurationImpl

Parameters:

enabled - The new enabled value

getScript

public String getScript()

Description copied from interface: BaseConfiguration

Gets the script attribute of the BaseConfiguration object

Specified by:

getScript in interface AttributeMapItem

Specified by:

getScript in interface BaseConfiguration

Overrides:

getScript in class BaseConfigurationImpl

Returns:

The script value

setScript

public void setScript(String script)

Description copied from interface: BaseConfiguration

Sets the script attribute of the BaseConfiguration object

Specified by:

setScript in interface AttributeMapItem

Specified by:

setScript in interface BaseConfiguration

Overrides:

setScript in class BaseConfigurationImpl

Parameters:

script - The new script value

getModify

public boolean getModify()

Description copied from interface: AttributeMapItem

Gets the modify attribute of the AttributeMapItem object

Specified by:

getModify in interface AttributeMapItem

Returns:

The modify value

setModify

public void setModify(boolean modify)

Description copied from interface: AttributeMapItem

Sets the modify attribute of the AttributeMapItem object

Specified by:

setModify in interface AttributeMapItem

Parameters:

modify - The new modify value

getAdd

public boolean getAdd()

Description copied from interface: AttributeMapItem

Gets the add attribute of the AttributeMapItem object

Specified by:

getAdd in interface AttributeMapItem

Returns:

The add value

setAdd

public void setAdd(boolean add)

Description copied from interface: AttributeMapItem

Sets the add attribute of the AttributeMapItem object

Specified by:

setAdd in interface AttributeMapItem

Parameters:

add - The new add value

getSimple

public String getSimple()

Description copied from interface: AttributeMapItem

Gets the simple attribute of the AttributeMapItem object

Specified by:

getSimple in interface AttributeMapItem

Returns:

The simple value

setSimple

public void setSimple(String attribute)

Description copied from interface: AttributeMapItem

Sets the simple attribute of the AttributeMapItem object

Specified by:

setSimple in interface AttributeMapItem

Parameters:

attribute - The new simple value

setType

public void setType(String type)

Description copied from interface: AttributeMapItem

Sets the type attribute of the AttributeMapItem object

Specified by:

setType in interface AttributeMapItem

Parameters:

type - The new type value

getType

public String getType()

Description copied from interface: AttributeMapItem

Gets the type attribute of the AttributeMapItem object

Specified by:

getType in interface AttributeMapItem

Returns:

The type value

isSimple

public boolean isSimple()

Description copied from interface: AttributeMapItem

Returns true if this AttributeMapItem is a simple attribute map

Specified by:

isSimple in interface AttributeMapItem

Returns:

The simple value

isAdvanced

public boolean isAdvanced()

Description copied from interface: AttributeMapItem

Returns true if this AttributeMapItem is an advanced attribute map (mapped by a script)

Specified by:

isAdvanced in interface AttributeMapItem

Returns:

The advanced value

isSubstitution

public boolean isSubstitution()

Description copied from interface: AttributeMapItem

Returns true if this attribute map item is subject to property expansion

Specified by:

isSubstitution in interface AttributeMapItem

Returns:

The if enabled, false if disabled

setSubstitution

public void setSubstitution(String str)

Description copied from interface: AttributeMapItem

Sets the substitution template attribute of the AttributeMapItem object

Specified by:

setSubstitution in interface AttributeMapItem

Parameters:

str - The substitution template

getSubstitution

public String getSubstitution()

Description copied from interface: AttributeMapItem

Gets the substitution template attribute of the AttributeMapItem object

Specified by:

getSubstitution in interface AttributeMapItem

Returns:

The substitution template

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

notifyChange

public void notifyChange(Object source,
                         Object key,
                         int operation,
                         Object userObject)

Description copied from interface: BaseConfiguration

Signal a change event to listeners. This method is typically called by setParameter but not user code.

Specified by:

notifyChange in interface BaseConfiguration

Overrides:

notifyChange in class BaseConfigurationImpl

Parameters:

source - The caller initiating the change event

key - The key that changed

operation - The operation performed on key

userObject - Arbitrary object provided by caller