org.activiti.engine.impl.persistence.entity

Class VariableScopeImpl

java.lang.Object

org.activiti.engine.impl.persistence.entity.VariableScopeImpl

All Implemented Interfaces:

Serializable, VariableScope

Direct Known Subclasses:

ExecutionEntity, TaskEntity

public abstract class VariableScopeImpl
extends Object
implements Serializable, VariableScope

Author:

Tom Baeyens, Joram Barrez, Tijs Rademakers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ELContext	cachedElContext
protected String	id
protected List<VariableInstanceEntity>	variableInstanceList
protected Map<String,VariableInstanceEntity>	variableInstances

Constructor Summary

Constructors

Constructor and Description
VariableScopeImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<String>	collectVariableNames(Set<String> variableNames)
protected Map<String,Object>	collectVariables(HashMap<String,Object> variables)
protected VariableInstanceEntity	createVariableInstance(String variableName, Object value, ExecutionEntity sourceActivityExecution)
void	createVariableLocal(String variableName, Object value)
protected void	createVariableLocal(String variableName, Object value, ExecutionEntity sourceActivityExecution) only called when a new variable is created on this variable scope.
void	createVariablesLocal(Map<String,? extends Object> variables)
protected void	deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance, ExecutionEntity sourceActivityExecution)
void	deleteVariablesInstanceForLeavingScope()
protected void	ensureVariableInstancesInitialized()
ELContext	getCachedElContext()
String	getId()
protected abstract VariableScopeImpl	getParentVariableScope()
protected ExecutionEntity	getSourceActivityExecution()
Object	getVariable(String variableName)
Object	getVariableLocal(String variableName)
Set<String>	getVariableNames()
Set<String>	getVariableNamesLocal()
Map<String,Object>	getVariables()
Map<String,Object>	getVariablesLocal()
boolean	hasVariable(String variableName)
boolean	hasVariableLocal(String variableName)
boolean	hasVariables()
boolean	hasVariablesLocal()
protected abstract void	initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)
protected boolean	isActivityIdUsedForDetails() Execution variable updates have activity instance ids, but historic task variable updates don't.
protected abstract List<VariableInstanceEntity>	loadVariableInstances()
void	removeVariable(String variableName) Removes the variable and creates a new HistoricVariableUpdateEntity .
protected void	removeVariable(String variableName, ExecutionEntity sourceActivityExecution)
void	removeVariableLocal(String variableName) Removes the local variable and creates a new HistoricVariableUpdateEntity.
protected void	removeVariableLocal(String variableName, ExecutionEntity sourceActivityExecution)
void	removeVariables() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariables(Collection<String> variableNames) Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal(Collection<String> variableNames) Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.
void	setCachedElContext(ELContext cachedElContext)
void	setId(String id)
void	setVariable(String variableName, Object value) Sets the variable with the provided name to the provided value.
protected void	setVariable(String variableName, Object value, ExecutionEntity sourceActivityExecution)
Object	setVariableLocal(String variableName, Object value)
Object	setVariableLocal(String variableName, Object value, ExecutionEntity sourceActivityExecution)
void	setVariables(Map<String,? extends Object> variables) Sets the provided variables to the variable scope.
void	setVariablesLocal(Map<String,? extends Object> variables)
protected void	updateVariableInstance(VariableInstanceEntity variableInstance, Object value, ExecutionEntity sourceActivityExecution)

Methods inherited from class java.lang.Object

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

Field Detail

variableInstances

protected Map<String,VariableInstanceEntity> variableInstances

variableInstanceList

protected List<VariableInstanceEntity> variableInstanceList

cachedElContext

protected ELContext cachedElContext

id

protected String id

Constructor Detail

VariableScopeImpl

public VariableScopeImpl()

Method Detail

loadVariableInstances

protected abstract List<VariableInstanceEntity> loadVariableInstances()

getParentVariableScope

protected abstract VariableScopeImpl getParentVariableScope()

initializeVariableInstanceBackPointer

protected abstract void initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)

ensureVariableInstancesInitialized

protected void ensureVariableInstancesInitialized()

getVariables

public Map<String,Object> getVariables()

Specified by:

getVariables in interface VariableScope

collectVariables

protected Map<String,Object> collectVariables(HashMap<String,Object> variables)

getVariable

public Object getVariable(String variableName)

Specified by:

getVariable in interface VariableScope

getVariableLocal

public Object getVariableLocal(String variableName)

Specified by:

getVariableLocal in interface VariableScope

hasVariables

public boolean hasVariables()

Specified by:

hasVariables in interface VariableScope

hasVariablesLocal

public boolean hasVariablesLocal()

Specified by:

hasVariablesLocal in interface VariableScope

hasVariable

public boolean hasVariable(String variableName)

Specified by:

hasVariable in interface VariableScope

hasVariableLocal

public boolean hasVariableLocal(String variableName)

Specified by:

hasVariableLocal in interface VariableScope

collectVariableNames

protected Set<String> collectVariableNames(Set<String> variableNames)

getVariableNames

public Set<String> getVariableNames()

Specified by:

getVariableNames in interface VariableScope

getVariablesLocal

public Map<String,Object> getVariablesLocal()

Specified by:

getVariablesLocal in interface VariableScope

getVariableNamesLocal

public Set<String> getVariableNamesLocal()

Specified by:

getVariableNamesLocal in interface VariableScope

createVariablesLocal

public void createVariablesLocal(Map<String,? extends Object> variables)

setVariables

public void setVariables(Map<String,? extends Object> variables)

Description copied from interface: VariableScope

Sets the provided variables to the variable scope.

Variables are set according algorithm for VariableScope.setVariable(String, Object), applied separately to each variable.

Specified by:

setVariables in interface VariableScope

Parameters:

variables - a map of keys and values for the variables to be set

See Also:

{@link VariableScope#setVariable(String, Object)}

setVariablesLocal

public void setVariablesLocal(Map<String,? extends Object> variables)

Specified by:

setVariablesLocal in interface VariableScope

removeVariables

public void removeVariables()

Description copied from interface: VariableScope

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariables in interface VariableScope

removeVariablesLocal

public void removeVariablesLocal()

Description copied from interface: VariableScope

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariablesLocal in interface VariableScope

deleteVariablesInstanceForLeavingScope

public void deleteVariablesInstanceForLeavingScope()

removeVariables

public void removeVariables(Collection<String> variableNames)

Description copied from interface: VariableScope

Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariables in interface VariableScope

removeVariablesLocal

public void removeVariablesLocal(Collection<String> variableNames)

Description copied from interface: VariableScope

Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariablesLocal in interface VariableScope

setVariable

public void setVariable(String variableName,
               Object value)

Description copied from interface: VariableScope

Sets the variable with the provided name to the provided value.

A variable is set according to the following algorithm:

If this scope already contains a variable by the provided name as a local variable, its value is overwritten to the provided value. If this scope does not contain a variable by the provided name as a local variable, the variable is set to this scope's parent scope, if there is one. If there is no parent scope (meaning this scope is the root scope of the hierarchy it belongs to), this scope is used. This applies recursively up the parent scope chain until, if no scope contains a local variable by the provided name, ultimately the root scope is reached and the variable value is set on that scope.

In practice for most cases, this algorithm will set variables to the scope of the execution at the process instance’s root level, if there is no execution-local variable by the provided name.

Specified by:

setVariable in interface VariableScope

Parameters:

variableName - the name of the variable to be set

value - the value of the variable to be set

setVariable

protected void setVariable(String variableName,
               Object value,
               ExecutionEntity sourceActivityExecution)

setVariableLocal

public Object setVariableLocal(String variableName,
                      Object value)

Specified by:

setVariableLocal in interface VariableScope

setVariableLocal

public Object setVariableLocal(String variableName,
                      Object value,
                      ExecutionEntity sourceActivityExecution)

createVariableLocal

public void createVariableLocal(String variableName,
                       Object value)

Specified by:

createVariableLocal in interface VariableScope

createVariableLocal

protected void createVariableLocal(String variableName,
                       Object value,
                       ExecutionEntity sourceActivityExecution)

only called when a new variable is created on this variable scope. This method is also responsible for propagating the creation of this variable to the history.

removeVariable

public void removeVariable(String variableName)

Description copied from interface: VariableScope

Removes the variable and creates a new HistoricVariableUpdateEntity .

Specified by:

removeVariable in interface VariableScope

removeVariable

protected void removeVariable(String variableName,
                  ExecutionEntity sourceActivityExecution)

removeVariableLocal

public void removeVariableLocal(String variableName)

Description copied from interface: VariableScope

Removes the local variable and creates a new HistoricVariableUpdateEntity.

Specified by:

removeVariableLocal in interface VariableScope

getSourceActivityExecution

protected ExecutionEntity getSourceActivityExecution()

removeVariableLocal

protected void removeVariableLocal(String variableName,
                       ExecutionEntity sourceActivityExecution)

deleteVariableInstanceForExplicitUserCall

protected void deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance,
                                             ExecutionEntity sourceActivityExecution)

updateVariableInstance

protected void updateVariableInstance(VariableInstanceEntity variableInstance,
                          Object value,
                          ExecutionEntity sourceActivityExecution)

createVariableInstance

protected VariableInstanceEntity createVariableInstance(String variableName,
                                            Object value,
                                            ExecutionEntity sourceActivityExecution)

isActivityIdUsedForDetails

protected boolean isActivityIdUsedForDetails()

Execution variable updates have activity instance ids, but historic task variable updates don't.

getCachedElContext

public ELContext getCachedElContext()

setCachedElContext

public void setCachedElContext(ELContext cachedElContext)

getId

public String getId()

setId

public void setId(String id)