org.activiti.engine.impl.persistence.entity

Class VariableScopeImpl

java.lang.Object

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

All Implemented Interfaces:

Serializable, org.flowable.common.engine.api.variable.VariableContainer, org.flowable.variable.api.delegate.VariableScope

Direct Known Subclasses:

ExecutionEntity, TaskEntity

public abstract class VariableScopeImpl
extends Object
implements Serializable, org.flowable.variable.api.delegate.VariableScope

Author:

Tom Baeyens, Joram Barrez, Tijs Rademakers, Saeid Mirzaei

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.flowable.common.engine.impl.javax.el.ELContext	cachedElContext
protected String	id
protected Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	transientVariabes
protected Map<String,VariableInstanceEntity>	usedVariablesCache
protected Map<String,VariableInstanceEntity>	variableInstances

Constructor Summary

Constructors

Constructor and Description
VariableScopeImpl()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	collectTransientVariables(HashMap<String,Object> variables)
protected Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	collectVariableInstances(HashMap<String,org.flowable.variable.api.persistence.entity.VariableInstance> variables)
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()
org.flowable.common.engine.impl.javax.el.ELContext	getCachedElContext()
String	getId()
protected abstract VariableScopeImpl	getParentVariableScope()
protected ExecutionEntity	getSourceActivityExecution()
protected abstract VariableInstanceEntity	getSpecificVariable(String variableName)
protected abstract List<VariableInstanceEntity>	getSpecificVariables(Collection<String> variableNames)
Object	getTransientVariable(String variableName)
Object	getTransientVariableLocal(String variableName)
Map<String,Object>	getTransientVariables()
Map<String,Object>	getTransientVariablesLocal()
Map<String,VariableInstanceEntity>	getUsedVariablesCache()
Object	getVariable(String variableName)
Object	getVariable(String variableName, boolean fetchAllVariables) The same operation as getVariable(String), but with an extra parameter to indicate whether or not all variables need to be fetched.
<T> T	getVariable(String variableName, Class<T> variableClass)
org.flowable.variable.api.persistence.entity.VariableInstance	getVariableInstance(String variableName)
org.flowable.variable.api.persistence.entity.VariableInstance	getVariableInstance(String variableName, boolean fetchAllVariables)
Map<String,VariableInstanceEntity>	getVariableInstanceEntities()
org.flowable.variable.api.persistence.entity.VariableInstance	getVariableInstanceLocal(String variableName)
org.flowable.variable.api.persistence.entity.VariableInstance	getVariableInstanceLocal(String variableName, boolean fetchAllVariables)
Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	getVariableInstances()
Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	getVariableInstances(Collection<String> variableNames)
Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	getVariableInstances(Collection<String> variableNames, boolean fetchAllVariables)
Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	getVariableInstancesLocal()
Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	getVariableInstancesLocal(Collection<String> variableNames)
Map<String,org.flowable.variable.api.persistence.entity.VariableInstance>	getVariableInstancesLocal(Collection<String> variableNames, boolean fetchAllVariables)
Object	getVariableLocal(String variableName)
Object	getVariableLocal(String variableName, boolean fetchAllVariables)
<T> T	getVariableLocal(String variableName, Class<T> variableClass)
Set<String>	getVariableNames()
Set<String>	getVariableNamesLocal()
Map<String,Object>	getVariables()
Map<String,Object>	getVariables(Collection<String> variableNames)
Map<String,Object>	getVariables(Collection<String> variableNames, boolean fetchAllVariables)
Map<String,Object>	getVariablesLocal()
Map<String,Object>	getVariablesLocal(Collection<String> variableNames)
Map<String,Object>	getVariablesLocal(Collection<String> variableNames, boolean fetchAllVariables)
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	removeTransientVariable(String variableName)
void	removeTransientVariableLocal(String variableName)
void	removeTransientVariables()
void	removeTransientVariablesLocal()
void	removeVariable(String variableName)
protected void	removeVariable(String variableName, ExecutionEntity sourceActivityExecution)
void	removeVariableLocal(String variableName)
protected void	removeVariableLocal(String variableName, ExecutionEntity sourceActivityExecution)
void	removeVariables()
void	removeVariables(Collection<String> variableNames)
void	removeVariablesLocal()
void	removeVariablesLocal(Collection<String> variableNames)
void	setCachedElContext(org.flowable.common.engine.impl.javax.el.ELContext cachedElContext)
void	setId(String id)
void	setTransientVariable(String variableName, Object variableValue)
void	setTransientVariableLocal(String variableName, Object variableValue)
void	setTransientVariables(Map<String,Object> transientVariables)
void	setTransientVariablesLocal(Map<String,Object> transientVariables)
void	setVariable(String variableName, Object value)
void	setVariable(String variableName, Object value, boolean fetchAllVariables) The default setVariable(String, Object) fetches all variables (for historical and backwards compatible reasons) while setting the variables.
protected void	setVariable(String variableName, Object value, ExecutionEntity sourceActivityExecution, boolean fetchAllVariables)
Object	setVariableLocal(String variableName, Object value)
Object	setVariableLocal(String variableName, Object value, boolean fetchAllVariables) The default setVariableLocal(String, Object) fetches all variables (for historical and backwards compatible reasons) while setting the variables.
Object	setVariableLocal(String variableName, Object value, ExecutionEntity sourceActivityExecution, boolean fetchAllVariables)
void	setVariables(Map<String,? extends Object> variables)
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

usedVariablesCache

protected Map<String,VariableInstanceEntity> usedVariablesCache

transientVariabes

protected Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> transientVariabes

cachedElContext

protected org.flowable.common.engine.impl.javax.el.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 org.flowable.variable.api.delegate.VariableScope

getVariableInstances

public Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> getVariableInstances()

Specified by:

getVariableInstances in interface org.flowable.variable.api.delegate.VariableScope

getVariables

public Map<String,Object> getVariables(Collection<String> variableNames)

Specified by:

getVariables in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstances

public Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> getVariableInstances(Collection<String> variableNames)

Specified by:

getVariableInstances in interface org.flowable.variable.api.delegate.VariableScope

getVariables

public Map<String,Object> getVariables(Collection<String> variableNames,
                                       boolean fetchAllVariables)

Specified by:

getVariables in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstances

public Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> getVariableInstances(Collection<String> variableNames,
                                                                                                      boolean fetchAllVariables)

Specified by:

getVariableInstances in interface org.flowable.variable.api.delegate.VariableScope

collectVariables

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

collectVariableInstances

protected Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> collectVariableInstances(HashMap<String,org.flowable.variable.api.persistence.entity.VariableInstance> variables)

getVariable

public Object getVariable(String variableName)

Specified by:

getVariable in interface org.flowable.common.engine.api.variable.VariableContainer

Specified by:

getVariable in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstance

public org.flowable.variable.api.persistence.entity.VariableInstance getVariableInstance(String variableName)

Specified by:

getVariableInstance in interface org.flowable.variable.api.delegate.VariableScope

getVariable

public Object getVariable(String variableName,
                          boolean fetchAllVariables)

The same operation as getVariable(String), but with an extra parameter to indicate whether or not all variables need to be fetched.

Note that the default Activiti way (because of backwards compatibility) is to fetch all the variables when doing a get/set of variables. So this means 'true' is the default value for this method, and in fact it will simply delegate to getVariable(String). This can also be the most performant, if you're doing a lot of variable gets in the same transaction (eg in service tasks).

In case 'false' is used, only the specific variable will be fetched.

Specified by:

getVariable in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstance

public org.flowable.variable.api.persistence.entity.VariableInstance getVariableInstance(String variableName,
                                                                                         boolean fetchAllVariables)

Specified by:

getVariableInstance in interface org.flowable.variable.api.delegate.VariableScope

getSpecificVariable

protected abstract VariableInstanceEntity getSpecificVariable(String variableName)

getVariableLocal

public Object getVariableLocal(String variableName)

Specified by:

getVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstanceLocal

public org.flowable.variable.api.persistence.entity.VariableInstance getVariableInstanceLocal(String variableName)

Specified by:

getVariableInstanceLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableLocal

public Object getVariableLocal(String variableName,
                               boolean fetchAllVariables)

Specified by:

getVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstanceLocal

public org.flowable.variable.api.persistence.entity.VariableInstance getVariableInstanceLocal(String variableName,
                                                                                              boolean fetchAllVariables)

Specified by:

getVariableInstanceLocal in interface org.flowable.variable.api.delegate.VariableScope

hasVariables

public boolean hasVariables()

Specified by:

hasVariables in interface org.flowable.variable.api.delegate.VariableScope

hasVariablesLocal

public boolean hasVariablesLocal()

Specified by:

hasVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

hasVariable

public boolean hasVariable(String variableName)

Specified by:

hasVariable in interface org.flowable.common.engine.api.variable.VariableContainer

Specified by:

hasVariable in interface org.flowable.variable.api.delegate.VariableScope

hasVariableLocal

public boolean hasVariableLocal(String variableName)

Specified by:

hasVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

collectVariableNames

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

getVariableNames

public Set<String> getVariableNames()

Specified by:

getVariableNames in interface org.flowable.variable.api.delegate.VariableScope

getVariablesLocal

public Map<String,Object> getVariablesLocal()

Specified by:

getVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstancesLocal

public Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> getVariableInstancesLocal()

Specified by:

getVariableInstancesLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariablesLocal

public Map<String,Object> getVariablesLocal(Collection<String> variableNames)

Specified by:

getVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstancesLocal

public Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> getVariableInstancesLocal(Collection<String> variableNames)

Specified by:

getVariableInstancesLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariablesLocal

public Map<String,Object> getVariablesLocal(Collection<String> variableNames,
                                            boolean fetchAllVariables)

Specified by:

getVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstancesLocal

public Map<String,org.flowable.variable.api.persistence.entity.VariableInstance> getVariableInstancesLocal(Collection<String> variableNames,
                                                                                                           boolean fetchAllVariables)

Specified by:

getVariableInstancesLocal in interface org.flowable.variable.api.delegate.VariableScope

getSpecificVariables

protected abstract List<VariableInstanceEntity> getSpecificVariables(Collection<String> variableNames)

getVariableNamesLocal

public Set<String> getVariableNamesLocal()

Specified by:

getVariableNamesLocal in interface org.flowable.variable.api.delegate.VariableScope

getVariableInstanceEntities

public Map<String,VariableInstanceEntity> getVariableInstanceEntities()

getUsedVariablesCache

public Map<String,VariableInstanceEntity> getUsedVariablesCache()

createVariablesLocal

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

setVariables

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

Specified by:

setVariables in interface org.flowable.variable.api.delegate.VariableScope

setVariablesLocal

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

Specified by:

setVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

removeVariables

public void removeVariables()

Specified by:

removeVariables in interface org.flowable.variable.api.delegate.VariableScope

removeVariablesLocal

public void removeVariablesLocal()

Specified by:

removeVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

deleteVariablesInstanceForLeavingScope

public void deleteVariablesInstanceForLeavingScope()

removeVariables

public void removeVariables(Collection<String> variableNames)

Specified by:

removeVariables in interface org.flowable.variable.api.delegate.VariableScope

removeVariablesLocal

public void removeVariablesLocal(Collection<String> variableNames)

Specified by:

removeVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

setVariable

public void setVariable(String variableName,
                        Object value)

Specified by:

setVariable in interface org.flowable.common.engine.api.variable.VariableContainer

Specified by:

setVariable in interface org.flowable.variable.api.delegate.VariableScope

setVariable

public void setVariable(String variableName,
                        Object value,
                        boolean fetchAllVariables)

The default setVariable(String, Object) fetches all variables (for historical and backwards compatible reasons) while setting the variables.

Setting the fetchAllVariables parameter to true is the default behaviour (ie fetching all variables) Setting the fetchAllVariables parameter to false does not do that.

Specified by:

setVariable in interface org.flowable.variable.api.delegate.VariableScope

setVariable

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

setVariableLocal

public Object setVariableLocal(String variableName,
                               Object value)

Specified by:

setVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

setVariableLocal

public Object setVariableLocal(String variableName,
                               Object value,
                               boolean fetchAllVariables)

The default setVariableLocal(String, Object) fetches all variables (for historical and backwards compatible reasons) while setting the variables.

Setting the fetchAllVariables parameter to true is the default behaviour (ie fetching all variables) Setting the fetchAllVariables parameter to false does not do that.

Specified by:

setVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

setVariableLocal

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

createVariableLocal

public void createVariableLocal(String variableName,
                                Object value)

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)

Specified by:

removeVariable in interface org.flowable.variable.api.delegate.VariableScope

removeVariable

protected void removeVariable(String variableName,
                              ExecutionEntity sourceActivityExecution)

removeVariableLocal

public void removeVariableLocal(String variableName)

Specified by:

removeVariableLocal in interface org.flowable.variable.api.delegate.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.

setTransientVariablesLocal

public void setTransientVariablesLocal(Map<String,Object> transientVariables)

Specified by:

setTransientVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

setTransientVariableLocal

public void setTransientVariableLocal(String variableName,
                                      Object variableValue)

Specified by:

setTransientVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

setTransientVariables

public void setTransientVariables(Map<String,Object> transientVariables)

Specified by:

setTransientVariables in interface org.flowable.variable.api.delegate.VariableScope

setTransientVariable

public void setTransientVariable(String variableName,
                                 Object variableValue)

Specified by:

setTransientVariable in interface org.flowable.common.engine.api.variable.VariableContainer

Specified by:

setTransientVariable in interface org.flowable.variable.api.delegate.VariableScope

getTransientVariableLocal

public Object getTransientVariableLocal(String variableName)

Specified by:

getTransientVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

getTransientVariablesLocal

public Map<String,Object> getTransientVariablesLocal()

Specified by:

getTransientVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

getTransientVariable

public Object getTransientVariable(String variableName)

Specified by:

getTransientVariable in interface org.flowable.variable.api.delegate.VariableScope

getTransientVariables

public Map<String,Object> getTransientVariables()

Specified by:

getTransientVariables in interface org.flowable.variable.api.delegate.VariableScope

collectTransientVariables

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

removeTransientVariableLocal

public void removeTransientVariableLocal(String variableName)

Specified by:

removeTransientVariableLocal in interface org.flowable.variable.api.delegate.VariableScope

removeTransientVariablesLocal

public void removeTransientVariablesLocal()

Specified by:

removeTransientVariablesLocal in interface org.flowable.variable.api.delegate.VariableScope

removeTransientVariable

public void removeTransientVariable(String variableName)

Specified by:

removeTransientVariable in interface org.flowable.variable.api.delegate.VariableScope

removeTransientVariables

public void removeTransientVariables()

Specified by:

removeTransientVariables in interface org.flowable.variable.api.delegate.VariableScope

getCachedElContext

public org.flowable.common.engine.impl.javax.el.ELContext getCachedElContext()

setCachedElContext

public void setCachedElContext(org.flowable.common.engine.impl.javax.el.ELContext cachedElContext)

getId

public String getId()

setId

public void setId(String id)

getVariable

public <T> T getVariable(String variableName,
                         Class<T> variableClass)

Specified by:

getVariable in interface org.flowable.variable.api.delegate.VariableScope

getVariableLocal

public <T> T getVariableLocal(String variableName,
                              Class<T> variableClass)

Specified by:

getVariableLocal in interface org.flowable.variable.api.delegate.VariableScope