Package org.chenile.owiz.impl

Class Chain<InputType>

java.lang.Object

org.chenile.owiz.impl.CommandBase<InputType>

org.chenile.owiz.impl.Chain<InputType>

All Implemented Interfaces:

AttachableCommand<InputType>, BypassableCommand<InputType>, Command<InputType>, OrchestrationAware<InputType>

Direct Known Subclasses:

FilterChain, ForLoop, ParallelChain

public class Chain<InputType>
extends CommandBase<InputType>
implements Command<InputType>, AttachableCommand<InputType>

A chain is a command that executes a chain of other commands.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<OrderedCommandDesc>	commandDescSet
protected int	currentIndex
static final String	INDEX

Fields inherited from class org.chenile.owiz.impl.CommandBase

commandDescriptor, orchConfigurator

Constructor Summary

Constructors

Constructor	Description
Chain()

Method Summary

Modifier and Type	Method	Description
void	attachCommand(AttachmentDescriptor<InputType> attachmentDescriptor, CommandDescriptor<InputType> command)	Allow a command to attach itself to this chain.
protected void	doExecute(InputType context)
protected List<Command<InputType>>	obtainExecutionCommands(InputType context)	Obtain the list of commands that needs to be actually executed.
protected boolean	shouldStopChain(InputType context)	AN extension point to allow sub classes to stop a chain if a condition is satisfied.

Methods inherited from class org.chenile.owiz.impl.CommandBase

bypass, execute, getConfigValue, getId, getParentId, obtainCommand, postprocess, preprocess, setCommandDescriptor, setOrchConfigurator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.chenile.owiz.Command

execute

Field Details

INDEX

public static final String INDEX

See Also:

• Constant Field Values

commandDescSet

protected Set<OrderedCommandDesc> commandDescSet

currentIndex

protected int currentIndex

Constructor Details

Chain

public Chain()

Method Details

doExecute

protected void doExecute(InputType context)
                  throws Exception

Specified by:

doExecute in class CommandBase<InputType>

Throws:

Exception

shouldStopChain

protected boolean shouldStopChain(InputType context)
                           throws Exception

AN extension point to allow sub classes to stop a chain if a condition is satisfied.

Parameters:

context - containing the data required.

Returns:

false by default.

Throws:

Exception - .

attachCommand

public void attachCommand(AttachmentDescriptor<InputType> attachmentDescriptor,
 CommandDescriptor<InputType> command)

Allow a command to attach itself to this chain. If the index is not specified then the attachment order defines the execution order. Else if index is explicitly specified then the execution order would be the ascending order of the index.

Specified by:

attachCommand in interface AttachableCommand<InputType>

obtainExecutionCommands

protected List<Command<InputType>> obtainExecutionCommands(InputType context)

Obtain the list of commands that needs to be actually executed. Considers InterpolationCommand - these commands are supposed to emit out the actual commands that need to be executed.

Parameters:

context - - the context that was passed

Returns:

- the set of commands applicable for that context