com.whitestein.lsps.engine.state.xml

Class ModuleInstance

java.lang.Object

com.whitestein.lsps.engine.state.xml.ModuleInstance

All Implemented Interfaces:

UnmarshalCallback, Collectible, EntityWithId, ModelIdentifiable, ModelInstanceAware, ProcessInstanceParent, XmlEntity

public class ModuleInstance
extends Object
implements XmlEntity, Collectible, ModelInstanceAware, EntityWithId, ProcessInstanceParent

Entity representing a module instance.

Author:

rba

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModuleInstance() Creates new empty instance of ModuleInstance.
	ModuleInstance(long id, ModelInstance modelInstance, Context context) Creates new instance of ModuleInstance.
	ModuleInstance(ModelInstance modelInstance, Context context) Creates new instance of ModuleInstance.
	ModuleInstance(ModelInstance modelInstance, com.whitestein.lsps.model.ProcessModel processModel) Creates new instance of ModuleInstance for given ProcessModel.

Method Summary

Modifier and Type	Method and Description
ProcessInstance	addNewProcessInstance(Context context) Adds new child process instance.
ProcessInstance	addNewProcessInstance(com.whitestein.lsps.model.ContextModelElement element) modelInstance Adds new child process instance.
ProcessInstance	addProcessInstance(ProcessInstance processInstance) Adds a process instances as a child of this module instance.
void	collect() Removes itself from the process.
Context	getContext() Returns the context of this module.
com.whitestein.lsps.model.ElementWithId	getElement(ModelProviderClientService modelProviderService) Returns the model element.
String	getElementId() Returns the element id.
String	getElementId(ModelProviderClientService modelProviderService) Returns the model element id.
long	getId() Returns the id.
ModelInstance	getModelInstance() Returns the model instance.
ModuleInstance	getModuleInstance() Returns the enclosing module instance.
String	getName() Returns the module name.
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.
ModuleInstanceState	getState() Returns the module instance state.
boolean	isPersistent() Returns true if this object cannot be collected.
boolean	isSuspended() Returns true if this module instance is suspended.
ModuleInstance	makeCopy(ModelInstance targetModelInstance) Returns deep copy.
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.
boolean	removeProcessInstance(ProcessInstance processInstance) Removes a process instance.
void	setState(ModuleInstanceState state) Sets the module instance state.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleInstance

protected ModuleInstance()

Creates new empty instance of ModuleInstance.

ModuleInstance

public ModuleInstance(ModelInstance modelInstance,
                      Context context)

Creates new instance of ModuleInstance.

Parameters:

modelInstance -

context -

Throws:

NullPointerException - if modelInstance is null

ModuleInstance

public ModuleInstance(long id,
                      ModelInstance modelInstance,
                      Context context)

Creates new instance of ModuleInstance.

Parameters:

id -

modelInstance -

context -

Throws:

NullPointerException - if modelInstance is null

ModuleInstance

public ModuleInstance(ModelInstance modelInstance,
                      com.whitestein.lsps.model.ProcessModel processModel)

Creates new instance of ModuleInstance for given ProcessModel.

Parameters:

modelInstance -

processModel -

Throws:

NullPointerException - if modelInstance 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

getState

public ModuleInstanceState getState()

Returns the module instance state.

Returns:

the module instance state

setState

public void setState(ModuleInstanceState state)

Sets the module instance state.

Parameters:

state -

isSuspended

public boolean isSuspended()

Returns true if this module instance is suspended.

Returns:

true if this module instance is suspended

getName

public String getName()

Returns the module name.

Returns:

the module name

getContext

public Context getContext()

Returns the context of this module.

Specified by:

getContext in interface ProcessInstanceParent

Returns:

the context of this module

getElement

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

Description copied from interface: ModelIdentifiable

Returns the model element.

Specified by:

getElement in interface ModelIdentifiable

Returns:

the model element

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

getElementId

public String getElementId()

Returns the element id.

Returns:

the element id

addProcessInstance

public ProcessInstance addProcessInstance(ProcessInstance processInstance)

Adds a process instances as a child of this module 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 module instance contained the given child process instance

addNewProcessInstance

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

modelInstance Adds new child process instance.

Specified by:

addNewProcessInstance in interface ProcessInstanceParent

Parameters:

element -

Returns:

new 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

getProcessInstances

public Collection<ProcessInstance> getProcessInstances()

Returns immutable collection of child process instances.

Returns:

collection of child process instances

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

Description copied from interface: ProcessInstanceParent

Returns the enclosing module instance.

Specified by:

getModuleInstance in interface ProcessInstanceParent

Returns:

the enclosing module instance

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.

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

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

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

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

makeCopy

public ModuleInstance makeCopy(ModelInstance targetModelInstance)

Returns deep copy.

Parameters:

targetModelInstance -

Returns:

deep copy

toString

public String toString()

Overrides:

toString in class Object