jadex.bpmn.runtime

Class ThreadContext

java.lang.Object

jadex.bpmn.runtime.ThreadContext

public class ThreadContext
extends Object

The thread context represents the current execution context of a thread including sibling threads and parent contexts (for nested sub processes).

Constructor Summary

Constructors

Constructor and Description
ThreadContext(MBpmnModel model) Create a new top-level thread context.
ThreadContext(MSubProcess model, ProcessThread initiator) Create a new sub-level thread context.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExternalThread(ProcessThread thread) Add an external thread to this context.
void	addSubcontext(ThreadContext context) Add a sub context.
void	addThread(ProcessThread thread) Add a thread to this context.
Set	getAllThreads() Get all threads of the context and all subcontexts.
ProcessThread	getExecutableThread(String pool, String lane) Get an executable thread in the context or its sub contexts.
ProcessThread	getInitiator() Get the initiating thread.
MIdElement	getModelElement() Get the model element.
ThreadContext	getParent() Get the parent context.
ThreadContext	getSubcontext(ProcessThread thread) Get the subcontext of a thread.
Set<ProcessThread>	getThreads() Get all threads of this context.
boolean	isFinished(String pool, String lane) The context is finished, when there are no (more) threads to execute.
void	removeSubcontext(ThreadContext context) Remove a sub context but keep the corresponding thread.
void	removeThread(ProcessThread thread) Remove a thread from this context.
String	toString() Get the string representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ThreadContext

public ThreadContext(MBpmnModel model)

Create a new top-level thread context.

Parameters:

model - The process model element.

ThreadContext

public ThreadContext(MSubProcess model,
             ProcessThread initiator)

Create a new sub-level thread context. Should not be invoked from the outside

Parameters:

model - The sub process model element.

initiator - The initiating thread.

Method Detail

getModelElement

public MIdElement getModelElement()

Get the model element.

Returns:

The process or sub process element.

getParent

public ThreadContext getParent()

Get the parent context.

Returns:

The parent context, if any.

getInitiator

public ProcessThread getInitiator()

Get the initiating thread.

Returns:

The initiator, if any.

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.

removeThread

public void removeThread(ProcessThread thread)

Remove a thread from this context.

Parameters:

thread - The thread to be removed.

getThreads

public Set<ProcessThread> getThreads()

Get all threads of this context.

Returns:

All threads of this context, but not from sub context.

getAllThreads

public Set getAllThreads()

Get all threads of the context and all subcontexts.

addSubcontext

public void addSubcontext(ThreadContext context)

Add a sub context.

Parameters:

context - The sub context to be added.

removeSubcontext

public void removeSubcontext(ThreadContext context)

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.

getSubcontext

public ThreadContext getSubcontext(ProcessThread thread)

Get the subcontext of a thread.

Parameters:

thread - The thread which owns the subcontext.

Returns:

The subcontext (if any).

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

toString

public String toString()

Get the string representation.

Overrides:

toString in class Object

Returns:

The string representation.