Package com.ibm.di.config.interfaces

Interface MetamergeFolder

All Superinterfaces:

BaseConfiguration, java.io.Serializable

All Known Subinterfaces:

MetamergeConfig

All Known Implementing Classes:

MetamergeConfigFS, MetamergeConfigImpl, MetamergeConfigXML, MetamergeFolderImpl, PropertyManagerImpl

public interface MetamergeFolder
extends BaseConfiguration

This interface describes the methods provided by a folder object. A folder is a container for other folders and leaf configuration objects.

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

Modifier and Type	Method	Description
MetamergeFolder	createFolder(java.lang.Object name)	This method creates a sub-folder in this folder with the given name.
java.lang.String[]	getNames()	This method returns an array of names contained in this folder.
java.util.Enumeration	list()	Returns a list of javax.naming.Binding objects for each of this folders child entries.

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, isProtectedParameter, 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, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

list

java.util.Enumeration list()
                    throws java.lang.Exception

Returns a list of javax.naming.Binding objects for each of this folders child entries. The Binding object contains the name of the object as well as the object itself.

Returns:

Enumeration of Binding objects

Throws:

java.lang.Exception

getNames

java.lang.String[] getNames()
                     throws java.lang.Exception

This method returns an array of names contained in this folder.

Returns:

The names value

Throws:

java.lang.Exception

createFolder

MetamergeFolder createFolder(java.lang.Object name)
                      throws java.lang.Exception

This method creates a sub-folder in this folder with the given name.

Parameters:

name - Name of sub-folder

Returns:

The MetamergeFolder object representing the new sub-folder

Throws:

java.lang.Exception