org.apache.taverna.invocation

Class WorkflowDataToken

java.lang.Object

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

org.apache.taverna.invocation.WorkflowDataToken

public class WorkflowDataToken
extends Event<WorkflowDataToken>

A single data token passed between processors in a workflow. This is distinct from the Job in that it contains a single (unnamed) data reference whereas the Job holds a map of arbitrarily many named data references in a bundle.

Author:

Tom Oinn

Field Summary

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

context, index, owner

Constructor Summary

Constructors

Constructor and Description
WorkflowDataToken(String owningProcess, int[] index, T2Reference dataRef, InvocationContext context) Construct a new data token with the specified owning process, conceptual index array and data reference

Method Summary

Modifier and Type	Method and Description
T2Reference	getData() Return the ID of the data this event represents
WorkflowDataToken	popOwningProcess() Return a copy of the event subclass with the last owning process removed from the owning process list.
WorkflowDataToken	pushOwningProcess(String localProcessName) Return a copy of the event subclass with the specified local process name appended to the owning process identifier field.
String	toString() Show the owner, index array and data map in textual form for debugging and any other purpose.

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

getContext, getIndex, getOwningProcess, isFinal, popOwner, pushOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowDataToken

public WorkflowDataToken(String owningProcess,
                         int[] index,
                         T2Reference dataRef,
                         InvocationContext context)

Construct a new data token with the specified owning process, conceptual index array and data reference

Parameters:

owningProcess -

index -

dataRef -

Method Detail

popOwningProcess

public WorkflowDataToken popOwningProcess()
                                   throws ProcessIdentifierException

Description copied from class: Event

Return a copy of the event subclass with the last owning process removed from the owning process list. For example, if the event had owner 'foo:bar' this would return a duplicate event with owner 'foo'. If the owning process is the empty string this is invalid and will throw a ProcessIdentifierException

Specified by:

popOwningProcess in class Event<WorkflowDataToken>

Returns:

a copy of the event with the parent process identifier

Throws:

ProcessIdentifierException

pushOwningProcess

public WorkflowDataToken pushOwningProcess(String localProcessName)
                                    throws ProcessIdentifierException

Description copied from class: Event

Return a copy of the event subclass with the specified local process name appended to the owning process identifier field. If the original owner was 'foo' and this was called with 'bar' you'd end up with a copy of the subclass with owner 'foo:bar'

Specified by:

pushOwningProcess in class Event<WorkflowDataToken>

Parameters:

localProcessName - name to add

Returns:

the modified event

Throws:

ProcessIdentifierException - if the local process name contains the ':' character

getData

public T2Reference getData()

Return the ID of the data this event represents

Returns:

toString

public String toString()

Show the owner, index array and data map in textual form for debugging and any other purpose. Jobs appear in the form :

 Job(Process1)[2,0]{Input2=dataID4,Input1=dataID3}
 

Overrides:

toString in class Event<WorkflowDataToken>