ProcessThread (Jadex Active Component Platform 2.5-SNAPSHOT API.)

java.lang.Object
- jadex.bpmn.runtime.ProcessThread

All Implemented Interfaces:

jadex.bpmn.model.task.ITaskContext
```
public class ProcessThread
extends Object
implements jadex.bpmn.model.task.ITaskContext
```
Representation of a single control flow in a BPMN process instance, i.e. an instance of a sequence flow.

Field Summary

Fields
Modifier and Type Field and Description

int idcnt
The id counter for sub processes.

Map<String,SplitInfo> splitinfos
The split infos.

Fields
Modifier and Type	Field and Description
`int`	`idcnt` The id counter for sub processes.
`Map<String,SplitInfo>`	`splitinfos` The split infos.

Constructor Summary

Constructors
Constructor and Description
`ProcessThread(jadex.bpmn.model.MActivity activity, ProcessThread parent, BpmnInterpreter instance)` Create a new process instance.
`ProcessThread(String id, jadex.bpmn.model.MActivity activity, ProcessThread parent, BpmnInterpreter instance)` Create a new process instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExternalThread(ProcessThread thread)` Add an external thread to this context.
`void`	`addSplitInfo(SplitInfo spi)` Add a split info.
`void`	`addThread(ProcessThread thread)` Add a thread to this context.
`boolean`	`belongsTo(String pool, String lane)` Test if the thread belongs to the given pool and/or lane.
`void`	`copy(ProcessThread ret)` Create a copy of this thread (e.g.
`ProcessThread`	`createCopy()` Create a copy of this thread (e.g.
`jadex.bpmn.model.MActivity`	`getActivity()` Get the activity.
`Set<String>`	`getAllParameterNames()` Get the name of all parameters.
`Set<ProcessThread>`	`getAllThreads()` Get all threads of the context and all subcontexts.
`jadex.bpmn.model.MBpmnModel`	`getBpmnModel()` Get the model.
`Map<String,Object>`	`getData()` Get the data.
`Map<String,Object>`	`getDataEdges()` Get the data edges.
`Exception`	`getException()` Get the exception (if any).
`ProcessThread`	`getExecutableThread(String pool, String lane)` Get an executable thread in the context or its sub contexts.
`String`	`getId()` Get the id.
`BpmnInterpreter`	`getInstance()` Get the instance.
`jadex.bpmn.model.MSequenceEdge`	`getLastEdge()` Get the last edge (if any).
`IResultCommand<Boolean,Void>`	`getLoopCommand()` Get the loopcmd.
`jadex.bpmn.model.MActivity`	`getModelElement()` Get the model element.
`String[]`	`getParameterNames()` Get the name of all parameters.
`Map<String,Object>`	`getParameters()` Get the parameters.
`Object`	`getParameterValue(String name)` Get the value of a parameter.
`ProcessThread`	`getParent()` Get the parent.
`Object`	`getPropertyValue(String name)` Get the value of a property.
`Object`	`getPropertyValue(String name, jadex.bpmn.model.MActivity activity)` Hack: method is necessary because thread.activity is not always the activity to execute in case of multiple event.
`SplitInfo`	`getSplitInfo(String id)` Get a specific split info, if available.
`Collection<SplitInfo>`	`getSplitInfos()` Get the split infos.
`List<ProcessThread>`	`getSubthreads()` Get the subthreads.
`jadex.bpmn.model.task.ITask`	`getTask()` Gets the current task.
`IFilter<Object>`	`getWaitFilter()` Get the wait filter.
`ICancelable`	`getWaitInfo()` Get the waitinfo.
`boolean`	`hasOwnParameterValue(String name)` Test if a parameter has been set on activity.
`boolean`	`hasParameterValue(String name)` Test if a parameter has been set on activity.
`boolean`	`hasPropertyValue(String name)` Test, if a property is declared.
`boolean`	`hasSubthreads()` Test if thread has subthreads.
`boolean`	`isCanceled()` Is the current task canceled?
`boolean`	`isFinished(String pool, String lane)` The context is finished, when there are no (more) threads to execute.
`boolean`	`isWaiting()` Is the process in a waiting state (i.e.
`void`	`notifyFinished()` Method that can be used to determine (override) that the thread is finished.
`void`	`removeParameterValue(String name)` Remove the value of a parameter.
`void`	`removeSplitInfo(SplitInfo spi)` Remove the split info.
`void`	`removeSubcontext()` Remove a sub context but keep the corresponding thread.
`void`	`removeThread(ProcessThread thread)` Remove a thread from this context.
`void`	`setActivity(jadex.bpmn.model.MActivity activity)` Set the next activity.
`void`	`setCanceled(boolean canceled)` Set the canceled state.
`void`	`setDataEdgeValue(String name, Object value)` Set the value of a parameter.
`void`	`setException(Exception exception)` Set the exception.
`void`	`setLastEdge(jadex.bpmn.model.MSequenceEdge edge)` Set the last edge.
`void`	`setLoopCommand(IResultCommand<Boolean,Void> loopcmd)` Set the loopcmd.
`void`	`setNonWaiting()` Set to non waiting.
`void`	`setOrCreateParameterValue(String name, Object value)` Set or create a parameter value directly in this thread.
`void`	`setOrCreateParameterValue(String name, Object key, Object value)` Set or create a parameter value directly in this thread.
`void`	`setParameterValue(String name, Object value)` Set the value of a parameter.
`void`	`setParameterValue(String name, Object key, Object value)` Set the value of a parameter.
`void`	`setParent(ProcessThread parent)` Set the parent.
`void`	`setTask(jadex.bpmn.model.task.ITask task)` Sets the current task.
`void`	`setWaitFilter(IFilter<Object> waitfilter)` Set the wait filter.
`void`	`setWaitInfo(ICancelable cancelinfo)` Set the process waiting info.
`void`	`setWaiting(boolean waiting)` Set the waiting state.
`String`	`toString()` Create a string representation of this process thread.
`void`	`updateParametersAfterStep(jadex.bpmn.model.MActivity activity, BpmnInterpreter instance)` Remove in parameters after step.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - idcnt
```
public int idcnt
```
    The id counter for sub processes.
  - splitinfos
```
public Map<String,SplitInfo> splitinfos
```
    The split infos.
- Constructor Detail
  - ProcessThread
```
public ProcessThread(jadex.bpmn.model.MActivity activity,
                     ProcessThread parent,
                     BpmnInterpreter instance)
```
    Create a new process instance.
    
    Parameters:
    
    activity - The current activity.
  - ProcessThread
```
public ProcessThread(String id,
                     jadex.bpmn.model.MActivity activity,
                     ProcessThread parent,
                     BpmnInterpreter instance)
```
    Create a new process instance.
    
    Parameters:
    
    activity - The current activity.
- Method Detail
  - getBpmnModel
```
public jadex.bpmn.model.MBpmnModel getBpmnModel()
```
    Get the model.
    
    Specified by:
    
    getBpmnModel in interface jadex.bpmn.model.task.ITaskContext
    
    Returns:
    
    The bpmn model.
  - getId
```
public String getId()
```
    Get the id.
    
    Returns:
    
    The id.
  - getActivity
```
public jadex.bpmn.model.MActivity getActivity()
```
    Get the activity.
    
    Specified by:
    
    getActivity in interface jadex.bpmn.model.task.ITaskContext
    
    Returns:
    
    The activity.
  - setActivity
```
public void setActivity(jadex.bpmn.model.MActivity activity)
```
    Set the next activity. Sets the last edge to null. Should only be used, when no edge available (e.g. start events or event handlers of subprocesses).
  - isCanceled
```
public boolean isCanceled()
```
    Is the current task canceled?
    
    Returns:
    
    The canceled flag.
  - setCanceled
```
public void setCanceled(boolean canceled)
```
    Set the canceled state.
    
    Parameters:
    
    canceled - True, if canceled.
  - getTask
```
public jadex.bpmn.model.task.ITask getTask()
```
    Gets the current task.
    
    Returns:
    
    The current task.
  - setTask
```
public void setTask(jadex.bpmn.model.task.ITask task)
```
    Sets the current task.
    
    Parameters:
    
    task - The current task.
  - getLastEdge
```
public jadex.bpmn.model.MSequenceEdge getLastEdge()
```
    Get the last edge (if any).
    
    Returns:
    
    The edge.
  - setLastEdge
```
public void setLastEdge(jadex.bpmn.model.MSequenceEdge edge)
```
    Set the last edge. Also sets the next activity.
    
    Parameters:
    
    edge - The edge.
  - isWaiting
```
public boolean isWaiting()
```
    Is the process in a waiting state (i.e. blocked)?
    
    Returns:
    
    The waiting flag.
  - setWaiting
```
public void setWaiting(boolean waiting)
```
    Set the waiting state.
  - setNonWaiting
```
public void setNonWaiting()
```
    Set to non waiting.
  - setWaitInfo
```
public void setWaitInfo(ICancelable cancelinfo)
```
    Set the process waiting info.
    
    Parameters:
    
    waiting - The waiting info.
  - getWaitInfo
```
public ICancelable getWaitInfo()
```
    Get the waitinfo.
    
    Returns:
    
    The waitinfo.
  - getWaitFilter
```
public IFilter<Object> getWaitFilter()
```
    Get the wait filter.
    
    Returns:
    
    The waitfilter.
  - setWaitFilter
```
public void setWaitFilter(IFilter<Object> waitfilter)
```
    Set the wait filter.
    
    Parameters:
    
    waitfilter - The waitfilter to set.
  - createCopy
```
public ProcessThread createCopy()
```
    Create a copy of this thread (e.g. for a parallel split).
  - copy
```
public void copy(ProcessThread ret)
```
    Create a copy of this thread (e.g. for a parallel split).
  - hasOwnParameterValue
```
public boolean hasOwnParameterValue(String name)
```
    Test if a parameter has been set on activity.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    True if parameter is known.
  - hasParameterValue
```
public boolean hasParameterValue(String name)
```
    Test if a parameter has been set on activity.
    
    Specified by:
    
    hasParameterValue in interface jadex.bpmn.model.task.ITaskContext
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    True if parameter is known.
  - getModelElement
```
public jadex.bpmn.model.MActivity getModelElement()
```
    Get the model element.
    
    Specified by:
    
    getModelElement in interface jadex.bpmn.model.task.ITaskContext
    
    Returns:
    
    The model of the task.
  - getParameterValue
```
public Object getParameterValue(String name)
```
    Get the value of a parameter.
    
    Specified by:
    
    getParameterValue in interface jadex.bpmn.model.task.ITaskContext
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The parameter value.
  - getParameters
```
public Map<String,Object> getParameters()
```
    Get the parameters.
    
    Returns:
    
    The parameters.
  - setDataEdgeValue
```
public void setDataEdgeValue(String name,
                             Object value)
```
    Set the value of a parameter.
    
    Parameters:
    
    name - The parameter name.
    
    value - The parameter value.
  - setParameterValue
```
public void setParameterValue(String name,
                              Object value)
```
    Set the value of a parameter.
    
    Specified by:
    
    setParameterValue in interface jadex.bpmn.model.task.ITaskContext
    
    Parameters:
    
    name - The parameter name.
    
    value - The parameter value.
  - setParameterValue
```
public void setParameterValue(String name,
                              Object key,
                              Object value)
```
    Set the value of a parameter.
    
    Specified by:
    
    setParameterValue in interface jadex.bpmn.model.task.ITaskContext
    
    Parameters:
    
    name - The parameter name.
    
    value - The parameter value.
  - setOrCreateParameterValue
```
public void setOrCreateParameterValue(String name,
                                      Object value)
```
    Set or create a parameter value directly in this thread.
    
    Specified by:
    
    setOrCreateParameterValue in interface jadex.bpmn.model.task.ITaskContext
  - setOrCreateParameterValue
```
public void setOrCreateParameterValue(String name,
                                      Object key,
                                      Object value)
```
    Set or create a parameter value directly in this thread.
    
    Specified by:
    
    setOrCreateParameterValue in interface jadex.bpmn.model.task.ITaskContext
  - removeParameterValue
```
public void removeParameterValue(String name)
```
    Remove the value of a parameter.
    
    Parameters:
    
    name - The parameter name.
  - getParameterNames
```
public String[] getParameterNames()
```
    Get the name of all parameters.
    
    Returns:
    
    The parameter names.
  - getAllParameterNames
```
public Set<String> getAllParameterNames()
```
    Get the name of all parameters.
    
    Returns:
    
    The parameter names.
  - getPropertyValue
```
public Object getPropertyValue(String name)
```
    Get the value of a property.
    
    Specified by:
    
    getPropertyValue in interface jadex.bpmn.model.task.ITaskContext
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    The property value.
  - getPropertyValue
```
public Object getPropertyValue(String name,
                               jadex.bpmn.model.MActivity activity)
```
    Hack: method is necessary because thread.activity is not always the activity to execute in case of multiple event. Get the value of a property.
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    The property value.
  - hasPropertyValue
```
public boolean hasPropertyValue(String name)
```
    Test, if a property is declared.
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    True, if the property is declared.
  - getException
```
public Exception getException()
```
    Get the exception (if any).
    
    Returns:
    
    The exception (if any).
  - setException
```
public void setException(Exception exception)
```
    Set the exception.
    
    Parameters:
    
    exception - The exception.
  - getInstance
```
public BpmnInterpreter getInstance()
```
    Get the instance.
    
    Returns:
    
    The instance.
  - getDataEdges
```
public Map<String,Object> getDataEdges()
```
    Get the data edges.
    
    Returns:
    
    The data edges.
  - getData
```
public Map<String,Object> getData()
```
    Get the data.
    
    Returns:
    
    The data.
  - belongsTo
```
public boolean belongsTo(String pool,
                         String lane)
```
    Test if the thread belongs to the given pool and/or lane.
    
    Parameters:
    
    pool - The pool to be executed or null for any.
    
    lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.
    
    Returns:
    
    True, when the thread belongs to the given pool and/or lane. Also returns true when both pool and lane are null.
  - updateParametersAfterStep
```
public void updateParametersAfterStep(jadex.bpmn.model.MActivity activity,
                                      BpmnInterpreter instance)
```
    Remove in parameters after step.
    
    Parameters:
    
    instance - The calling BPMN instance.
  - getSplitInfos
```
public Collection<SplitInfo> getSplitInfos()
```
    Get the split infos.
  - getSplitInfo
```
public SplitInfo getSplitInfo(String id)
```
    Get a specific split info, if available.
  - addSplitInfo
```
public void addSplitInfo(SplitInfo spi)
```
    Add a split info.
  - removeSplitInfo
```
public void removeSplitInfo(SplitInfo spi)
```
    Remove the split info.
  - removeSubcontext
```
public void removeSubcontext()
```
    Remove a sub context but keep the corresponding thread. E.g. when a sub process terminates, the sub context is removed and the initiating thread continues in the outer context.
    
    Parameters:
    
    context - The sub context to be removed.
  - removeThread
```
public void removeThread(ProcessThread thread)
```
    Remove a thread from this context.
    
    Parameters:
    
    thread - The thread to be removed.
  - addThread
```
public void addThread(ProcessThread thread)
```
    Add a thread to this context.
    
    Parameters:
    
    thread - The thread to be added.
  - addExternalThread
```
public void addExternalThread(ProcessThread thread)
```
    Add an external thread to this context.
    
    Parameters:
    
    thread - The thread to be added.
  - getAllThreads
```
public Set<ProcessThread> getAllThreads()
```
    Get all threads of the context and all subcontexts.
  - getParent
```
public ProcessThread getParent()
```
    Get the parent. return The parent.
  - setParent
```
public void setParent(ProcessThread parent)
```
    Set the parent.
    
    Parameters:
    
    parent - The parent to set.
  - getSubthreads
```
public List<ProcessThread> getSubthreads()
```
    Get the subthreads.
  - hasSubthreads
```
public boolean hasSubthreads()
```
    Test if thread has subthreads.
  - isFinished
```
public boolean isFinished(String pool,
                          String lane)
```
    The context is finished, when there are no (more) threads to execute.
    
    Parameters:
    
    pool - The pool to be executed or null for any.
    
    lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.
    
    Returns:
    
    True, when the process instance is finished with regards to the specified pool/lane. When both pool and lane are null, true is returned only when all pools/lanes are finished.
  - getExecutableThread
```
public ProcessThread getExecutableThread(String pool,
                                         String lane)
```
    Get an executable thread in the context or its sub contexts.
    
    Parameters:
    
    pool - The pool to be executed or null for any.
    
    lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.
    
    Returns:
    
    An executable thread (if any).
  - getLoopCommand
```
public IResultCommand<Boolean,Void> getLoopCommand()
```
    Get the loopcmd.
    
    Returns:
    
    The loopcmd.
  - setLoopCommand
```
public void setLoopCommand(IResultCommand<Boolean,Void> loopcmd)
```
    Set the loopcmd.
    
    Parameters:
    
    loopcmd - The loopcmd to set.
  - notifyFinished
```
public void notifyFinished()
```
    Method that can be used to determine (override) that the thread is finished.
  - toString
```
public String toString()
```
    Create a string representation of this process thread.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this process thread.

Class ProcessThread

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

idcnt

splitinfos

Constructor Detail

ProcessThread

ProcessThread

Method Detail

getBpmnModel

getId

getActivity

setActivity

isCanceled

setCanceled

getTask

setTask

getLastEdge

setLastEdge

isWaiting

setWaiting

setNonWaiting

setWaitInfo

getWaitInfo

getWaitFilter

setWaitFilter

createCopy

copy

hasOwnParameterValue

hasParameterValue

getModelElement

getParameterValue

getParameters

setDataEdgeValue

setParameterValue

setParameterValue

setOrCreateParameterValue

setOrCreateParameterValue

removeParameterValue

getParameterNames

getAllParameterNames

getPropertyValue

getPropertyValue

hasPropertyValue

getException

setException

getInstance

getDataEdges

getData

belongsTo

updateParametersAfterStep

getSplitInfos

getSplitInfo

addSplitInfo

removeSplitInfo

removeSubcontext

removeThread

addThread

addExternalThread

getAllThreads

getParent

setParent

getSubthreads

hasSubthreads

isFinished

getExecutableThread

getLoopCommand

setLoopCommand

notifyFinished

toString