com.ibm.di.config.base
Class AttributeMapItemImpl

java.lang.Object
  extended by com.ibm.di.config.base.BaseConfigurationImpl
      extended by com.ibm.di.config.base.AttributeMapItemImpl
All Implemented Interfaces:
AttributeMapItem, BaseConfiguration, MetamergeConfigChangeListener, java.io.Serializable

public class AttributeMapItemImpl
extends BaseConfigurationImpl
implements AttributeMapItem

The implementation class of the AttributeMapItem interface.

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
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
 
Constructor Summary
AttributeMapItemImpl()
          Default Constructor.
AttributeMapItemImpl(java.lang.Object config)
          Constructor.
 
Method Summary
static AttributeMapItem clone(AttributeMapItem ami)
          Clone an Attribute Map Item.
 boolean detachFromParent()
          Detach this Attribute Map item from its parent Attribute Map.
 boolean flatten(java.util.List<java.lang.String> excludedNS)
          This method 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
 java.util.List getChildAttributeMaps()
          Returns a list of child attribute map items.
 boolean getEnabled()
          Gets the enabled attribute of this object.
 boolean getModify()
          Gets the modify attribute of the AttributeMapItem object
 java.lang.String getScript()
          Gets the script attribute of this object.
 java.lang.String getSimple()
          Gets the simple attribute of the AttributeMapItem object
 java.lang.String getSubstitution()
          Gets the substitution template attribute of the AttributeMapItem object
 java.lang.String getType()
          Gets the type attribute of the AttributeMapItem object
 void init()
          Called after internal data structure is set.
 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
 boolean reattachToParent(int position)
          Re-attach this Attribute Map item to its parent Attribute Map.
 void setAdd(boolean add)
          Sets the add attribute of the AttributeMapItem object
 void setEnabled(boolean enabled)
          Sets the enabled attribute of this object.
 void setInheritsFrom(BaseConfiguration inheritFrom)
          Sets the object from which this object inherits data.
 void setModify(boolean modify)
          Sets the modify attribute of the AttributeMapItem object
 void setScript(java.lang.String script)
          Sets the script attribute of this object.
 void setSimple(java.lang.String attribute)
          Sets the simple attribute of the AttributeMapItem object
 void setSubstitution(java.lang.String str)
          Sets the substitution template attribute of the AttributeMapItem object
 void setType(java.lang.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, getLongName, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseConfigListeners, 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, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
 

Constructor Detail

AttributeMapItemImpl

public AttributeMapItemImpl()
Default Constructor.


AttributeMapItemImpl

public AttributeMapItemImpl(java.lang.Object config)
Constructor.

Parameters:
config - TreeMap of attribute/value pairs.
Method Detail

init

public void init()
          throws java.lang.Exception
Called after internal data structure is set.

Specified by:
init in interface BaseConfiguration
Overrides:
init in class BaseConfigurationImpl
Throws:
java.lang.Exception - if the initialization fails.

clone

public static AttributeMapItem clone(AttributeMapItem ami)
Clone an Attribute Map Item.

Parameters:
ami - Attribute Map Item, which will be cloned.
Returns:
The created clone.

getEnabled

public boolean getEnabled()
Gets the enabled attribute of this 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)
Sets the enabled attribute of this object.

Specified by:
setEnabled in interface AttributeMapItem
Specified by:
setEnabled in interface BaseConfiguration
Overrides:
setEnabled in class BaseConfigurationImpl
Parameters:
enabled - true for enabling; false otherwise.

getScript

public java.lang.String getScript()
Gets the script attribute of this 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(java.lang.String script)
Sets the script attribute of this 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()
Gets the modify attribute of the AttributeMapItem object

Specified by:
getModify in interface AttributeMapItem
Returns:
The modify value

setModify

public void setModify(boolean modify)
Sets the modify attribute of the AttributeMapItem object

Specified by:
setModify in interface AttributeMapItem
Parameters:
modify - The new modify value

getAdd

public boolean getAdd()
Gets the add attribute of the AttributeMapItem object

Specified by:
getAdd in interface AttributeMapItem
Returns:
The add value

setAdd

public void setAdd(boolean add)
Sets the add attribute of the AttributeMapItem object

Specified by:
setAdd in interface AttributeMapItem
Parameters:
add - The new add value

getSimple

public java.lang.String getSimple()
Gets the simple attribute of the AttributeMapItem object

Specified by:
getSimple in interface AttributeMapItem
Returns:
The simple value

setSimple

public void setSimple(java.lang.String attribute)
Sets the simple attribute of the AttributeMapItem object

Specified by:
setSimple in interface AttributeMapItem
Parameters:
attribute - The new simple value

setType

public void setType(java.lang.String type)
Sets the type attribute of the AttributeMapItem object

Specified by:
setType in interface AttributeMapItem
Parameters:
type - The new type value

getType

public java.lang.String getType()
Gets the type attribute of the AttributeMapItem object

Specified by:
getType in interface AttributeMapItem
Returns:
The type value

isSimple

public boolean isSimple()
Returns true if this AttributeMapItem is a simple attribute map

Specified by:
isSimple in interface AttributeMapItem
Returns:
The simple value

isAdvanced

public boolean isAdvanced()
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()
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(java.lang.String str)
Sets the substitution template attribute of the AttributeMapItem object

Specified by:
setSubstitution in interface AttributeMapItem
Parameters:
str - The substitution template

getSubstitution

public java.lang.String getSubstitution()
Gets the substitution template attribute of the AttributeMapItem object

Specified by:
getSubstitution in interface AttributeMapItem
Returns:
The substitution template

flatten

public boolean flatten(java.util.List<java.lang.String> excludedNS)
                throws java.lang.Exception
This method 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:
java.lang.Exception

detachFromParent

public boolean detachFromParent()
Detach this Attribute Map item from its parent Attribute Map. Note that the modification affects only the Attribute Map, the item itself still keeps its knowledge that the Attribute Map is its parent. This behavior is used by the reattachToParent(int) method.

Specified by:
detachFromParent in interface BaseConfiguration
Overrides:
detachFromParent in class BaseConfigurationImpl
Returns:
Always true.

reattachToParent

public boolean reattachToParent(int position)
Re-attach this Attribute Map item to its parent Attribute Map.

Specified by:
reattachToParent in interface BaseConfiguration
Overrides:
reattachToParent in class BaseConfigurationImpl
Parameters:
position - This parameter is ignored.
Returns:
False if the Attribute Map already contains this Attribute Map item, true otherwise.

getChildAttributeMaps

public java.util.List getChildAttributeMaps()
Returns a list of child attribute map items.

Specified by:
getChildAttributeMaps in interface AttributeMapItem
Returns:
List of child AttributeMapItem items

setInheritsFrom

public void setInheritsFrom(BaseConfiguration inheritFrom)
Sets the object from which this object inherits data.

Note: Call this method to setup a temporary (non persistent) object for inheritance.

Specified by:
setInheritsFrom in interface BaseConfiguration
Overrides:
setInheritsFrom in class BaseConfigurationImpl
Parameters:
inheritFrom - The new inheritsFrom value.