com.whitestein.lsps.engine

Class BPMNInterpreter

java.lang.Object

com.whitestein.lsps.engine.BPMNInterpreter

All Implemented Interfaces:

ProcessInterpreter

public class BPMNInterpreter
extends Object

This class interprets BPMN processes. The process is provided as an existing ProcessInstance. The interpretation should always be started by calling init(boolean, Exception). Calling proceed(ProcessingType) moves each token in the provided context or in the token subprocesses by one step. The process can be explicitly terminated by calling terminate(TerminationReason).

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONDITIONAL_EVENT__CONDITION
protected RuntimeToPersistentConverter	converter Runtime-to-persistent converter.
protected E	desc Process description.
protected static String	ERROR_EVENT__ERROR_CODE
protected static String	ERROR_EVENT__ERROR_CODE_REF
protected ExecutionContext	executionContext Execution context.
protected VariableInitializator	initializator Variable initializator.
protected ModelInstance	modelInstance Model instance.
protected ModelProvider	modelProvider Model provider service.
protected ModuleInstance	moduleInstance Module instance.
protected ProcessInterpreterContext	pic Process interpreter context.
protected ProcessInstance	processInstance Process instance.

Constructor Summary

Constructors

Constructor and Description
BPMNInterpreter(ProcessInstance processInstance, ProcessInterpreterContext pic) Creates new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	handleEscalationEventFlow(com.whitestein.lsps.model.ExecutableModelElement element, com.whitestein.lsps.model.EscalationEventFlow flow, ExecutionContext executionContext, Escalation escalation, boolean consumeEscalation)
void	init(boolean isStartedByInlinedEvent, Exception startedByException) Initializes the context state, sets all context variables to their initial values and creates a new token at the start of the process.
void	proceed(ProcessingType processingType) Moves the process state by one step forward.
void	terminate(TerminationReason reason) Terminates the process with the given reason.

Methods inherited from class java.lang.Object

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

Field Detail

CONDITIONAL_EVENT__CONDITION

protected static final String CONDITIONAL_EVENT__CONDITION

ERROR_EVENT__ERROR_CODE

protected static final String ERROR_EVENT__ERROR_CODE

ERROR_EVENT__ERROR_CODE_REF

protected static final String ERROR_EVENT__ERROR_CODE_REF

processInstance

protected final ProcessInstance processInstance

Process instance.

moduleInstance

protected final ModuleInstance moduleInstance

Module instance.

modelInstance

protected final ModelInstance modelInstance

Model instance.

pic

protected final ProcessInterpreterContext pic

Process interpreter context.

modelProvider

protected final ModelProvider modelProvider

Model provider service.

desc

protected final E desc

Process description.

executionContext

protected final ExecutionContext executionContext

Execution context.

converter

protected final RuntimeToPersistentConverter converter

Runtime-to-persistent converter.

initializator

protected final VariableInitializator initializator

Variable initializator.

Constructor Detail

BPMNInterpreter

public BPMNInterpreter(ProcessInstance processInstance,
                       ProcessInterpreterContext pic)

Creates new instance.

Parameters:

processInstance -

pic -

Method Detail

init

public void init(boolean isStartedByInlinedEvent,
                 Exception startedByException)
          throws ErrorException

Initializes the context state, sets all context variables to their initial values and creates a new token at the start of the process.

Specified by:

init in interface ProcessInterpreter

Throws:

ErrorException

proceed

public void proceed(ProcessingType processingType)
             throws ErrorException

Description copied from interface: ProcessInterpreter

Moves the process state by one step forward.

Throws:

ErrorException - when a BPMN error occurs

terminate

public void terminate(TerminationReason reason)
               throws ErrorException

Description copied from interface: ProcessInterpreter

Terminates the process with the given reason.

Specified by:

terminate in interface ProcessInterpreter

Throws:

ErrorException

handleEscalationEventFlow

protected boolean handleEscalationEventFlow(com.whitestein.lsps.model.ExecutableModelElement element,
                                            com.whitestein.lsps.model.EscalationEventFlow flow,
                                            ExecutionContext executionContext,
                                            Escalation escalation,
                                            boolean consumeEscalation)
                                     throws ErrorException

Throws:

ErrorException