com.ibm.di.config.base
Class HookConfigImpl

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

All Implemented Interfaces:

BaseConfiguration, HookConfig, MetamergeConfigChangeListener, Serializable

public class HookConfigImpl
extends BaseConfigurationImpl
implements HookConfig

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

HookConfigImpl()

HookConfigImpl(Object config)

HookConfigImpl(Object name, String script)

Method Summary

boolean	couldInherit()
boolean	flatten(List excludedNS) flatten - combines all values from this object and its inherited objects into one single config object.
boolean	getEnabled() Gets the enabled attribute of the BaseConfiguration object
Object	getHookName()
String	getScript() Gets the script attribute of the BaseConfiguration object
void	notifyChange(Object source, Object key, int operation, Object userObject) Signal a change event to listeners.
void	setEnabled(boolean enabled) Gets the enabled attribute of the BaseConfiguration object
void	setHookName(Object name)
void	setScript(String script) Sets the script attribute of the BaseConfiguration 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

HookConfigImpl

public HookConfigImpl()

HookConfigImpl

public HookConfigImpl(Object config)

HookConfigImpl

public HookConfigImpl(Object name,
                      String script)

Method Detail

getHookName

public Object getHookName()

Specified by:

getHookName in interface HookConfig

setHookName

public void setHookName(Object name)

Specified by:

setHookName in interface HookConfig

getEnabled

public boolean getEnabled()

Description copied from interface: BaseConfiguration

Gets the enabled attribute of the BaseConfiguration object

Specified by:

getEnabled in interface BaseConfiguration

Specified by:

getEnabled in interface HookConfig

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 BaseConfiguration

Specified by:

setEnabled in interface HookConfig

Overrides:

setEnabled in class BaseConfigurationImpl

getScript

public String getScript()

Description copied from interface: BaseConfiguration

Gets the script attribute of the BaseConfiguration object

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 BaseConfiguration

Overrides:

setScript in class BaseConfigurationImpl

Parameters:

script - The new script value

couldInherit

public boolean couldInherit()

Specified by:

couldInherit in interface HookConfig

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