jadex.bpmn.runtime

Class ProcessThread

java.lang.Object

jadex.bpmn.runtime.ProcessThread

All Implemented Interfaces:

ITaskContext

public class ProcessThread
extends Object
implements 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.

Constructor Summary

Constructors

Constructor and Description
ProcessThread(String id, MActivity activity, ThreadContext context, BpmnInterpreter instance) Create a new process instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSplitInfo(SplitInfo spi) Add a split info.
boolean	belongsTo(String pool, String lane) Test if the thread belongs to the given pool and/or lane.
ProcessThread	createCopy() Create a copy of this thread (e.g. for a parallel split).
MActivity	getActivity() Get the activity.
String	getActivityId() Get the activity id.
Map<String,Object>	getData() Get the data.
Exception	getException() Get the exception (if any).
String	getId() Get the id.
BpmnInterpreter	getInstance() Get the instance.
MSequenceEdge	getLastEdge() Get the last edge (if any).
MActivity	getModelElement() Get the model element.
String[]	getParameterNames() Get the name of all parameters.
Object	getParameterValue(String name) Get the value of a parameter.
Object	getPropertyValue(String name) Get the value of a property.
Object	getPropertyValue(String name, 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.
ITask	getTask() Gets the current task.
ThreadContext	getThreadContext() Get the thread context
IFilter	getWaitFilter() Get the wait filter.
Object	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	isCanceled() Is the current task canceled?
boolean	isWaiting() Is the process in a waiting state (i.e. blocked)?
void	removeParameterValue(String name) Remove the value of a parameter.
void	removeSplitInfo(SplitInfo spi) Remove the split info.
void	setActivity(MActivity activity) Set the next activity.
void	setCanceled(boolean canceled) Set the canceled state.
void	setException(Exception exception) Set the exception.
void	setLastEdge(MSequenceEdge edge) Set the last edge.
void	setNonWaiting() Set to non waiting.
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	setTask(ITask task) Sets the current task.
void	setThreadContext(ThreadContext context) Set the context.
void	setWaitFilter(IFilter waitfilter) Set the wait filter.
void	setWaitInfo(Object waitinfo) 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(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(String id,
             MActivity activity,
             ThreadContext context,
             BpmnInterpreter instance)

Create a new process instance.

Parameters:

activity - The current activity.

Method Detail

getId

public String getId()

Get the id.

Returns:

The id.

getActivity

public MActivity getActivity()

Get the activity.

Specified by:

getActivity in interface ITaskContext

Returns:

The activity.

getActivityId

public String getActivityId()

Description copied from interface: ITaskContext

Get the activity id.

Specified by:

getActivityId in interface ITaskContext

Returns:

The activity id.

setActivity

public void setActivity(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 ITask getTask()

Gets the current task.

Returns:

The current task.

setTask

public void setTask(ITask task)

Sets the current task.

Parameters:

task - The current task.

getLastEdge

public MSequenceEdge getLastEdge()

Get the last edge (if any).

Returns:

The edge.

setLastEdge

public void setLastEdge(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(Object waitinfo)

Set the process waiting info.

Parameters:

waiting - The waiting info.

getWaitInfo

public Object getWaitInfo()

Get the waitinfo.

Returns:

The waitinfo.

getWaitFilter

public IFilter getWaitFilter()

Get the wait filter.

Returns:

The waitfilter.

setWaitFilter

public void setWaitFilter(IFilter waitfilter)

Set the wait filter.

Parameters:

waitfilter - The waitfilter to set.

getThreadContext

public ThreadContext getThreadContext()

Get the thread context

Returns:

The thread context.

setThreadContext

public void setThreadContext(ThreadContext context)

Set the context.

Parameters:

context - The context to set.

createCopy

public ProcessThread createCopy()

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 ITaskContext

Parameters:

name - The parameter name.

Returns:

True if parameter is known.

getModelElement

public MActivity getModelElement()

Get the model element.

Specified by:

getModelElement in interface ITaskContext

Returns:

The model of the task.

getParameterValue

public Object getParameterValue(String name)

Get the value of a parameter.

Specified by:

getParameterValue in interface ITaskContext

Parameters:

name - The parameter name.

Returns:

The parameter value.

setParameterValue

public void setParameterValue(String name,
                     Object value)

Set the value of a parameter.

Specified by:

setParameterValue in interface 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 ITaskContext

Parameters:

name - The parameter name.

value - The parameter value.

key - An optional helper (index, key etc.)

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.

getPropertyValue

public Object getPropertyValue(String name)

Get the value of a property.

Specified by:

getPropertyValue in interface ITaskContext

Parameters:

name - The property name.

Returns:

The property value.

getPropertyValue

public Object getPropertyValue(String name,
                      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.

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(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.

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.