com.ibm.di.config.interfaces
Interface AttributeMapConfig

All Superinterfaces:
BaseConfiguration, Serializable
All Known Subinterfaces:
HooksConfig
All Known Implementing Classes:
AttributeMapConfigImpl, HooksConfigImpl

public interface AttributeMapConfig
extends BaseConfiguration

The configuration for an AttributeMap (used in components of the AssemblyLine).


Field Summary
 
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
 
Method Summary
 AttributeMapItem getAttributeMapItem(Object attribute)
          Returns the AttributeMapItem for attribute
 List<String> getAttributeNames()
          Returns a list of attribute names in this object.
 boolean hasAttributeMapItem(Object attribute)
          Checks if a named attribute is local (not inherited or null) to this object.
 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
 
Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
 

Method Detail

setAttributeMapItem

void setAttributeMapItem(AttributeMapItem map)
Sets a attributeMapItem attribute of the AttributeMapConfig object

Parameters:
map - The new AttributeMapItem

removeAttributeMapItem

void removeAttributeMapItem(Object attribute)
Removes a named attribute from this map.

Parameters:
attribute - The attribute name

getAttributeMapItem

AttributeMapItem getAttributeMapItem(Object attribute)
Returns the AttributeMapItem for attribute

Parameters:
attribute - The attribute name
Returns:
The attributeMapItem value

hasAttributeMapItem

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

Parameters:
attribute - The attribute name
Returns:
True if this object contains the attribute

newAttributeMapItem

AttributeMapItem newAttributeMapItem(Object name)
                                     throws Exception
Creates and adds a new attribute map item to this object.

Parameters:
name - The attribute name
Returns:
The newly created AttributeMapItem
Throws:
Exception - Any errors encountered by the underlying driver

getAttributeNames

List<String> getAttributeNames()
Returns a list of attribute names in this object.

Returns:
The list of attribute names including inherited attributes

renameAttributeMapItem

void renameAttributeMapItem(Object newName,
                            AttributeMapItem map)
                            throws Exception
Changes the name of an existing attributemapitem

Parameters:
newName - The new name
map - The existing AttributeMapItem
Throws:
Exception - Any errors encountered by the underlying driver