com.whitestein.lsps.engine.state.xml

Class ProcessInstance

java.lang.Object

com.whitestein.lsps.engine.state.xml.ProcessInstance

All Implemented Interfaces:

Collectible, EntityWithId, ModelIdentifiable, ModelInstanceAware, ProcessInstanceParent

public class ProcessInstance
extends Object
implements Collectible, ModelInstanceAware, EntityWithId, ProcessInstanceParent, ModelIdentifiable

Entity representing a process instance.

Author:

rba

Constructor Summary

Constructors

Constructor and Description
ProcessInstance(ProcessInstanceParent parent, Context context) Creates new instance of ProcessInstance.
ProcessInstance(SProcessInstance source, ProcessInstance parent, ModuleInstance moduleInstance, ModelInstance modelInstance) Creates a new instance from the serialized companion.

Method Summary

Modifier and Type	Method and Description
void	addCommand(ActivationCommand cmd) Adds an activation command.
ProcessInstance	addNewProcessInstance(Context context) Adds new child process instance.
ProcessInstance	addNewProcessInstance(com.whitestein.lsps.model.ContextModelElement element) Adds new child process instance.
Token	addNewToken() Adds a new token.
Token	addNewToken(String modelId) Adds a new token.
ProcessInstance	addProcessInstance(ProcessInstance processInstance) Adds a process instances as a child of this process instance.
Token	addToken(Token token) Adds a token.
void	collect() Removes itself from the process.
boolean	containsToken(Token token) Returns true if this context contains given token.
protected void	convertToDirectReferences()
ProcessInstance	createCopy(ModelInstance targetModelInstance) Creates a copy without references to other objects.
ProcessInstance	findDescendant(long descendantId) Finds a descendant process instance of this process instance.
void	finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source, CopyHelper helper) Copy references.
Context	getContext() Returns the process instance context.
com.whitestein.lsps.model.ContextModelElement	getElement(ModelProvider modelProvider) Returns the model element.
String	getElementId() Returns the model id.
String	getElementId(ModelProvider modelProvider) Returns the model element id.
Collection<Goal>	getGoals() Returns the collection of top goals.
GOElement	getGOElement(String name) Returns the go element by its name.
Collection<GOElement>	getGOElements() Returns all go elements.
long	getId() Returns the id.
String	getIteratorValue()
ModelInstance	getModelInstance() Returns the model instance.
ModuleInstance	getModuleInstance() Returns the module.
String	getName() Returns the context name.
ProcessInstance	getParent() Returns the parent process instance or null if this is a top process instance.
com.whitestein.lsps.model.FlowElement	getParentModelElement(ModelProvider modelProvider) Returns parent model element if exists.
String	getParentModelElementId() Gets the identifier of a model element the execution of which produced this process instance.
String	getPath() Returns the full path to this element as a string.
QID	getPathQID() Returns the full path to this element as a QID.
Collection<ProcessInstance>	getProcessInstances() Returns immutable collection of child process instances.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
ProcessInstanceState	getState() Returns the state.
Collection<Token>	getTokens() Returns the tokens.
ProcessInstance	getTopOfInlinedProcess() Returns first parent that is not in-lined.
void	interrupt(TerminationReason terminationReason) Interrupts this process instance - i.e.
boolean	isCommandsEmpty() Returns true if the command queue is empty.
boolean	isFinished() Returns true if the state is ProcessInstanceState.FINISHED.
boolean	isInlined() Returns true if the process is in-lined or some of its parent is in-lined.
boolean	isNew() Returns true if the state is ProcessInstanceState.CREATED.
boolean	isPersistent() Returns true if this object cannot be collected.
boolean	isRunning() Returns true if the state is ProcessInstanceState.RUNNING.
boolean	isSuspended() Returns true if the state is ProcessInstanceState.SUSPENDED.
boolean	isTerminatedByNoExit() Returns true if process was terminated by no exit event.
void	rebind(ModelInstance modelInstance) Re-bind to the provided model instance.
void	removeAllTokens() Removes all tokens.
ActivationCommand	removeFirstCommand() Removes and returns the first command.
boolean	removeProcessInstance(ProcessInstance processInstance) Removes a process instance.
void	removeToken(Token token, boolean isInterrupted) Removes a token.
void	setIsInlined(boolean isInlined) Sets property isIlined.
void	setIteratorValue(String iteratorValue)
void	setParentModelElementId(String parentModelElementId) Sets the identifier of a model element the execution of which produced this process instance.
void	setState(ProcessInstanceState state) Sets the state.
void	setTerminatedByNoExit(boolean value) Sets value whether process was terminated by no exit event
void	startGoal(Goal goal) Starts the goal execution.
SProcessInstance	toSerializable(SProcessInstance parent, SModuleInstance module, SModelInstance smi, MarshallerConfig config) Creates a serializable object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstance

public ProcessInstance(ProcessInstanceParent parent,
                       Context context)

Creates new instance of ProcessInstance.

Parameters:

parent -

context -

Throws:

NullPointerException - if moduleInstance or context is null

ProcessInstance

public ProcessInstance(SProcessInstance source,
                       ProcessInstance parent,
                       ModuleInstance moduleInstance,
                       ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

source -

parent -

moduleInstance -

modelInstance -

Method Detail

toSerializable

public SProcessInstance toSerializable(SProcessInstance parent,
                                       SModuleInstance module,
                                       SModelInstance smi,
                                       MarshallerConfig config)

Creates a serializable object.

Parameters:

parent -

module -

smi -

config -

Returns:

the created serializable object

getState

public ProcessInstanceState getState()

Returns the state.

Returns:

the state

setState

public void setState(ProcessInstanceState state)

Sets the state.

Parameters:

state -

Throws:

NullPointerException - if state is null

interrupt

public void interrupt(TerminationReason terminationReason)

Interrupts this process instance - i.e. sets the state to FINISHED and fires a change event with the given termination reason.

Parameters:

terminationReason -

isFinished

public boolean isFinished()

Returns true if the state is ProcessInstanceState.FINISHED.

Returns:

true if the state is ProcessInstanceState.FINISHED

isRunning

public boolean isRunning()

Returns true if the state is ProcessInstanceState.RUNNING.

Returns:

true if the state is ProcessInstanceState.RUNNING

isSuspended

public boolean isSuspended()

Returns true if the state is ProcessInstanceState.SUSPENDED.

Returns:

true if the state is ProcessInstanceState.SUSPENDED

isNew

public boolean isNew()

Returns true if the state is ProcessInstanceState.CREATED.

Returns:

true if the state is ProcessInstanceState.CREATED

getId

public long getId()

Description copied from interface: EntityWithId

Returns the id.

Specified by:

getId in interface EntityWithId

Returns:

the id

getName

public String getName()

Returns the context name.

Returns:

the context name

getElementId

public String getElementId()

Returns the model id.

Returns:

the model id

getElementId

public String getElementId(ModelProvider modelProvider)

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.ContextModelElement getElement(ModelProvider modelProvider)

Description copied from interface: ModelIdentifiable

Returns the model element.

Specified by:

getElement in interface ModelIdentifiable

Returns:

the model element

getContext

public Context getContext()

Returns the process instance context.

Specified by:

getContext in interface ProcessInstanceParent

Returns:

the process instance context

getParent

public ProcessInstance getParent()

Returns the parent process instance or null if this is a top process instance.

Returns:

the parent process instance

getProcessInstances

public Collection<ProcessInstance> getProcessInstances()

Returns immutable collection of child process instances.

Returns:

collection of child process instances

addProcessInstance

public ProcessInstance addProcessInstance(ProcessInstance processInstance)

Adds a process instances as a child of this process instance.

Specified by:

addProcessInstance in interface ProcessInstanceParent

Parameters:

processInstance -

Returns:

added context

removeProcessInstance

public boolean removeProcessInstance(ProcessInstance processInstance)

Removes a process instance.

Specified by:

removeProcessInstance in interface ProcessInstanceParent

Parameters:

processInstance -

Returns:

true if the process instance contained the given child process instance

addNewProcessInstance

public ProcessInstance addNewProcessInstance(com.whitestein.lsps.model.ContextModelElement element)

Adds new child process instance.

Specified by:

addNewProcessInstance in interface ProcessInstanceParent

Parameters:

element -

Returns:

added process instance

Throws:

NullPointerException - if element is null

addNewProcessInstance

public ProcessInstance addNewProcessInstance(Context context)

Adds new child process instance.

Specified by:

addNewProcessInstance in interface ProcessInstanceParent

Parameters:

context -

Returns:

new process instance

Throws:

NullPointerException - if context is null

getTokens

public Collection<Token> getTokens()

Returns the tokens.

Returns:

the tokens

addToken

public Token addToken(Token token)

Adds a token.

Parameters:

token -

Returns:

added token

Throws:

NullPointerException - if token is null

addNewToken

public Token addNewToken()

Adds a new token.

Returns:

added token

addNewToken

public Token addNewToken(String modelId)

Adds a new token.

Parameters:

modelId -

Returns:

added token

removeToken

public void removeToken(Token token,
                        boolean isInterrupted)

Removes a token.

Parameters:

token -

isInterrupted -

removeAllTokens

public void removeAllTokens()

Removes all tokens.

containsToken

public boolean containsToken(Token token)

Returns true if this context contains given token.

Parameters:

token -

Returns:

true if this context contains given token

startGoal

public void startGoal(Goal goal)

Starts the goal execution.

Parameters:

goal -

getGoals

public Collection<Goal> getGoals()

Returns the collection of top goals.

Returns:

the collection of top goals

addCommand

public void addCommand(ActivationCommand cmd)

Adds an activation command.

Parameters:

cmd -

isCommandsEmpty

public boolean isCommandsEmpty()

Returns true if the command queue is empty.

Returns:

true if the command queue is empty

removeFirstCommand

public ActivationCommand removeFirstCommand()

Removes and returns the first command.

Returns:

the first command

getGOElement

public GOElement getGOElement(String name)

Returns the go element by its name.

Parameters:

name -

Returns:

the go element by its name

getGOElements

public Collection<GOElement> getGOElements()

Returns all go elements.

Returns:

all go elements

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

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

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

getModuleInstance

public ModuleInstance getModuleInstance()

Returns the module.

Specified by:

getModuleInstance in interface ProcessInstanceParent

Returns:

the module

getPathQID

public QID getPathQID()

Description copied from interface: ProcessInstanceParent

Returns the full path to this element as a QID.

Specified by:

getPathQID in interface ProcessInstanceParent

Returns:

the full path to this element as a QID

getPath

public String getPath()

Description copied from interface: ProcessInstanceParent

Returns the full path to this element as a string.

Specified by:

getPath in interface ProcessInstanceParent

Returns:

the full path to this element as a string

toString

public String toString()

Overrides:

toString in class Object

getParentModelElementId

public String getParentModelElementId()

Gets the identifier of a model element the execution of which produced this process instance.

Model element which produce a new process instance when executed are:

• simple subprocess
• reusable subprocess
• loop subprocess
• multi-instance subprocess
• plan

Returns:

the identifier of a model element which produced this process instance.

getParentModelElement

public com.whitestein.lsps.model.FlowElement getParentModelElement(ModelProvider modelProvider)

Returns parent model element if exists.

Parameters:

modelProvider -

Returns:

parent model element if exists

setParentModelElementId

public void setParentModelElementId(String parentModelElementId)

Sets the identifier of a model element the execution of which produced this process instance.

Parameters:

parentModelElementId - the model element identifier

See Also:

getParentModelElementId()

getIteratorValue

public String getIteratorValue()

Returns:

the iteratorValue

setIteratorValue

public void setIteratorValue(String iteratorValue)

Parameters:

iteratorValue - the iteratorValue to set

findDescendant

public ProcessInstance findDescendant(long descendantId)

Finds a descendant process instance of this process instance. If this process instance has no descendant process instance with the given identifier then null is returned.

Parameters:

descendantId - the identifier of the descendant process instance

Returns:

the descendant process instance or null if there is no descendant process instance with the given identifier.

createCopy

public ProcessInstance createCopy(ModelInstance targetModelInstance)

Creates a copy without references to other objects.

Returns:

creates a copy

finishCopy

public void finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source,
                       CopyHelper helper)

Copy references.

getTopOfInlinedProcess

public ProcessInstance getTopOfInlinedProcess()

Returns first parent that is not in-lined.

Returns:

first parent that is not in-lined

isInlined

public boolean isInlined()

Returns true if the process is in-lined or some of its parent is in-lined.

Returns:

true if the process is in-lined or some of its parent is in-lined

setIsInlined

public void setIsInlined(boolean isInlined)

Sets property isIlined.

Parameters:

isInlined -

setTerminatedByNoExit

public void setTerminatedByNoExit(boolean value)

Sets value whether process was terminated by no exit event

Parameters:

value -

isTerminatedByNoExit

public boolean isTerminatedByNoExit()

Returns true if process was terminated by no exit event.

Returns:

true if process was terminated by no exit event

convertToDirectReferences

protected void convertToDirectReferences()