com.ibm.di.config.interfaces
Interface LoopConfig

All Superinterfaces:
BaseConfiguration, BranchingConfig, ContainerConfig, java.io.Serializable
All Known Implementing Classes:
LoopConfigImpl

public interface LoopConfig
extends BranchingConfig

Configuration for a Loop Component in an AssemblyLine.


Field Summary
static int LOOP_COLLECTION
          For each value of an Attribute in the work Entry
static int LOOP_CONDITIONS
          While conditions are true
static int LOOP_CONNECTOR_FC
          For each Entry returned by connector or FC
static int OPTION_INITIALIZE
          Initialize the Connector every time the Loop is entered
static int OPTION_NONE
          Initialize once in the AssemblyLine
static int OPTION_SELECT
          Initialize the connector and select every time the Loop is entered.
 
Fields inherited from interface com.ibm.di.config.interfaces.BranchingConfig
BRANCH_CASE, BRANCH_ELSE, BRANCH_ELSEIF, BRANCH_IF, BRANCH_SWITCH
 
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
 int getInitConnectorOption()
          Returns the initialization option.
 java.lang.String getLoopAttributeName()
          Returns the name of the loop attribute that gets one value from the work attribute for each loop.
 ConnectorConfig getLoopConnector()
          Returns the Loop connector configuration
 int getLoopType()
          Returns the type of loop we are doing.
 java.lang.String getWorkAttributeName()
          Returns the name of the work attribute whose values to loop over Only interesting for type LOOP_COLLECTION.
 void setInitConnectorOption(int option)
          Sets the initialization option.
 void setLoopAttributeName(java.lang.String name)
          Sets the name of the loop attribute that gets one value from the work attribute for each loop
 void setLoopType(int type)
          Sets the loop type.
 void setWorkAttributeName(java.lang.String name)
          Sets the name of the work attribute whose values to loop over
 
Methods inherited from interface com.ibm.di.config.interfaces.BranchingConfig
getBranchType, getConditions, getMatchAny, newCondition, numberLoops, setBranchType, setMatchAny, totalSize
 
Methods inherited from interface com.ibm.di.config.interfaces.ContainerConfig
addConfig, containsConfig, getConfig, getConfig, getConfig, getConfigurations, getInheritedConfigurations, indexOf, indexOf, insertConfig, moveConfig, moveConfig, moveConfig, removeConfig, removeConfig, removeConfig, size
 
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, toEntry, updateInheritsFrom, willFlatten
 

Field Detail

LOOP_CONDITIONS

static final int LOOP_CONDITIONS
While conditions are true

See Also:
Constant Field Values

LOOP_CONNECTOR_FC

static final int LOOP_CONNECTOR_FC
For each Entry returned by connector or FC

See Also:
Constant Field Values

LOOP_COLLECTION

static final int LOOP_COLLECTION
For each value of an Attribute in the work Entry

See Also:
Constant Field Values

OPTION_NONE

static final int OPTION_NONE
Initialize once in the AssemblyLine

See Also:
Constant Field Values

OPTION_INITIALIZE

static final int OPTION_INITIALIZE
Initialize the Connector every time the Loop is entered

See Also:
Constant Field Values

OPTION_SELECT

static final int OPTION_SELECT
Initialize the connector and select every time the Loop is entered.

See Also:
Constant Field Values
Method Detail

getLoopConnector

ConnectorConfig getLoopConnector()
                                 throws java.lang.Exception
Returns the Loop connector configuration

Throws:
java.lang.Exception

getLoopType

int getLoopType()
Returns the type of loop we are doing. The Loop type will be one of LOOP_CONDITIONS, LOOP_CONNECTOR_FC or LOOP_COLLECTION.


setLoopType

void setLoopType(int type)
Sets the loop type. One of LOOP_CONDITIONS, LOOP_CONNECTOR_FC or LOOP_COLLECTION.


getInitConnectorOption

int getInitConnectorOption()
Returns the initialization option. Only interesting for a Connector Loop. One of OPTION_NONE, OPTION_INITIALIZE, OPTION_SELECT


setInitConnectorOption

void setInitConnectorOption(int option)
Sets the initialization option. One of OPTION_NONE, OPTION_INITIALIZE, OPTION_SELECT


getWorkAttributeName

java.lang.String getWorkAttributeName()
Returns the name of the work attribute whose values to loop over Only interesting for type LOOP_COLLECTION.


setWorkAttributeName

void setWorkAttributeName(java.lang.String name)
Sets the name of the work attribute whose values to loop over


getLoopAttributeName

java.lang.String getLoopAttributeName()
Returns the name of the loop attribute that gets one value from the work attribute for each loop. Only interesting for type LOOP_COLLECTION.


setLoopAttributeName

void setLoopAttributeName(java.lang.String name)
Sets the name of the loop attribute that gets one value from the work attribute for each loop