com.ibm.di.config.interfaces
Interface BaseConfiguration

All Superinterfaces:

Serializable

All Known Subinterfaces:

ALMappingConfig, AssemblyLineConfig, AttributeMapConfig, AttributeMapItem, BranchCondition, BranchingConfig, CallConfig, CallParamConfig, CheckpointConfig, ConnectorConfig, ConnectorSchemaConfig, ConnectorSchemaItemConfig, ContainerConfig, DeltaConfig, EventHandlerActionConfig, EventHandlerActionItemConfig, EventHandlerConditionConfig, EventHandlerConfig, ExposedProperty, ExternalPropertiesConfig, FormConfig, FormItemConfig, FunctionConfig, HookConfig, HooksConfig, InheritConfig, InstanceConfig, LibraryConfig, LinkCriteriaConfig, LinkCriteriaItem, LogConfig, LogConfigItem, LoopConfig, MetamergeConfig, MetamergeFolder, NamespaceConfig, OperationConfig, OperationsConfig, ParserConfig, PoolDefConfig, PoolInstanceConfig, PropertyConfig, PropertyManager, PropertyStoreConfig, RawConnectorConfig, ReconnectConfig, SandboxConfig, SchemaConfig, SchemaItemConfig, ScriptConfig, SolutionInterface, TombstonesConfig

All Known Implementing Classes:

ALMappingConfigImpl, AssemblyLineConfigImpl, AttributeMapConfigImpl, AttributeMapItemImpl, BaseConfigurationImpl, BranchConditionImpl, BranchingConfigImpl, CallConfigImpl, CallParamConfigImpl, CheckpointConfigImpl, ConnectorConfigImpl, ConnectorSchemaConfigImpl, ConnectorSchemaItemConfigImpl, ContainerConfigImpl, DeltaConfigImpl, EventHandlerActionConfigImpl, EventHandlerActionItemConfigImpl, EventHandlerConditionConfigImpl, EventHandlerConfigImpl, ExposedPropertyImpl, ExternalFile, ExternalPropertiesDelegator, ExternalPropertiesImpl, FormConfigImpl, FormItemConfigImpl, FunctionConfigImpl, HookConfigImpl, HooksConfigImpl, InheritConfigImpl, InstanceConfigImpl, LibraryConfigImpl, LinkCriteriaConfigImpl, LinkCriteriaItemImpl, LogConfigImpl, LogConfigItemImpl, LoopConfigImpl, MetamergeConfigFS, MetamergeConfigImpl, MetamergeConfigXML, MetamergeFolderImpl, NamespaceConfigImpl, OperationConfigImpl, ParserConfigImpl, PoolDefConfigImpl, PoolInstanceConfigImpl, PropertyConfigImpl, PropertyManagerImpl, PropertyStoreConfigImpl, RawConnectorConfigImpl, ReconnectConfigImpl, SandboxConfigImpl, SchemaConfigImpl, SchemaItemConfigImpl, ScriptConfigImpl, SolutionInterfaceImpl, TombstonesConfigImpl

public interface BaseConfiguration
extends Serializable

Field Summary

static int	DISABLE_EXTPROPS Flag to disable expansion of external properties (getParameter)
static int	DISABLE_INHERITANCE Flag to disable inherited access (getParameter)
static String	INHERIT_NONE Explicitly disregars inheritance
static String	INHERIT_PARENT Inherit from parent
static int	ONE_LEVEL Return keys of this object
static int	RECURSIVE Flag that determines if getKeys() should recurse to inherited object
static int	RECURSIVE_ONELEVEL Convenience for RECURSIVE + ONE_LEVEL
static int	RECURSIVE_SUBTREE Convenience for RECURSIVE + SUBTREE
static int	SEARCH_EXACTCASE
static int	SEARCH_ONELEVEL
static int	SEARCH_PARAMNAME
static int	SEARCH_PARAMNAME_RE
static int	SEARCH_PROPERTY
static int	SEARCH_REGEX
static int	SUBTREE Return child entries's keys of this object

Method Summary

void	addListener(MetamergeConfigChangeListener listener) Registers an object to be notified of change events in this object.
boolean	flatten(List excludedNS) flatten - combines all values from this object and its inherited objects into one single config object.
void	fromEntry(Object entry) This method should populate this object with data from a com.ibm.di.entry.Entry object.
boolean	getBooleanParameter(Object name, boolean defval) Converts value from getParameter call to a boolean
BaseConfiguration	getChild(Object name) Returns the configuration object named name.
BaseConfiguration	getChildForPath(String path) This method traverses the child hierarchy (from the top) and returns the configuration object associated with the path.
List	getChildNames() Returns a list of names for all child configuration object
Object	getClone() Returns a cloned version of this object.
TreeMap	getData() Returns a TreeMap with key/value pairs for all local parameters.
Iterator	getDataIterator() Returns an Iterator for the keys in the data object
boolean	getDebug() Returns the debug flag for the object.
boolean	getDebug(boolean defval) Returns the debug flag for the object.
boolean	getDebugBreak(boolean defval) Gets the debugBreak attribute of the BaseConfiguration object
boolean	getEnabled() Gets the enabled attribute of the BaseConfiguration object
int	getFlags() Returns the flags how the getParameter behaves in terms of inheritance and external properties.
BaseConfiguration	getInheritsFrom() Returns the object from which this object inherits data.
String	getInheritsFromRef() Gets the name of the object this object should inherit its values.
int	getIntegerParameter(Object name, int defval) Converts value from getParameter call to an int
List	getKeys(int level) Gets the keys attribute of the BaseConfiguration object
boolean	getLogEnabled() Gets the log enabled attribute of the BaseConfiguration object
MetamergeConfig	getMetamergeConfig() Gets the metamergeConfig objects to which this object belongs.
boolean	getModified() Modified state
Name	getName() The object's full name
Object	getNamespace() Gets the namespace attribute of the BaseConfiguration object
String	getNullBehavior() Gets the nullBehavior attribute of the BaseConfiguration object
String	getNullBehaviorValue() Gets the nullBehaviorValue attribute of the BaseConfiguration object
String	getNullDefinition() Gets the nullDefinition attribute of the BaseConfiguration object
String	getNullDefinitionValue() Gets the nullDefinitionValue attribute of the BaseConfiguration object
Object	getParameter(Object name) Returns the value for a given config item.
Object	getParameter(Object name, Object createValue) Gets the parameter attribute of the BaseConfiguration object.
Object	getParameter(Object name, Object createValue, List cref) Returns the value for a given config item.
String	getParameterPropertySource(Object name) Returns the user property name for a parameter
Object	getParameterRaw(Object name) Returns the value for a given config item without expanding the property value.
BaseConfiguration	getParent() Returns the parent object to which this object belongs.
String	getPath() Returns the complete path to this object.
List	getReferences(List list) Returns a list of all references to other object from which this object or its children inherit from.
String	getScript() Gets the script attribute of the BaseConfiguration object
String	getScriptEngine() Gets the ScriptEngine attribute of the BaseConfiguration object
String	getShortName() Gets the shortName attribute of the BaseConfiguration object.
String	getStringParameter(Object name) Converts value from getParameter call to a string
Map	getSubstitutionMap() Returns the Map object containing available objects for param substitution
boolean	getUseListeners()
String	getUserComment() Returns the user defined comment string
boolean	hasParameter(Object name) Returns true if parameter name is local to this object.
void	init() Called to initialize to object.
boolean	isParameterLocal(Object name) Returns true if either the parameter is local or false if the parameter does not exist either in this object or in any inherited object.
String	nameForChild(BaseConfiguration config) Returns the name for a configuration object
void	notifyChange(Object source, Object key, int operation) Signal a change event to listeners.
void	notifyChange(Object source, Object key, int operation, Object userObject) Signal a change event to listeners.
void	removeListener(MetamergeConfigChangeListener listener) Removes a listener from the notification list.
void	removeParameter(Object name) Removes a local parameter from this object.
List	search(String text, int options, int sizelimit) Searches a configuration object and optionally its children for a specific key or value.
List	search(String text, int options, int sizelimit, List results) Searches a configuration object and optionally its children for a specific key or value.
void	setBooleanParameter(Object name, boolean value) Calls setParameter converting value to a Boolean object
void	setChild(Object name, BaseConfiguration config) Associates a configuration object with a name in this configuration
void	setData(TreeMap data) Sets the data to be used by this object by passing a TreeMap of key/value pairs.
void	setDebug(boolean debug) Common method - Sets the debug flag for the object
void	setDebugBreak(boolean debug) Sets the debugBreak attribute of the BaseConfiguration object
void	setEnabled(boolean enabled) Gets the enabled attribute of the BaseConfiguration object
void	setFlags(int flags) Controls how the getParameter behaves in terms of inheritance and external properties.
void	setInheritsFrom(BaseConfiguration inherit) Sets the object from which this object inherits data.
void	setInheritsFromRef(String ref) Sets the name of the object from which this object should inherit its values.
void	setIntegerParameter(Object name, int value) Calls setParameter converting value to an Integer object
void	setLogEnabled(boolean enabled) Sets the log enabled attribute of the BaseConfiguration object
void	setMetamergeConfig(MetamergeConfig mc) Sets the Metamergeconfig object to which this object belongs.
void	setModified(boolean modified) Sets the modified attribute of the BaseConfiguration object
void	setName(Name name) Sets the name attribute of the BaseConfiguration object
void	setName(String name) Sets the name attribute of the BaseConfiguration object
void	setNullBehavior(String nb) Sets the nullBehavior attribute of the BaseConfiguration object
void	setNullBehaviorValue(String nbv) Sets the nullBehaviorValue attribute of the BaseConfiguration object
void	setNullDefinition(String nb) Sets the nullDefinition attribute of the BaseConfiguration object
void	setNullDefinitionValue(String nbv) Sets the nullDefinitionValue attribute of the BaseConfiguration object
void	setParameter(Object name, Object value) Sets the value for a given config item
void	setParameter(Object name, Object value, boolean notify) Sets the value for a given config item, optionally notifying the change.
void	setParameterPropertySource(Object name, String propertySource) Sets the user property name to use for an attribute
void	setParent(BaseConfiguration parent) Sets the parent object to which this object belongs.
void	setProtectedParameter(Object name, Object value) Stores the parameter value in the default password store if one is configured.
void	setScript(String script) Sets the script attribute of the BaseConfiguration object
void	setScriptEngine(String engine) Sets the ScriptEngine attribute of the BaseConfiguration object
void	setStringParameter(Object name, String value) Calls setParameter
void	setSubstitutionMap(Map map) Sets the substutition map for this configuration object
void	setupInheritanceChain() Called to initialize the inheritance chain for this object.
void	setUseListeners(boolean value)
void	setUserComment(String comment) Sets the user defined comment string
int	size() Number of key/value pairs.
Object	toEntry() Object/State using Entry object.
void	updateInheritsFrom(String ref) Sets the name of the object from which this object should inherit its values and calls the setupInheritanceChain to activate the change.
boolean	willFlatten(List excludedNS) willFlatten - returns true if this object will attempt flattening given the provided excluded namespaces

Field Detail

INHERIT_NONE

static final String INHERIT_NONE

Explicitly disregars inheritance

See Also:

Constant Field Values

INHERIT_PARENT

static final String INHERIT_PARENT

Inherit from parent

See Also:

Constant Field Values

ONE_LEVEL

static final int ONE_LEVEL

Return keys of this object

See Also:

Constant Field Values

SUBTREE

static final int SUBTREE

Return child entries's keys of this object

See Also:

Constant Field Values

RECURSIVE

static final int RECURSIVE

Flag that determines if getKeys() should recurse to inherited object

See Also:

Constant Field Values

RECURSIVE_SUBTREE

static final int RECURSIVE_SUBTREE

Convenience for RECURSIVE + SUBTREE

See Also:

Constant Field Values

RECURSIVE_ONELEVEL

static final int RECURSIVE_ONELEVEL

Convenience for RECURSIVE + ONE_LEVEL

See Also:

Constant Field Values

DISABLE_INHERITANCE

static final int DISABLE_INHERITANCE

Flag to disable inherited access (getParameter)

See Also:

Constant Field Values

DISABLE_EXTPROPS

static final int DISABLE_EXTPROPS

Flag to disable expansion of external properties (getParameter)

See Also:

Constant Field Values

SEARCH_ONELEVEL

static final int SEARCH_ONELEVEL

See Also:

Constant Field Values

SEARCH_EXACTCASE

static final int SEARCH_EXACTCASE

See Also:

Constant Field Values

SEARCH_REGEX

static final int SEARCH_REGEX

See Also:

Constant Field Values

SEARCH_PARAMNAME

static final int SEARCH_PARAMNAME

See Also:

Constant Field Values

SEARCH_PROPERTY

static final int SEARCH_PROPERTY

See Also:

Constant Field Values

SEARCH_PARAMNAME_RE

static final int SEARCH_PARAMNAME_RE

See Also:

Constant Field Values

Method Detail

getName

Name getName()

The object's full name

Returns:

The name value

getShortName

String getShortName()

Gets the shortName attribute of the BaseConfiguration object. The short name is the last component in a multi component name. E.g.: AssemblyLines/MyName --> "MyName"

Returns:

The shortName value

setName

void setName(Name name)

Sets the name attribute of the BaseConfiguration object

Parameters:

name - The new name value

setName

void setName(String name)
             throws Exception

Sets the name attribute of the BaseConfiguration object

Parameters:

name - The new name value

Throws:

Exception - if the operation does not succeed

getNamespace

Object getNamespace()

Gets the namespace attribute of the BaseConfiguration object

Returns:

The namespace value

getModified

boolean getModified()

Modified state

Returns:

The modified value

setModified

void setModified(boolean modified)

Sets the modified attribute of the BaseConfiguration object

Parameters:

modified - The new modified value

setFlags

void setFlags(int flags)

Controls how the getParameter behaves in terms of inheritance and external properties.

getFlags

int getFlags()

Returns the flags how the getParameter behaves in terms of inheritance and external properties.

getParameterRaw

Object getParameterRaw(Object name)

Returns the value for a given config item without expanding the property value.

Parameters:

name - The parameter name

Returns:

The parameter value

getParameter

Object getParameter(Object name)

Returns the value for a given config item. This method will call inherited object's getParameter if this object does not contain the named value. In case of returning an inherited value, the value from the inherited object will be cloned. It is up to the user to create a key/value local to this object by calling one of the setParameter methods.

Parameters:

name - The parameter name

Returns:

The parameter value

getParameter

Object getParameter(Object name,
                    Object createValue)

Gets the parameter attribute of the BaseConfiguration object. If the parameter is not present a default value is assigned to the parameter using createValue.

Parameters:

name - The parameter name

createValue - The value added to this object in case the parameter does not exist

Returns:

The parameter value

getParameter

Object getParameter(Object name,
                    Object createValue,
                    List cref)

Returns the value for a given config item. This method will call inherited object's getParameter if this object does not contain the named value. In case of returning an inherited value, the value from the inherited object will be cloned. It is up to the user to create a key/value local to this object by calling one of the setParameter methods. This method also conveys the List object to ParameterSubstitution calls to resolve circular references. If the parameter is not present even after calling inherited object's getParameter, a default value is assigned to the parameter using createValue.

Parameters:

name - The parameter name

createValue - The value added to this object in case the parameter does not exist "@param cref The circular references list

Returns:

The parameter value

getStringParameter

String getStringParameter(Object name)

Converts value from getParameter call to a string

Parameters:

name - The parameter name

Returns:

The stringParameter value

getBooleanParameter

boolean getBooleanParameter(Object name,
                            boolean defval)

Converts value from getParameter call to a boolean

Parameters:

name - The parameter name

defval - The default value if parameter does not exist

Returns:

The boolean value

getIntegerParameter

int getIntegerParameter(Object name,
                        int defval)

Converts value from getParameter call to an int

Parameters:

name - The parameter name

defval - The default value if parameter does not exist

Returns:

The integerParameter value

setParameter

void setParameter(Object name,
                  Object value)

Sets the value for a given config item

Parameters:

name - Parameter name

value - Parameter value

setProtectedParameter

void setProtectedParameter(Object name,
                           Object value)
                           throws Exception

Stores the parameter value in the default password store if one is configured. Retrieval of the parameter is done through the standard getParameter methods.

Parameters:

name - Parameter name

value - Parameter value

Throws:

Exception

setBooleanParameter

void setBooleanParameter(Object name,
                         boolean value)

Calls setParameter converting value to a Boolean object

Parameters:

name - Parameter name

value - Parameter value

setIntegerParameter

void setIntegerParameter(Object name,
                         int value)

Calls setParameter converting value to an Integer object

Parameters:

name - Parameter name

value - Parameter value

setStringParameter

void setStringParameter(Object name,
                        String value)

Calls setParameter

Parameters:

name - Parameter name

value - Parameter value

setParameter

void setParameter(Object name,
                  Object value,
                  boolean notify)

Sets the value for a given config item, optionally notifying the change. If notify is true, the behavior is identical to setParameter( name, value ).

Parameters:

name - Parameter name

value - Parameter value

notify - If true, notify of the change

Since:

6.1.1

removeParameter

void removeParameter(Object name)

Removes a local parameter from this object.

Parameters:

name - Parameter name

hasParameter

boolean hasParameter(Object name)

Returns true if parameter name is local to this object.

Parameters:

name - Parameter name

Returns:

true if name is local

isParameterLocal

boolean isParameterLocal(Object name)

Returns true if either the parameter is local or false if the parameter does not exist either in this object or in any inherited object.

Parameters:

name - Parameter name

Returns:

True if name is local

getParameterPropertySource

String getParameterPropertySource(Object name)

Returns the user property name for a parameter

Parameters:

name - Parameter name

Returns:

The user property source value

setParameterPropertySource

void setParameterPropertySource(Object name,
                                String propertySource)

Sets the user property name to use for an attribute

Parameters:

name - Parameter name

propertySource - User property name

size

int size()

Number of key/value pairs.

Returns:

A count of local items in this object

getData

TreeMap getData()

Returns a TreeMap with key/value pairs for all local parameters.

Returns:

The treemap

setData

void setData(TreeMap data)

Sets the data to be used by this object by passing a TreeMap of key/value pairs. The TreeMap is not cloned.

Parameters:

data - The new data value

init

void init()
          throws Exception

Called to initialize to object.

Throws:

Exception - if the initialization fails

getDataIterator

Iterator getDataIterator()

Returns an Iterator for the keys in the data object

Returns:

The dataIterator value

getKeys

List getKeys(int level)

Gets the keys attribute of the BaseConfiguration object

Parameters:

level - The level of keys returned.

Returns:

The list of keys

getUseListeners

boolean getUseListeners()

setUseListeners

void setUseListeners(boolean value)

addListener

void addListener(MetamergeConfigChangeListener listener)

Registers an object to be notified of change events in this object.

Parameters:

listener - The listener object to notify.

removeListener

void removeListener(MetamergeConfigChangeListener listener)

Removes a listener from the notification list.

Parameters:

listener - The listener object to remove

notifyChange

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

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

Parameters:

source - The caller initiating the change event

key - The key that changed

operation - The operation performed on key

notifyChange

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

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

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

toEntry

Object toEntry()
               throws Exception

Object/State using Entry object. This method should return a com.ibm.di.entry.Entry object from the internal data structure.

Returns:

The entry representing

Throws:

Exception - Any exception thrown by the implementing class

fromEntry

void fromEntry(Object entry)
               throws Exception

This method should populate this object with data from a com.ibm.di.entry.Entry object.

Parameters:

entry - The entry containing data

Throws:

Exception - Any exception thrown by the implementing class

setParent

void setParent(BaseConfiguration parent)

Sets the parent object to which this object belongs. Many configuration objects are part of another object and cannot be addressed by the MetamergeConfig object. These objects should notify their parents of any changes made.

Parameters:

parent - The new parent value

getParent

BaseConfiguration getParent()

Returns the parent object to which this object belongs.

Returns:

The parent value

setMetamergeConfig

void setMetamergeConfig(MetamergeConfig mc)

Sets the Metamergeconfig object to which this object belongs.

Parameters:

mc - The new metamergeConfig object

getMetamergeConfig

MetamergeConfig getMetamergeConfig()

Gets the metamergeConfig objects to which this object belongs.

Returns:

The metamergeConfig object

setupInheritanceChain

void setupInheritanceChain()
                           throws Exception

Called to initialize the inheritance chain for this object.

Throws:

Exception - if the operation does not succeed

getInheritsFrom

BaseConfiguration getInheritsFrom()

Returns the object from which this object inherits data.

Returns:

The inherited object

getInheritsFromRef

String getInheritsFromRef()

Gets the name of the object this object should inherit its values.

Returns:

The name of the inherited object

setInheritsFromRef

void setInheritsFromRef(String ref)

Sets the name of the object from which this object should inherit its values.

Parameters:

ref - The new inheritsFromRef value

updateInheritsFrom

void updateInheritsFrom(String ref)
                        throws Exception

Sets the name of the object from which this object should inherit its values and calls the setupInheritanceChain to activate the change.

Parameters:

ref - The new inheritsFromRef value

Throws:

Exception

setInheritsFrom

void setInheritsFrom(BaseConfiguration inherit)

Sets the object from which this object inherits data.

Parameters:

inherit - The new inheritsFrom value

getDebug

boolean getDebug()

Returns the debug flag for the object.

Returns:

The debug value

getDebug

boolean getDebug(boolean defval)

Returns the debug flag for the object.

Parameters:

defval - The value to be returned, if the debug parameter cannot be found

Returns:

The debug value

setDebug

void setDebug(boolean debug)

Common method - Sets the debug flag for the object

Parameters:

debug - The new debug value

getDebugBreak

boolean getDebugBreak(boolean defval)

Gets the debugBreak attribute of the BaseConfiguration object

Parameters:

defval - The value to be returned, if the debugBreak parameter cannot be found

Returns:

The debugBreak value

setDebugBreak

void setDebugBreak(boolean debug)

Sets the debugBreak attribute of the BaseConfiguration object

Parameters:

debug - The new debugBreak value

getScript

String getScript()

Gets the script attribute of the BaseConfiguration object

Returns:

The script value

setScript

void setScript(String script)

Sets the script attribute of the BaseConfiguration object

Parameters:

script - The new script value

getScriptEngine

String getScriptEngine()

Gets the ScriptEngine attribute of the BaseConfiguration object

Returns:

The ScriptEngine value

setScriptEngine

void setScriptEngine(String engine)

Sets the ScriptEngine attribute of the BaseConfiguration object

Parameters:

engine - The new ScriptEngine value

getNullBehavior

String getNullBehavior()

Gets the nullBehavior attribute of the BaseConfiguration object

Returns:

The nullBehavior value

getNullBehaviorValue

String getNullBehaviorValue()

Gets the nullBehaviorValue attribute of the BaseConfiguration object

Returns:

The nullBehaviorValue value

setNullBehavior

void setNullBehavior(String nb)

Sets the nullBehavior attribute of the BaseConfiguration object

Parameters:

nb - The new nullBehavior value

setNullBehaviorValue

void setNullBehaviorValue(String nbv)

Sets the nullBehaviorValue attribute of the BaseConfiguration object

Parameters:

nbv - The new nullBehaviorValue value

getNullDefinition

String getNullDefinition()

Gets the nullDefinition attribute of the BaseConfiguration object

Returns:

The nullDefinition value

getNullDefinitionValue

String getNullDefinitionValue()

Gets the nullDefinitionValue attribute of the BaseConfiguration object

Returns:

The nullDefinitionValue value

setNullDefinition

void setNullDefinition(String nb)

Sets the nullDefinition attribute of the BaseConfiguration object

Parameters:

nb - The new nullBehavior value

setNullDefinitionValue

void setNullDefinitionValue(String nbv)

Sets the nullDefinitionValue attribute of the BaseConfiguration object

Parameters:

nbv - The new nullBehaviorValue value

getEnabled

boolean getEnabled()

Gets the enabled attribute of the BaseConfiguration object

Returns:

The nullBehaviorValue value

setEnabled

void setEnabled(boolean enabled)

Gets the enabled attribute of the BaseConfiguration object

getClone

Object getClone()
                throws Exception

Returns a cloned version of this object.

Throws:

Exception

getLogEnabled

boolean getLogEnabled()

Gets the log enabled attribute of the BaseConfiguration object

Returns:

The nullBehaviorValue value

setLogEnabled

void setLogEnabled(boolean enabled)

Sets the log enabled attribute of the BaseConfiguration object

setUserComment

void setUserComment(String comment)

Sets the user defined comment string

getUserComment

String getUserComment()

Returns the user defined comment string

getSubstitutionMap

Map getSubstitutionMap()

Returns the Map object containing available objects for param substitution

setSubstitutionMap

void setSubstitutionMap(Map map)

Sets the substutition map for this configuration object

willFlatten

boolean willFlatten(List excludedNS)

willFlatten - returns true if this object will attempt flattening given the provided excluded namespaces

flatten

boolean flatten(List excludedNS)
                throws Exception

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.

Parameters:

excludedNS - List of namespaces to exclude from flattening

Returns:

FALSE if this object did not flatten because of inheritance form excludedNS, TRUE otherwise

Throws:

Exception

getReferences

List getReferences(List list)

Returns a list of all references to other object from which this object or its children inherit from.

Parameters:

list - If non-null, the object must use the provided list rather than creating its own

search

List search(String text,
            int options,
            int sizelimit)

Searches a configuration object and optionally its children for a specific key or value.

Parameters:

text - The search text

options - Search options (oneLevel=1, exactCase=2, regExp=4, paramName=8)

sizelimit - Max number of hits returned

search

List search(String text,
            int options,
            int sizelimit,
            List results)

Searches a configuration object and optionally its children for a specific key or value.

Parameters:

text - The search text

options - Search options (oneLevel=1, exactCase=2, regExp=4, paramName=8)

sizelimit - Max number of hits returned

results - A list of results.

getChild

BaseConfiguration getChild(Object name)

Returns the configuration object named name.

Parameters:

name - The name of the configuration object

setChild

void setChild(Object name,
              BaseConfiguration config)

Associates a configuration object with a name in this configuration

Parameters:

name - The name

config - The configuration object

nameForChild

String nameForChild(BaseConfiguration config)

Returns the name for a configuration object

Parameters:

config - The configuration object

Returns:

The name associated with config or null if not found

getChildNames

List getChildNames()

Returns a list of names for all child configuration object

Returns:

list of names

getPath

String getPath()

Returns the complete path to this object. The complete path is built by concatenating the names (child names, not necessarily the actual object names as returned by getName()) for all objects in the parent chain. The parent chain typically starts with the major objects like AssemblyLineConfig etc.

Returns:

The full path to this object

getChildForPath

BaseConfiguration getChildForPath(String path)
                                  throws NameNotFoundException

This method traverses the child hierarchy (from the top) and returns the configuration object associated with the path. This method will in effect split the path in its components and recursively call getChild() to drill down to the last object in the path.

Parameters:

path - The complete path to an object (as returned by getPath())

Returns:

The configuration object associated with the path

Throws:

Exception - NameNotFoundException

NameNotFoundException