org.apache.taverna.invocation

Class IterationInternalEvent<EventType extends IterationInternalEvent<?>>

java.lang.Object

org.apache.taverna.invocation.Event<EventType>

org.apache.taverna.invocation.IterationInternalEvent<EventType>

Type Parameters:

EventType - reflexive self type

Direct Known Subclasses:

Completion, Job

public abstract class IterationInternalEvent<EventType extends IterationInternalEvent<?>>
extends Event<EventType>

Abstract superclass for event types which have to pass through the iteration system. For this they need the ability to push and pull the iteration index to and from the process identifier, this is done through the popIndex and pushIndex methods. Subclasses of this may be used outside the iteration system but anything which is passed into the iteration system must provide this functionality.

Author:

Tom Oinn

Field Summary

Fields inherited from class org.apache.taverna.invocation.Event

context, index, owner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IterationInternalEvent(String owner, int[] index, InvocationContext context) Protected constructor for the minimum fields required by all Event subclasses

Method Summary

Modifier and Type	Method and Description
protected int[]	getPoppedIndex() Helper method for the popIndex operation, returns the modified index array.
protected String	getPushedOwningProcess() Helper method for the pushIndex operation
abstract IterationInternalEvent<EventType>	popIndex() Pop a previously pushed index array off the process name and append the current index array to create the new index array.
abstract IterationInternalEvent<EventType>	pushIndex() Push the index array onto the owning process name and return the new Event subclass object.

Methods inherited from class org.apache.taverna.invocation.Event

getContext, getIndex, getOwningProcess, isFinal, popOwner, popOwningProcess, pushOwner, pushOwningProcess, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IterationInternalEvent

protected IterationInternalEvent(String owner,
                                 int[] index,
                                 InvocationContext context)

Protected constructor for the minimum fields required by all Event subclasses

Parameters:

owner -

index -

context -

Method Detail

popIndex

public abstract IterationInternalEvent<EventType> popIndex()

Pop a previously pushed index array off the process name and append the current index array to create the new index array. This is applied to a new instance of an Event subclass and does not modify the target.

Returns:

new Event subclass with modified owning process and index

pushIndex

public abstract IterationInternalEvent<EventType> pushIndex()

Push the index array onto the owning process name and return the new Event subclass object. Does not modify this object, the method creates a new Event subclass with the modified index array and owning process.

getPushedOwningProcess

protected final String getPushedOwningProcess()

Helper method for the pushIndex operation

Returns:

getPoppedIndex

protected final int[] getPoppedIndex()

Helper method for the popIndex operation, returns the modified index array. Subclasses must still implement logic to get the modified owning process but that's relatively easy : return new <Event subclass>(owner.substring(0, owner.lastIndexOf(':')),getPoppedIndex(), dataMap);

Returns: