com.ibm.di.config.interfaces
Interface AttributeMapItem

All Superinterfaces:

BaseConfiguration, java.io.Serializable

All Known Implementing Classes:

AttributeMapItemImpl

public interface AttributeMapItem
extends BaseConfiguration

The configuration for a single item in an AttributeMap.

See Also:

AttributeMapConfig

Field Summary

static java.lang.String	ADVANCED_MAPPING Advanced mapping keyword
static java.lang.String	SIMPLE_MAPPING Simple mapping keyword
static java.lang.String	SUBSTITUTION_MAPPING Substitution mapping keyword

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

boolean	getAdd() Gets the add attribute of the AttributeMapItem object
java.util.List	getChildAttributeMaps() Returns a list of child attribute map items.
boolean	getEnabled() Returns true if this attribute map item is enabled
boolean	getModify() Gets the modify attribute of the AttributeMapItem object
java.lang.String	getScript() Gets the script attribute of the AttributeMapItem 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
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	setAdd(boolean add) Sets the add attribute of the AttributeMapItem object
void	setEnabled(boolean enabled) Sets the enabled attribute of the AttributeMapItem object
void	setModify(boolean modify) Sets the modify attribute of the AttributeMapItem object
void	setScript(java.lang.String script) Sets the script attribute of the AttributeMapItem object
void	setSimple(java.lang.String attribute) Sets the simple attribute of the AttributeMapItem object
void	setSubstitution(java.lang.String template) 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 interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, detachFromParent, flatten, 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, init, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFrom, 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

Field Detail

SIMPLE_MAPPING

static final java.lang.String SIMPLE_MAPPING

Simple mapping keyword

See Also:

Constant Field Values

ADVANCED_MAPPING

static final java.lang.String ADVANCED_MAPPING

Advanced mapping keyword

See Also:

Constant Field Values

SUBSTITUTION_MAPPING

static final java.lang.String SUBSTITUTION_MAPPING

Substitution mapping keyword

See Also:

Constant Field Values

Method Detail

getEnabled

boolean getEnabled()

Returns true if this attribute map item is enabled

Specified by:

getEnabled in interface BaseConfiguration

Returns:

The if enabled, false if disabled

setEnabled

void setEnabled(boolean enabled)

Sets the enabled attribute of the AttributeMapItem object

Specified by:

setEnabled in interface BaseConfiguration

Parameters:

enabled - The new enabled value

getScript

java.lang.String getScript()

Gets the script attribute of the AttributeMapItem object

Specified by:

getScript in interface BaseConfiguration

Returns:

The script value

setScript

void setScript(java.lang.String script)

Sets the script attribute of the AttributeMapItem object

Specified by:

setScript in interface BaseConfiguration

Parameters:

script - The new script value

getModify

boolean getModify()

Gets the modify attribute of the AttributeMapItem object

Returns:

The modify value

setModify

void setModify(boolean modify)

Sets the modify attribute of the AttributeMapItem object

Parameters:

modify - The new modify value

getAdd

boolean getAdd()

Gets the add attribute of the AttributeMapItem object

Returns:

The add value

setAdd

void setAdd(boolean add)

Sets the add attribute of the AttributeMapItem object

Parameters:

add - The new add value

getSimple

java.lang.String getSimple()

Gets the simple attribute of the AttributeMapItem object

Returns:

The simple value

setSimple

void setSimple(java.lang.String attribute)

Sets the simple attribute of the AttributeMapItem object

Parameters:

attribute - The new simple value

setType

void setType(java.lang.String type)

Sets the type attribute of the AttributeMapItem object

Parameters:

type - The new type value

getType

java.lang.String getType()

Gets the type attribute of the AttributeMapItem object

Returns:

The type value

isSimple

boolean isSimple()

Returns true if this AttributeMapItem is a simple attribute map

Returns:

The simple value

isAdvanced

boolean isAdvanced()

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

Returns:

The advanced value

isSubstitution

boolean isSubstitution()

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

Returns:

The if enabled, false if disabled

setSubstitution

void setSubstitution(java.lang.String template)

Sets the substitution template attribute of the AttributeMapItem object

Parameters:

template - The substitution template

getSubstitution

java.lang.String getSubstitution()

Gets the substitution template attribute of the AttributeMapItem object

Returns:

The substitution template

getChildAttributeMaps

java.util.List getChildAttributeMaps()

Returns a list of child attribute map items.

Returns:

List of child AttributeMapItem items

Since:

7.0