com.whitestein.lsps.engine.state.xml

Class Context

java.lang.Object

com.whitestein.lsps.engine.state.xml.Context

All Implemented Interfaces:

Collectible, EntityWithId, EvaluationLevelAware, ModelIdentifiable, ModelInstanceAware

Direct Known Subclasses:

ContextWithFreeTypes, RecordContext

public class Context
extends java.lang.Object
implements Collectible, ModelInstanceAware, EntityWithId, ModelIdentifiable, EvaluationLevelAware

Entity representing execution context state. Context state contains variables identified by their name, each containing Value.

Author:

rba

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Context(Context context, ModelInstance targetModelInstance)
	Context(long id, ModelInstance modelInstance, Context parentContext, com.whitestein.lsps.model.ContextModelElement element) Creates new instance of Context for given ProcessModel.
	Context(long id, ModelInstance modelInstance, Context parentContext, java.lang.String name) Creates new instance of Context.
	Context(long id, ModelInstance modelInstance, Context parentContext, java.lang.String name, java.lang.String level, long baseLevelContextId, Context lowerLevelContext) Creates new instance of Context.
	Context(ModelInstance modelInstance, Context parentContext, com.whitestein.lsps.model.ContextModelElement element) Creates new instance of Context for given ProcessModel.
	Context(ModelInstance modelInstance, Context parentContext, java.lang.String name) Creates new instance of Context.
	Context(ModelInstance modelInstance, Context parentContext, java.lang.String name, java.lang.String level, long baseLevelContextId, Context lowerLevelContext) Creates new instance of Context.
protected	Context(SContext source, Context parentContext, ModelInstance modelInstance) Creates a new instance from the serialized companion.

Method Summary

Modifier and Type	Method and Description
Context	addChildContext(Context context) Adds context as child of this context.
Context	addNewChildContext(com.whitestein.lsps.model.ContextModelElement element) Adds new child context.
Context	addNewChildContext(java.lang.String name) Adds new child context.
Context	addNewChildContext(java.lang.String name, java.util.Map<FreeType,Type> freeTypeMapping) Adds new child context.
Variable	addNewVariable(java.lang.String name, java.lang.String type) Deprecated. Use addNewVariable(String, Type)
Variable	addNewVariable(java.lang.String name, java.lang.String type, Type compiledType, Value value, boolean isReadOnly) Adds a new variable.
Variable	addNewVariable(java.lang.String name, java.lang.String type, Value value, boolean isReadOnly) Deprecated. Use addNewVariable(String, Type, Value, boolean)
Variable	addNewVariable(java.lang.String name, Type type) Adds a new variable.
Variable	addNewVariable(java.lang.String name, Type type, Value value, boolean isReadOnly) Adds a new variable.
Variable	addVariable(Variable var) Adds new variable.
void	addVariables(java.util.Collection<? extends Variable> variables) Adds several variables.
void	clear() Clears variables.
protected NamespaceModel	clearNamespaceModel()
void	collect() Removes itself from the process.
void	collectTree() Collects this context and all its children (recursivelly).
boolean	containsVariable(java.lang.String name) Returns true if this context contains variable with given name.
protected void	convertToDirectReferences()
void	convertToRemovedRecordContext(ModelProvider modelProvider) Do not use this method! This method is used only in evaluation levels merge.
Context	createCopy(ModelInstance targetModelInstance) Creates a copy without references to other objects.
Context	createInLevel(java.lang.String level, Context parentContext, CommonRecordValue record, Context lowerLevelContext) Creates a context on a given level.
protected NamespaceModel	createNamespaceModel(ModelProvider modelProvider) Creates namespace model for this.
Variable	createVariable(java.lang.String name, java.lang.String type, Type compiledType, Value value, boolean isReadOnly) Creates a variable but does not add it to the context yet.
void	finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source, CopyHelper helper) Copy references.
static Context	fromSerializable(SContext source, Context parentContext, ModelInstance modelInstance) Creates a new instance from the serialized companion.
java.util.Set<java.lang.String>	getAllFreeTypeNames() Returns all free type names.
Context	getBaseLevelEntity() Returns base level context.
long	getBaseLevelEntityId() Returns id of the corresponding context in base level.
java.util.Collection<Context>	getChildContexts() Returns immutable collection of child contexts.
CompiledNamespace	getCompiled() Returns instance of namespace compiled to java.
Type	getCompiledType(ModelProvider modelProvider, java.lang.String typeName) Returns the compiled type.
com.whitestein.lsps.model.ContextModelElement	getElement(ModelProvider modelProvider) Returns the model element.
java.lang.String	getElementId() Returns the element id.
java.lang.String	getElementId(ModelProvider modelProvider) Returns the model element id.
java.lang.String	getEvaluationLevel() Returns evaluation level of this value.
ContextFreeType	getFreeType(java.lang.String name) Returns free type value for given name or null if it does not exist.
FreeTypeMapping	getFreeTypeMapping(ModelProvider modelProvider) Returns free type mappings for this context.
long	getId() Returns the id.
Context	getLowerLevelEntity() Returns lower level context.
java.lang.Long	getLowerLevelEntityId() Returns id of the corresponding context in previous lower level.
Context	getLowestLevelEntity() Returns lowest level context.
ModelInstance	getModelInstance() Returns the model instance.
java.lang.String	getName() Returns name of this context.
NamespaceModel	getNamespaceModel(ModelProvider modelProvider) Returns namespace model
Context	getParentContext() Returns the parent context or null if this is top module context.
java.lang.String	getPath() Returns the full path to this element as a string.
QID	getPathQID() Returns the full path to this element as a QID.
ProcessInstance	getProcessInstance() Returns the process instance containing this context, can be null.
CommonRecordValue	getRecordValue() Returns record value.
java.lang.Long	getRecordValueId() Returns id of record value.
java.util.Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
Context	getTopContext() Returns the top module context.
Variable	getVariableInstance(java.lang.String name) Returns variable instance by variable name or null if it does not exist.
java.util.Set<java.lang.String>	getVariableNames() Returns the names of the variables.
java.util.Collection<Variable>	getVariables() Returns an immutable collection of variables.
Value	getVariableValue(java.lang.String name) Returns variable value for given name or null if it does not exist.
boolean	hasParent(Context ctx) Returns true if any of the parents (not only direct one) is the specified context.
boolean	isPersistent() Returns true if this object cannot be collected.
Context	makeCopy(ModelInstance targetModelInstance) Returns deep copy.
void	rebind(ModelInstance modelInstance) Re-binds to a model instance.
void	refreshDirectReferences() Re-set references to elements from the same model instance.
boolean	removeChildContext(Context context) Removes a child context.
void	replaceReferencedIds(java.util.Map<java.lang.Long,java.lang.Long> replacementMap) Replace referenced ids according to mappings in the replacement map.
void	setCompiled(CompiledNamespace compiled) Sets instance of namespace compiled to java
void	setLowerLevelEntity(Context lowerLevelEntity) Sets lower level entity.
void	setVariables(java.util.Collection<? extends Variable> variables) Sets variables.
void	setVariableValue(java.lang.String name, Value value) Sets variable value for given name.
SContext	toSerializable(SContext parent, SModelInstance smi, MarshallerConfig config) Creates a serializable object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(long id,
               ModelInstance modelInstance,
               Context parentContext,
               java.lang.String name,
               java.lang.String level,
               long baseLevelContextId,
               Context lowerLevelContext)

Creates new instance of Context.

Parameters:

id -

modelInstance -

parentContext -

name -

level -

baseLevelContextId -

lowerLevelContext -

Throws:

java.lang.NullPointerException - if moduleInstance or name

Context

public Context(ModelInstance modelInstance,
               Context parentContext,
               java.lang.String name,
               java.lang.String level,
               long baseLevelContextId,
               Context lowerLevelContext)

Creates new instance of Context.

Parameters:

modelInstance -

parentContext -

name -

level -

baseLevelContextId -

lowerLevelContext -

Throws:

java.lang.NullPointerException - if moduleInstance or name

Context

public Context(long id,
               ModelInstance modelInstance,
               Context parentContext,
               java.lang.String name)

Creates new instance of Context.

Parameters:

id -

modelInstance -

parentContext -

name -

Throws:

java.lang.NullPointerException - if moduleInstance or name

Context

public Context(ModelInstance modelInstance,
               Context parentContext,
               java.lang.String name)

Creates new instance of Context.

Parameters:

modelInstance -

parentContext -

name -

Throws:

java.lang.NullPointerException - if moduleInstance or name

Context

public Context(ModelInstance modelInstance,
               Context parentContext,
               com.whitestein.lsps.model.ContextModelElement element)

Creates new instance of Context for given ProcessModel. It creates the context as a top context.

Parameters:

modelInstance -

parentContext -

element -

Throws:

java.lang.NullPointerException - if modelInstance or moduleInstance or element is null

Context

public Context(long id,
               ModelInstance modelInstance,
               Context parentContext,
               com.whitestein.lsps.model.ContextModelElement element)

Creates new instance of Context for given ProcessModel. It creates the context as a top context.

Parameters:

id -

modelInstance -

parentContext -

element -

Throws:

java.lang.NullPointerException - if modelInstance or moduleInstance or element is null

Context

protected Context(SContext source,
                  Context parentContext,
                  ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

source -

parentContext -

modelInstance -

Context

protected Context(Context context,
                  ModelInstance targetModelInstance)

Method Detail

fromSerializable

public static Context fromSerializable(SContext source,
                                       Context parentContext,
                                       ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

source -

parentContext -

modelInstance -

Returns:

the created context

toSerializable

public SContext toSerializable(SContext parent,
                               SModelInstance smi,
                               MarshallerConfig config)

Creates a serializable object.

Parameters:

parent -

smi -

config -

Returns:

the created serializable object

getId

public long getId()

Description copied from interface: EntityWithId

Returns the id.

Specified by:

getId in interface EntityWithId

Returns:

the id

getName

public java.lang.String getName()

Returns name of this context.

Returns:

name of this context

getRecordValueId

public java.lang.Long getRecordValueId()

Returns id of record value.

Returns:

id of record value

getRecordValue

public CommonRecordValue getRecordValue()

Returns record value.

Returns:

record value

getPathQID

public QID getPathQID()

Returns the full path to this element as a QID. The path contains names of all parent contexts excluding technical context (whose names starts with $).

Returns:

the full path to this element as a QID

getPath

public java.lang.String getPath()

Returns the full path to this element as a string. The path contains names of all parent contexts excluding technical context (whose names starts with $).

Returns:

the full path to this element as a string

getParentContext

public Context getParentContext()

Returns the parent context or null if this is top module context.

Returns:

the parent context

getTopContext

public Context getTopContext()

Returns the top module context.

Returns:

the top context

hasParent

public boolean hasParent(Context ctx)

Returns true if any of the parents (not only direct one) is the specified context.

Parameters:

ctx -

Returns:

true if any of the parents is the specified context

getChildContexts

public java.util.Collection<Context> getChildContexts()

Returns immutable collection of child contexts.

Returns:

collection of child contexts

addChildContext

public Context addChildContext(Context context)

Adds context as child of this context.

Parameters:

context -

Returns:

added context

removeChildContext

public boolean removeChildContext(Context context)

Removes a child context.

Parameters:

context -

Returns:

true if the context contained the given child context

addNewChildContext

public Context addNewChildContext(com.whitestein.lsps.model.ContextModelElement element)

Adds new child context.

Parameters:

element -

Returns:

added context

Throws:

java.lang.NullPointerException - if element is null

addNewChildContext

public Context addNewChildContext(java.lang.String name)

Adds new child context.

Parameters:

name -

Returns:

added context

Throws:

java.lang.NullPointerException - if name is null

addNewChildContext

public Context addNewChildContext(java.lang.String name,
                                  java.util.Map<FreeType,Type> freeTypeMapping)

Adds new child context.

Parameters:

name -

freeTypeMapping -

Returns:

added context

Throws:

java.lang.NullPointerException - if name is null

containsVariable

public boolean containsVariable(java.lang.String name)

Returns true if this context contains variable with given name.

Parameters:

name - variable name

Returns:

true if this context contains variable with given name

getVariables

public java.util.Collection<Variable> getVariables()

Returns an immutable collection of variables.

Returns:

a collection of variables

getVariableNames

public java.util.Set<java.lang.String> getVariableNames()

Returns the names of the variables.

Returns:

the names of the variables

getVariableInstance

public Variable getVariableInstance(java.lang.String name)

Returns variable instance by variable name or null if it does not exist.

Parameters:

name -

Returns:

variable instance by variable name

getVariableValue

public Value getVariableValue(java.lang.String name)

Returns variable value for given name or null if it does not exist.

Parameters:

name -

Returns:

variable

setVariableValue

public void setVariableValue(java.lang.String name,
                             Value value)

Sets variable value for given name.

Parameters:

name -

value -

Throws:

java.lang.IllegalArgumentException - if given variable does not exist

java.lang.NullPointerException - if value is null

getElementId

public java.lang.String getElementId()

Returns the element id.

Returns:

the element id

getElementId

public java.lang.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

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 java.util.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

collectTree

public void collectTree()

Collects this context and all its children (recursivelly).

addVariable

public Variable addVariable(Variable var)

Adds new variable.

Parameters:

var -

Returns:

the variable

Throws:

java.lang.IllegalArgumentException - if a variable with the same name already exist

addVariables

public void addVariables(java.util.Collection<? extends Variable> variables)

Adds several variables.

Parameters:

variables -

setVariables

public void setVariables(java.util.Collection<? extends Variable> variables)

Sets variables.

Parameters:

variables -

clearNamespaceModel

protected NamespaceModel clearNamespaceModel()

addNewVariable

@Deprecated
public Variable addNewVariable(java.lang.String name,
                                           java.lang.String type)

Deprecated. Use addNewVariable(String, Type)

Adds a new variable.

Parameters:

name -

type -

Returns:

the variable

Throws:

java.lang.IllegalArgumentException - if a variable with the same name already exist

addNewVariable

public Variable addNewVariable(java.lang.String name,
                               Type type)

Adds a new variable.

Parameters:

name -

type -

Returns:

the variable

Throws:

java.lang.IllegalArgumentException - if a variable with the same name already exist

addNewVariable

@Deprecated
public Variable addNewVariable(java.lang.String name,
                                           java.lang.String type,
                                           Value value,
                                           boolean isReadOnly)

Deprecated. Use addNewVariable(String, Type, Value, boolean)

Adds a new variable.

Parameters:

name -

type -

value -

isReadOnly -

Returns:

the variable

Throws:

java.lang.IllegalArgumentException - if a variable with the same name already exist

addNewVariable

public Variable addNewVariable(java.lang.String name,
                               Type type,
                               Value value,
                               boolean isReadOnly)

Adds a new variable.

Parameters:

name -

type -

value -

isReadOnly -

Returns:

the variable

Throws:

java.lang.IllegalArgumentException - if a variable with the same name already exist

addNewVariable

public Variable addNewVariable(java.lang.String name,
                               java.lang.String type,
                               Type compiledType,
                               Value value,
                               boolean isReadOnly)

Adds a new variable.

Parameters:

name -

type -

compiledType - a compiled type if known, may be null

value -

isReadOnly -

Returns:

the variable

Throws:

java.lang.IllegalArgumentException - if a variable with the same name already exist

createVariable

public Variable createVariable(java.lang.String name,
                               java.lang.String type,
                               Type compiledType,
                               Value value,
                               boolean isReadOnly)

Creates a variable but does not add it to the context yet.

Parameters:

name -

type -

compiledType -

value -

isReadOnly -

Returns:

the created variable

getFreeType

public ContextFreeType getFreeType(java.lang.String name)

Returns free type value for given name or null if it does not exist.

Parameters:

name -

Returns:

free type value for given name

Throws:

java.lang.NullPointerException - if name is null

getProcessInstance

public ProcessInstance getProcessInstance()

Returns the process instance containing this context, can be null.

Returns:

the process instance containing this context

getModelInstance

public ModelInstance getModelInstance()

Description copied from interface: ModelInstanceAware

Returns the model instance.

Specified by:

getModelInstance in interface ModelInstanceAware

Returns:

the model instance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEvaluationLevel

public java.lang.String getEvaluationLevel()

Returns evaluation level of this value.

Specified by:

getEvaluationLevel in interface EvaluationLevelAware

Returns:

evaluation level of this value

getBaseLevelEntityId

public long getBaseLevelEntityId()

Returns id of the corresponding context in base level.

Specified by:

getBaseLevelEntityId in interface EvaluationLevelAware

Returns:

id of the corresponding context in base level

getBaseLevelEntity

public Context getBaseLevelEntity()

Returns base level context.

Specified by:

getBaseLevelEntity in interface EvaluationLevelAware

Returns:

base level context

getLowestLevelEntity

public Context getLowestLevelEntity()

Returns lowest level context.

Returns:

lowest level context

getLowerLevelEntityId

public java.lang.Long getLowerLevelEntityId()

Returns id of the corresponding context in previous lower level.

Specified by:

getLowerLevelEntityId in interface EvaluationLevelAware

Returns:

id of the corresponding context in previous lower level

getLowerLevelEntity

public Context getLowerLevelEntity()

Returns lower level context.

Specified by:

getLowerLevelEntity in interface EvaluationLevelAware

Returns:

lower level context

setLowerLevelEntity

public void setLowerLevelEntity(Context lowerLevelEntity)

Sets lower level entity.

Parameters:

lowerLevelEntity -

getNamespaceModel

public NamespaceModel getNamespaceModel(ModelProvider modelProvider)

Returns namespace model

Parameters:

modelProvider -

Returns:

namespace model

createNamespaceModel

protected NamespaceModel createNamespaceModel(ModelProvider modelProvider)

Creates namespace model for this.

Parameters:

modelProvider -

Returns:

namespace model for this.

getFreeTypeMapping

public FreeTypeMapping getFreeTypeMapping(ModelProvider modelProvider)

Returns free type mappings for this context.

Parameters:

modelProvider -

Returns:

free type mappings for this context

getAllFreeTypeNames

public java.util.Set<java.lang.String> getAllFreeTypeNames()

Returns all free type names.

Returns:

all free type names

getCompiledType

public Type getCompiledType(ModelProvider modelProvider,
                            java.lang.String typeName)

Returns the compiled type.

Parameters:

modelProvider -

typeName -

Returns:

the compiled type

replaceReferencedIds

public void replaceReferencedIds(java.util.Map<java.lang.Long,java.lang.Long> replacementMap)

Replace referenced ids according to mappings in the replacement map.

Specified by:

replaceReferencedIds in interface EvaluationLevelAware

Parameters:

replacementMap -

rebind

public void rebind(ModelInstance modelInstance)

Re-binds to a model instance.

Specified by:

rebind in interface ModelInstanceAware

Parameters:

modelInstance -

clear

public void clear()

Clears variables.

Specified by:

clear in interface EvaluationLevelAware

createCopy

public Context 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.

makeCopy

public final Context makeCopy(ModelInstance targetModelInstance)

Returns deep copy.

Parameters:

targetModelInstance -

Returns:

deep copy

getCompiled

public CompiledNamespace getCompiled()

Returns instance of namespace compiled to java.

Returns:

instance of namespace compiled to java

setCompiled

public void setCompiled(CompiledNamespace compiled)

Sets instance of namespace compiled to java

Parameters:

compiled -

convertToDirectReferences

protected void convertToDirectReferences()

refreshDirectReferences

public void refreshDirectReferences()

Description copied from interface: EvaluationLevelAware

Re-set references to elements from the same model instance.

Specified by:

refreshDirectReferences in interface EvaluationLevelAware

createInLevel

public Context createInLevel(java.lang.String level,
                             Context parentContext,
                             CommonRecordValue record,
                             Context lowerLevelContext)

Creates a context on a given level.

Parameters:

level -

parentContext -

record -

lowerLevelContext -

Returns:

the created context

convertToRemovedRecordContext

public void convertToRemovedRecordContext(ModelProvider modelProvider)

Do not use this method! This method is used only in evaluation levels merge. Converts context of deleted record to a regular context so that closures that are referencing the context can be executed.

Parameters:

modelProvider -