com.whitestein.lsps.engine.state.xml

Class Token

java.lang.Object

com.whitestein.lsps.engine.state.xml.Token

All Implemented Interfaces:

UnmarshalCallback, Collectible, ElementInProcess, EntityWithId, ModelIdentifiable, ModelInstanceAware, XmlEntity

public class Token
extends Object
implements XmlEntity, Collectible, ModelInstanceAware, EntityWithId, ModelIdentifiable, ElementInProcess

This entity represents a token in a BPMN process.

Author:

rba

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Token() Creates empty instance.
	Token(long id, ProcessInstance processInstance, String modelId) Creates new instance.
	Token(ProcessInstance processInstance, String modelId) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	addProcessInstance(ProcessInstance processInstance) Adds a process instance.
void	addTimeout(String flowId, Long timeout) Sets the timeout.
void	cleanTimeouts()
void	collect() Removes itself from the process.
void	finish() Finishes this token execution.
com.whitestein.lsps.model.FlowElement	getElement(ModelProviderClientService modelProviderService) Returns the model element.
String	getElementId() Returns the model element id.
String	getElementId(ModelProviderClientService modelProviderService) Returns the model element id.
Long	getExecutionId() Returns the execution id.
com.whitestein.lsps.model.Flow	getFlow(ModelProviderClientService modelProviderService) Returns the flow.
String	getFlowId() Returns the flow model id.
HandledBoundaryEvent	getHandledBoundaryEvent(String elementId) Returns handled boundary event with id.
List<HandledBoundaryEvent>	getHandledBoundaryEvents() Returns list of already handled boundary events.
long	getId() Returns the id.
ModelInstance	getModelInstance() Returns the model instance.
ProcessInstance	getProcessInstance() Returns the process instance.
int	getProcessInstanceCount() Returns the process instance count.
List<ProcessInstance>	getProcessInstances() Returns all the process instances.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
Task	getTask() Returns the task.
Date	getTimeout(String flowId) Returns the timeout.add
List<TimeoutFlow>	getTimeouts()
void	interrupt(TerminationReason terminationReason) Interrupts this token execution.
boolean	isPersistent() Returns true if this object cannot be collected.
boolean	isStarted() Returns true if interpretation of the corresponding model element is started by the engine.
Token	makeCopy(ModelInstance targetModelInstance, ProcessInstance targetProcessInstance) Returns deep copy.
void	move(String elementId) Move the token to the new element.
void	move(String elementId, String flowId) Move the token to the new element by the flow.
void	postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked after unmarshalling XML data into target.
void	preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked before unmarshalling into target.
void	rebind(ModelInstance modelInstance) Re-bind to the provided model instance.
void	removeAllProcessInstances() Removes all process instances.
void	removeProcessInstance(ProcessInstance processInstance) addXmlEntity Removes a process instance.
void	setExecutionId(Long executionId) Sets the execution id.
void	setTask(Task task) Sets the task.
void	start() Starts this token execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

Token

protected Token()

Creates empty instance.

Token

public Token(ProcessInstance processInstance,
             String modelId)

Creates new instance.

Parameters:

processInstance -

modelId -

Throws:

NullPointerException - if processInstance is null

Token

public Token(long id,
             ProcessInstance processInstance,
             String modelId)

Creates new instance.

Parameters:

id -

processInstance -

modelId -

Throws:

NullPointerException - if processInstance is null

Method Detail

getId

public long getId()

Description copied from interface: EntityWithId

Returns the id.

Specified by:

getId in interface EntityWithId

Returns:

the id

getElementId

public String getElementId()

Returns the model element id.

Returns:

the model element id

getElementId

public String getElementId(ModelProviderClientService modelProviderService)

Description copied from interface: ModelIdentifiable

Returns the model element id.

Specified by:

getElementId in interface ModelIdentifiable

Returns:

the model element id

getElement

public com.whitestein.lsps.model.FlowElement getElement(ModelProviderClientService modelProviderService)

Description copied from interface: ModelIdentifiable

Returns the model element.

Specified by:

getElement in interface ModelIdentifiable

Returns:

the model element

getFlowId

public String getFlowId()

Returns the flow model id.

Returns:

the flow model id

getFlow

public com.whitestein.lsps.model.Flow getFlow(ModelProviderClientService modelProviderService)

Returns the flow.

Parameters:

modelProviderService - the model provider service

Returns:

the flow

getModelInstance

public ModelInstance getModelInstance()

Description copied from interface: ModelInstanceAware

Returns the model instance.

Specified by:

getModelInstance in interface ModelInstanceAware

Returns:

the model instance

rebind

public void rebind(ModelInstance modelInstance)

Description copied from interface: ModelInstanceAware

Re-bind to the provided model instance.

Specified by:

rebind in interface ModelInstanceAware

getProcessInstance

public ProcessInstance getProcessInstance()

Returns the process instance.

Specified by:

getProcessInstance in interface ElementInProcess

Returns:

the process instance

getExecutionId

public Long getExecutionId()

Returns the execution id.

Returns:

the execution id

setExecutionId

public void setExecutionId(Long executionId)

Sets the execution id.

Parameters:

executionId -

getTask

public Task getTask()

Returns the task.

Returns:

the task

setTask

public void setTask(Task task)

Sets the task.

Parameters:

task -

getTimeouts

public List<TimeoutFlow> getTimeouts()

cleanTimeouts

public void cleanTimeouts()

getTimeout

public Date getTimeout(String flowId)

Returns the timeout.add

Parameters:

flowId -

Returns:

the timeout

addTimeout

public void addTimeout(String flowId,
                       Long timeout)

Sets the timeout.

Parameters:

flowId -

timeout -

getProcessInstances

public List<ProcessInstance> getProcessInstances()

Returns all the process instances.

Returns:

all the process instances

getProcessInstanceCount

public int getProcessInstanceCount()

Returns the process instance count.

Returns:

the process instance count

addProcessInstance

public void addProcessInstance(ProcessInstance processInstance)

Adds a process instance.

Parameters:

processInstance -

removeProcessInstance

public void removeProcessInstance(ProcessInstance processInstance)

addXmlEntity Removes a process instance.

Parameters:

processInstance -

removeAllProcessInstances

public void removeAllProcessInstances()

Removes all process instances.

isStarted

public boolean isStarted()

Returns true if interpretation of the corresponding model element is started by the engine. Token remains in the process instance during entire execution of the model element. Some model elements can be executed in more steps.

Returns:

true if the token is consumed by the engine.

start

public void start()

Starts this token execution.

finish

public void finish()

Finishes this token execution.

interrupt

public void interrupt(TerminationReason terminationReason)

Interrupts this token execution.

Parameters:

terminationReason -

isPersistent

public boolean isPersistent()

Description copied from interface: Collectible

Returns true if this object cannot be collected.

Specified by:

isPersistent in interface Collectible

Returns:

collected

getReferences

public Collection<Collectible> getReferences()

Description copied from interface: Collectible

Returns collection of all referenced collectible objects.

Specified by:

getReferences in interface Collectible

Returns:

collection of all referenced collectible objects

preUnmarshal

public void preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                         Object parent)

Description copied from interface: UnmarshalCallback

Callback method invoked before unmarshalling into target.

This method is invoked immediately after target was created and before the unmarshalling of this object begins.

Specified by:

preUnmarshal in interface UnmarshalCallback

parent - instance of JAXB mapped class that will eventually reference target. null when target is root element.

postUnmarshal

public void postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                          Object parent)

Description copied from interface: UnmarshalCallback

Callback method invoked after unmarshalling XML data into target.

This method is invoked after all the properties (except IDREF) are unmarshalled into target, but before target is set into its parent object.

Specified by:

postUnmarshal in interface UnmarshalCallback

parent - instance of JAXB mapped class that will reference target. null when target is root element.

collect

public void collect()

Description copied from interface: Collectible

Removes itself from the process. This method is called only when the element is not persistence and is not referenced directly or indirectly from any other persistence element.

Specified by:

collect in interface Collectible

move

public void move(String elementId,
                 String flowId)

Move the token to the new element by the flow.

The movement of the token cause the following events to be fired in this order:

• TokenBeforeMovedChange
• TokenMovementChange
• TokenAfterMovedChange

The first two events are fired before the state of the token is changed. The last event is fired after the token was moved to the next element.

Parameters:

elementId - the target element ID

flowId - the flow ID

move

public void move(String elementId)

Move the token to the new element.

Parameters:

elementId -

getHandledBoundaryEvents

public List<HandledBoundaryEvent> getHandledBoundaryEvents()

Returns list of already handled boundary events.

Returns:

list of already handled boundary events

getHandledBoundaryEvent

public HandledBoundaryEvent getHandledBoundaryEvent(String elementId)

Returns handled boundary event with id.

Parameters:

elementId -

Returns:

handled boundary event with id

makeCopy

public Token makeCopy(ModelInstance targetModelInstance,
                      ProcessInstance targetProcessInstance)

Returns deep copy.

Parameters:

targetModelInstance -

targetProcessInstance -

Returns:

deep copy