com.whitestein.lsps.engine.state

Class ModelInstanceEntity

java.lang.Object

com.whitestein.lsps.common.AbstractEntity

com.whitestein.lsps.engine.state.ModelInstanceEntity

All Implemented Interfaces:

EntityWithId<Long>

@Entity
public class ModelInstanceEntity
extends com.whitestein.lsps.common.AbstractEntity

Entity representing a model instance.

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT_UNFINISHED_MODEL_INSTANCES Query name.
static String	FIND_FORM_PREVIEW_MODEL_INSTANCES Query name.

Fields inherited from class com.whitestein.lsps.common.AbstractEntity

SEQUENCE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelInstanceEntity() Creates new empty instance of ModelInstanceEntity.
	ModelInstanceEntity(Module model, ModelInstanceEntity parent, Map<String,String> properties, ModelInstanceType type, ModelInstanceResourceAllocator idAllocator) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	addNotification(String notification) Adds a notification.
void	addProperty(String name, String value) Adds a property.
AllocatedModelInstanceResources	allocateDetachmentAndValueIds(long allocatedSize) Allocates next range of value ids and detachment id.
AllocatedModelInstanceResources	allocateValueIds(long allocatedSize) Allocates next range of value ids.
void	clearNotifications() Clears all notifications.
void	clearTempModelInstance()
Date	getFinishedDate() Returns the finished date.
ModelInstanceInfo	getInfo(boolean includeProperties) Returns ModelInstanceInfo for this model instance.
long	getLastAllocatedValueId() Returns the last allocated value id.
long	getLastDetachmentId() Returns the last detachment id.
ModelInstanceState	getLifecycleState() Returns life-cycle state.
Module	getModel() Returns the model.
String	getModelHash() Returns the model hash.
long	getModelId() Returns the model id.
ModelInstance	getModelInstance(ModelInstanceUtilsService modelInstanceUtilsService) Returns the model instance.
ModelUpdate	getModelInstanceMigration() Returns the model instance migration.
String	getModelName() Returns the model name.
String	getModelVersion() Returns the model version.
ModelInstanceEntity	getParent() Returns the parent model instance.
Map<String,String>	getProperties() Returns an unmodifiable map of model instance properties.
String	getProperty(String name) Returns a model instance property by its name.
Date	getStartedDate() Returns the started date
byte[]	getStateData() Returns the state data (XML), unzipped (if zip loader has been used).
boolean	isFinished() Returns true if the model instance is finished.
boolean	isRunning() Returns true if the model instance is running.
boolean	isUsed() Returns true if the model instance is already used in the current thread.
void	marshallState() Saves the model instance state.
void	postPersist() This method must be called after persisting this entity.
void	setFinishedDate(Date finishedDate) Sets the finished date.
void	setId(Long id)
void	setLifecycleState(ModelInstanceState state) Sets life-cycle state.
void	setModelInstance(Module model, ModelInstance mi, boolean createProperties) Sets model instance.
void	setModelInstanceMigration(ModelUpdate modelInstanceMigration) Sets the model instance migration.
void	setNotifications(Collection<String> notifications) Sets the notifications set to the given notification collection.
void	setStartedDate(Date startedDate) Sets the started date.
void	setStateData(byte[] data) Sets the state data.
void	setUsed(boolean used) Sets isUsed to the value.

Methods inherited from class com.whitestein.lsps.common.AbstractEntity

getId

Methods inherited from class java.lang.Object

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

Field Detail

FIND_FORM_PREVIEW_MODEL_INSTANCES

public static final String FIND_FORM_PREVIEW_MODEL_INSTANCES

Query name.

See Also:

Constant Field Values

COUNT_UNFINISHED_MODEL_INSTANCES

public static final String COUNT_UNFINISHED_MODEL_INSTANCES

Query name.

See Also:

Constant Field Values

Constructor Detail

ModelInstanceEntity

protected ModelInstanceEntity()

Creates new empty instance of ModelInstanceEntity.

ModelInstanceEntity

public ModelInstanceEntity(Module model,
                           ModelInstanceEntity parent,
                           Map<String,String> properties,
                           ModelInstanceType type,
                           ModelInstanceResourceAllocator idAllocator)

Creates new instance.

Parameters:

model -

parent -

properties -

type -

idAllocator -

Throws:

NullPointerException - if agentName or modelName or modelVersion or modelHash is null

Method Detail

getModelInstance

public ModelInstance getModelInstance(ModelInstanceUtilsService modelInstanceUtilsService)

Returns the model instance.

Parameters:

modelInstanceUtilsService -

Returns:

the model instance

setId

public void setId(Long id)

Overrides:

setId in class com.whitestein.lsps.common.AbstractEntity

getParent

public ModelInstanceEntity getParent()

Returns the parent model instance.

Returns:

the parent model instance

getModel

public Module getModel()

Returns the model.

Returns:

the model

getModelId

public long getModelId()

Returns the model id.

Returns:

the model id

getModelName

public String getModelName()

Returns the model name.

Returns:

the model name

getModelVersion

public String getModelVersion()

Returns the model version.

Returns:

the model version

getModelHash

public String getModelHash()

Returns the model hash.

Returns:

the model hash

getLifecycleState

public ModelInstanceState getLifecycleState()

Returns life-cycle state.

Returns:

life-cycle state

setLifecycleState

public void setLifecycleState(ModelInstanceState state)

Sets life-cycle state.

Parameters:

state -

isFinished

public boolean isFinished()

Returns true if the model instance is finished.

Returns:

true if the model instance is finished

isRunning

public boolean isRunning()

Returns true if the model instance is running.

Returns:

true if the model instance is running

getModelInstanceMigration

public ModelUpdate getModelInstanceMigration()

Returns the model instance migration.

Returns:

the model instance migration

setModelInstanceMigration

public void setModelInstanceMigration(ModelUpdate modelInstanceMigration)

Sets the model instance migration.

Parameters:

modelInstanceMigration -

getStartedDate

public Date getStartedDate()

Returns the started date

Returns:

the started date

setStartedDate

public void setStartedDate(Date startedDate)

Sets the started date.

Parameters:

startedDate -

getFinishedDate

public Date getFinishedDate()

Returns the finished date.

Returns:

the finished date

setFinishedDate

public void setFinishedDate(Date finishedDate)

Sets the finished date.

Parameters:

finishedDate -

getProperties

public Map<String,String> getProperties()

Returns an unmodifiable map of model instance properties.

Returns:

an unmodifiable map of model instance properties

getProperty

public String getProperty(String name)

Returns a model instance property by its name.

Parameters:

name -

Returns:

a model instance property by its name

getStateData

public byte[] getStateData()

Returns the state data (XML), unzipped (if zip loader has been used).

Returns:

the state data (XML)

setStateData

public void setStateData(byte[] data)

Sets the state data.

Parameters:

data - the new state data (unzipped)

marshallState

public void marshallState()

Saves the model instance state.

getInfo

public ModelInstanceInfo getInfo(boolean includeProperties)

Returns ModelInstanceInfo for this model instance.

Parameters:

includeProperties -

Returns:

ModelInstanceInfo for this model instance

postPersist

public void postPersist()

This method must be called after persisting this entity. Using PostPersist does not work, because it is called only after flushing the entity.

setModelInstance

public void setModelInstance(Module model,
                             ModelInstance mi,
                             boolean createProperties)

Sets model instance.

Parameters:

model -

mi -

createProperties -

addProperty

public void addProperty(String name,
                        String value)

Adds a property. Can overwrite existing properties.

Parameters:

name -

value -

clearNotifications

public void clearNotifications()

Clears all notifications.

clearTempModelInstance

public void clearTempModelInstance()

addNotification

public void addNotification(String notification)

Adds a notification.

Parameters:

notification -

setNotifications

public void setNotifications(Collection<String> notifications)

Sets the notifications set to the given notification collection.

Parameters:

notifications -

setUsed

public void setUsed(boolean used)

Sets isUsed to the value.

Parameters:

used -

isUsed

public boolean isUsed()

Returns true if the model instance is already used in the current thread.

Returns:

true if the model instance is already used

getLastAllocatedValueId

public long getLastAllocatedValueId()

Returns the last allocated value id.

Returns:

the last allocated value id

getLastDetachmentId

public long getLastDetachmentId()

Returns the last detachment id.

Returns:

the last detachment id

allocateValueIds

public AllocatedModelInstanceResources allocateValueIds(long allocatedSize)

Allocates next range of value ids.

Parameters:

allocatedSize -

Returns:

next range of value ids

allocateDetachmentAndValueIds

public AllocatedModelInstanceResources allocateDetachmentAndValueIds(long allocatedSize)

Allocates next range of value ids and detachment id.

Parameters:

allocatedSize -

Returns:

next range of value ids and detachment id