com.ibm.di.config.interfaces
Interface BranchingConfig

All Superinterfaces:
BaseConfiguration, ContainerConfig, Serializable
All Known Subinterfaces:
LoopConfig
All Known Implementing Classes:
BranchingConfigImpl, LoopConfigImpl

public interface BranchingConfig
extends ContainerConfig

The configuration of an AssemblyLine Branch component.


Field Summary
static int BRANCH_CASE
          BRANCH_SWITCH - The child container of a BRANCH_SWITCH object
static int BRANCH_ELSE
          BRANCH_ELSE- The last part of an if/else sequence with no conditions
static int BRANCH_ELSEIF
          BRANCH_ELSEIF - This is an ELSE-IF branch with conditions
static int BRANCH_IF
          BRANCH_IF - This is the pre 6.1 branching config
static int BRANCH_SWITCH
          BRANCH_SWITCH - The container of a number of BRANCH_CASE objects
 
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 getBranchType()
           
 ContainerConfig getConditions()
           
 boolean getMatchAny()
           
 BranchCondition newCondition()
           
 int numberLoops()
           
 void setBranchType(int type)
          Sets the branch type (e.g.
 void setMatchAny(boolean matchAny)
          Sets the match any flag.
 int totalSize()
          Returns the total number of components in this Branch.
 
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, 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, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, toEntry, updateInheritsFrom, willFlatten
 

Field Detail

BRANCH_IF

static final int BRANCH_IF
BRANCH_IF - This is the pre 6.1 branching config

See Also:
Constant Field Values

BRANCH_ELSEIF

static final int BRANCH_ELSEIF
BRANCH_ELSEIF - This is an ELSE-IF branch with conditions

See Also:
Constant Field Values

BRANCH_ELSE

static final int BRANCH_ELSE
BRANCH_ELSE- The last part of an if/else sequence with no conditions

See Also:
Constant Field Values

BRANCH_SWITCH

static final int BRANCH_SWITCH
BRANCH_SWITCH - The container of a number of BRANCH_CASE objects

See Also:
Constant Field Values

BRANCH_CASE

static final int BRANCH_CASE
BRANCH_SWITCH - The child container of a BRANCH_SWITCH object

See Also:
Constant Field Values
Method Detail

totalSize

int totalSize()
Returns the total number of components in this Branch. This includes all components plus components in sub branches.

Returns:
total number of components in this Branch

numberLoops

int numberLoops()
Returns:
The total number of LoopConfig items in this Branch and its child branches/loops. Since BranchingConfig also add an extra invisible EndBranch component we also count these.

getConditions

ContainerConfig getConditions()
Returns:
The conditions container.

newCondition

BranchCondition newCondition()
Returns:
A new populated condition config.

getMatchAny

boolean getMatchAny()
Returns:
The match any flag.

setMatchAny

void setMatchAny(boolean matchAny)
Sets the match any flag.

Parameters:
matchAny - The value of the match any flag.

getBranchType

int getBranchType()
Returns:
The branch type (e.g. BRANCH_IF, BRANCH_ELSEIF, BRANCH_ELSE, BRANCH_SWITCH, BRANCH_CASE) Returns BRANCH_IF if the parameter is not set.

setBranchType

void setBranchType(int type)
Sets the branch type (e.g. BRANCH_IF, BRANCH_ELSEIF, BRANCH_ELSE, BRANCH_SWITCH, BRANCH_CASE).

Parameters:
type - The type of the branch component.