com.ibm.di.config.interfaces
Interface LoopConfig

All Superinterfaces:

BaseConfiguration, BranchingConfig, ContainerConfig, Serializable

All Known Implementing Classes:

LoopConfigImpl

public interface LoopConfig
extends BranchingConfig

Field Summary

static int	LOOP_COLLECTION For each attribute in 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
static int	OPTION_NONE init options - none, terminate/initialize/select, select only
static int	OPTION_SELECT

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

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

Method Summary

int	getInitConnectorOption() Returns the type of loop we are doing
String	getLoopAttributeName() Returns the name of the loop attribute that has 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
String	getWorkAttributeName() Returns the name of the work attribute whose values to loop over
void	setInitConnectorOption(int option) Sets the loop type
void	setLoopAttributeName(String name) Sets the name of the work attribute whose values to loop over
void	setLoopType(int type) Sets the loop type
void	setWorkAttributeName(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, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isParameterLocal, nameForChild, notifyChange, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, 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 attribute in entry

See Also:

Constant Field Values

OPTION_NONE

static final int OPTION_NONE

init options - none, terminate/initialize/select, select only

See Also:

Constant Field Values

OPTION_INITIALIZE

static final int OPTION_INITIALIZE

See Also:

Constant Field Values

OPTION_SELECT

static final int OPTION_SELECT

See Also:

Constant Field Values

Method Detail

getLoopConnector

ConnectorConfig getLoopConnector()
                                 throws Exception

Returns the Loop connector configuration

Throws:

Exception

getLoopType

int getLoopType()

Returns the type of loop we are doing

setLoopType

void setLoopType(int type)

Sets the loop type

getInitConnectorOption

int getInitConnectorOption()

Returns the type of loop we are doing

setInitConnectorOption

void setInitConnectorOption(int option)

Sets the loop type

getWorkAttributeName

String getWorkAttributeName()

Returns the name of the work attribute whose values to loop over

setWorkAttributeName

void setWorkAttributeName(String name)

Sets the name of the work attribute whose values to loop over

getLoopAttributeName

String getLoopAttributeName()

Returns the name of the loop attribute that has one value from the work attribute for each loop

setLoopAttributeName

void setLoopAttributeName(String name)

Sets the name of the work attribute whose values to loop over