com.ibm.di.server
Class SwitchComponent

java.lang.Object
  com.ibm.di.server.AssemblyLineComponent
      com.ibm.di.server.BranchingComponent
          com.ibm.di.server.SwitchComponent

public class SwitchComponent
extends BranchingComponent

This class is used by an AssemblyLine

Field Summary

Fields inherited from class com.ibm.di.server.BranchingComponent

config, parent, psc, value

Fields inherited from class com.ibm.di.server.AssemblyLineComponent

addmap, CHECKPOINT_GETS, connConfig, connector, connPool, handler, imap, INITIALIZE, log, modmap, name, pooledConnector, restartCycle, reusingConnector, SELECT, stats

Constructor Summary

SwitchComponent(AssemblyLine parent, String name, BranchingConfig config)
Constructor for the BranchingComponent object

Method Summary

void	add(Entry meta) This method does nothing
boolean	getCaseExecuted() Returns true if any contained CASE component executed this cycle
String	getCaseExecutedBy() Returns the name of the CASE component that executed this cycle
String	getLastExpression() Returns the value from the last evaluated expression.
SwitchComponent	getParentSwitch() Returns the SWITCH component to which this CASE belongs.
int	getType() Gets the type attribute of the BranchingComponent object
void	initialize() Initializes this SwitchComponent
void	setCaseExecutedBy(String name) Sets the name of the CASE component that executed this cycle (called by CASE components)
void	setParentSwitch(SwitchComponent ps) Sets the SWITCH component to which this CASE belongs
boolean	willExecute(Entry work) Return true/false if this component should be executed.

Methods inherited from class com.ibm.di.server.BranchingComponent

add1, checkWillExecute, close, componentCount, evaluateCondition, evaluateConditions, getBaseConfiguration, getBranchType, getConfiguration, isExecuted, trigger, trigger, trigger

Methods inherited from class com.ibm.di.server.AssemblyLineComponent

callreply, checkInitialize, checkTerminate, debug, delete, deleteEntry, delta, doConnectorInitialize, doConnectorTerminate, dumpEntry, dumpObjects, expandParameters, getConfig, getConnector, getConnectorParam, getCriteria, getCurrent, getDebug, getDuplicateEntryCount, getFirstDuplicateEntry, getHandler, getLastEntry, getLastReadEntry, getLog, getName, getnext, getnext, getnextClient, getNextDuplicateEntry, getRestartInfoEntry, getStats, handleException, handleSuccess, isCheckpointRestartEnabled, isDeltaMode, isEnabled, isExceptionFatal, logmsg, lookup, lookup, mapEntry, modify, pushback, reconnect, reply, setConnectorParam, setCriteria, setCriteria, setCurrent, setDebug, setDuplicateEntryCount, setErrorObject, setName, setRestartInfoEntry, update, verifySchema, wasConfigurationModified

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwitchComponent

public SwitchComponent(AssemblyLine parent,
                       String name,
                       BranchingConfig config)
                throws Exception

Constructor for the BranchingComponent object

Parameters:

parent - The AssemblyLine that contains this SwitchComponent

name - The name of this SwitchComponent

config - The configuration for this SwitchComponent

Throws:

Exception

Method Detail

initialize

public void initialize()
                throws Exception

Initializes this SwitchComponent

Overrides:

initialize in class BranchingComponent

Throws:

Exception - Not really, but subclasses may throw Exceptions

getType

public int getType()

Gets the type attribute of the BranchingComponent object

Overrides:

getType in class BranchingComponent

Returns:

The type value

willExecute

public boolean willExecute(Entry work)
                    throws Exception

Return true/false if this component should be executed. Return true if this is a SWITCH, or if the expression in this CASE matches the expression in the containing SWITCH

Overrides:

willExecute in class BranchingComponent

Parameters:

work - The work Entry

Returns:

see above

Throws:

Exception - Any Exception that might be thrown

add

public void add(Entry meta)
         throws Exception

This method does nothing

Overrides:

add in class BranchingComponent

Parameters:

meta - The work entry to add

Throws:

Exception - the component is not initialized or the underlying Connector raised an error or some of the user-defined hooks raised an error

getLastExpression

public String getLastExpression()

Returns the value from the last evaluated expression. This is used by the CASE components when they compare to their own values.

getParentSwitch

public SwitchComponent getParentSwitch()

Returns the SWITCH component to which this CASE belongs.

setParentSwitch

public void setParentSwitch(SwitchComponent ps)

Sets the SWITCH component to which this CASE belongs

getCaseExecuted

public boolean getCaseExecuted()

Returns true if any contained CASE component executed this cycle

Returns:

true if any contained CASE component executed this cycle

getCaseExecutedBy

public String getCaseExecutedBy()

Returns the name of the CASE component that executed this cycle

Returns:

the name of the CASE component that executed this cycle

setCaseExecutedBy

public void setCaseExecutedBy(String name)

Sets the name of the CASE component that executed this cycle (called by CASE components)

Parameters:

name - The name of the CASE component that executed this cycle