Package org.flowable.variable.service.impl.persistence.entity

Class VariableScopeImpl

java.lang.Object

org.flowable.common.engine.impl.persistence.entity.AbstractEntity

org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl

All Implemented Interfaces:

Serializable, VariableContainer, HasRevision, Entity, VariableScope

public abstract class VariableScopeImpl
extends AbstractEntity
implements Serializable, VariableScope

Author:

Tom Baeyens, Joram Barrez, Tijs Rademakers, Saeid Mirzaei

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ELContext	cachedElContext
protected Map<String,VariableInstance>	transientVariables
protected Map<String,VariableInstanceEntity>	usedVariablesCache
protected Map<String,VariableInstanceEntity>	variableInstances

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Constructor Summary

Constructors

Constructor	Description
VariableScopeImpl()

Method Summary

Modifier and Type	Method	Description
protected abstract void	addLoggingSessionInfo(com.fasterxml.jackson.databind.node.ObjectNode loggingNode)
protected Map<String,Object>	collectTransientVariables(HashMap<String,Object> variables)
protected Map<String,VariableInstance>	collectVariableInstances(HashMap<String,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)
protected void	createVariableLocal(String variableName, Object value)	only called when a new variable is created on this variable scope.
void	createVariablesLocal(Map<String,? extends Object> variables)
protected void	deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance)
protected void	ensureVariableInstancesInitialized()
ELContext	getCachedElContext()
protected abstract VariableScopeImpl	getParentVariableScope()
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)
VariableInstance	getVariableInstance(String variableName)
VariableInstance	getVariableInstance(String variableName, boolean fetchAllVariables)
Map<String,VariableInstanceEntity>	getVariableInstanceEntities()
VariableInstance	getVariableInstanceLocal(String variableName)
VariableInstance	getVariableInstanceLocal(String variableName, boolean fetchAllVariables)
Map<String,VariableInstance>	getVariableInstances()
Map<String,VariableInstance>	getVariableInstances(Collection<String> variableNames)
Map<String,VariableInstance>	getVariableInstances(Collection<String> variableNames, boolean fetchAllVariables)
Map<String,VariableInstance>	getVariableInstancesLocal()
Map<String,VariableInstance>	getVariableInstancesLocal(Collection<String> variableNames)
Map<String,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)
protected abstract VariableServiceConfiguration	getVariableServiceConfiguration()
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)
void	internalSetVariableInstances(Map<String,VariableInstanceEntity> variableInstances)	Only to be used when creating a new entity, to avoid an extra call to the database.
protected boolean	isExpression(String variableName)
protected abstract boolean	isPropagateToHistoricVariable()	Return whether changes to the variables are propagated to the history storage.
protected abstract Collection<VariableInstanceEntity>	loadVariableInstances()
void	removeTransientVariable(String variableName)
void	removeTransientVariableLocal(String variableName)
void	removeTransientVariables()
void	removeTransientVariablesLocal()
void	removeVariable(String variableName)
void	removeVariableLocal(String variableName)
void	removeVariables()
void	removeVariables(Collection<String> variableNames)
void	removeVariablesLocal()
void	removeVariablesLocal(Collection<String> variableNames)
void	setCachedElContext(ELContext cachedElContext)
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.
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.
void	setVariables(Map<String,? extends Object> variables)
void	setVariablesLocal(Map<String,? extends Object> variables)
protected boolean	storeVariableLocal(String variableName)
protected void	updateVariableInstance(VariableInstanceEntity variableInstance, Object value)

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

getIdPrefix, getPersistentState

Methods inherited from interface org.flowable.common.engine.api.variable.VariableContainer

getTenantId

Field Details

variableInstances

protected Map<String,VariableInstanceEntity> variableInstances

usedVariablesCache

protected Map<String,VariableInstanceEntity> usedVariablesCache

transientVariables

protected Map<String,VariableInstance> transientVariables

cachedElContext

protected ELContext cachedElContext

Constructor Details

VariableScopeImpl

public VariableScopeImpl()

Method Details

loadVariableInstances

protected abstract Collection<VariableInstanceEntity> loadVariableInstances()

getParentVariableScope

protected abstract VariableScopeImpl getParentVariableScope()

initializeVariableInstanceBackPointer

protected abstract void initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)

addLoggingSessionInfo

protected abstract void addLoggingSessionInfo(com.fasterxml.jackson.databind.node.ObjectNode loggingNode)

ensureVariableInstancesInitialized

protected void ensureVariableInstancesInitialized()

internalSetVariableInstances

public void internalSetVariableInstances(Map<String,VariableInstanceEntity> variableInstances)

Only to be used when creating a new entity, to avoid an extra call to the database.

getVariables

public Map<String,Object> getVariables()

Specified by:

getVariables in interface VariableScope

getVariableInstances

public Map<String,VariableInstance> getVariableInstances()

Specified by:

getVariableInstances in interface VariableScope

getVariables

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

Specified by:

getVariables in interface VariableScope

getVariableInstances

public Map<String,VariableInstance> getVariableInstances(Collection<String> variableNames)

Specified by:

getVariableInstances in interface VariableScope

getVariables

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

Specified by:

getVariables in interface VariableScope

getVariableInstances

public Map<String,VariableInstance> getVariableInstances(Collection<String> variableNames,
 boolean fetchAllVariables)

Specified by:

getVariableInstances in interface VariableScope

collectVariables

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

collectVariableInstances

protected Map<String,VariableInstance> collectVariableInstances(HashMap<String,VariableInstance> variables)

getVariable

public Object getVariable(String variableName)

Specified by:

getVariable in interface VariableContainer

Specified by:

getVariable in interface VariableScope

getVariableInstance

public VariableInstance getVariableInstance(String variableName)

Specified by:

getVariableInstance in interface 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 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 VariableScope

getVariableInstance

public VariableInstance getVariableInstance(String variableName,
 boolean fetchAllVariables)

Specified by:

getVariableInstance in interface VariableScope

getSpecificVariable

protected abstract VariableInstanceEntity getSpecificVariable(String variableName)

getVariableLocal

public Object getVariableLocal(String variableName)

Specified by:

getVariableLocal in interface VariableScope

getVariableInstanceLocal

public VariableInstance getVariableInstanceLocal(String variableName)

Specified by:

getVariableInstanceLocal in interface VariableScope

getVariableLocal

public Object getVariableLocal(String variableName,
 boolean fetchAllVariables)

Specified by:

getVariableLocal in interface VariableScope

getVariableInstanceLocal

public VariableInstance getVariableInstanceLocal(String variableName,
 boolean fetchAllVariables)

Specified by:

getVariableInstanceLocal 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 VariableContainer

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

getVariableInstancesLocal

public Map<String,VariableInstance> getVariableInstancesLocal()

Specified by:

getVariableInstancesLocal in interface VariableScope

getVariablesLocal

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

Specified by:

getVariablesLocal in interface VariableScope

getVariableInstancesLocal

public Map<String,VariableInstance> getVariableInstancesLocal(Collection<String> variableNames)

Specified by:

getVariableInstancesLocal in interface VariableScope

getVariablesLocal

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

Specified by:

getVariablesLocal in interface VariableScope

getVariableInstancesLocal

public Map<String,VariableInstance> getVariableInstancesLocal(Collection<String> variableNames,
 boolean fetchAllVariables)

Specified by:

getVariableInstancesLocal in interface VariableScope

getSpecificVariables

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

getVariableNamesLocal

public Set<String> getVariableNamesLocal()

Specified by:

getVariableNamesLocal in interface 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 VariableScope

setVariablesLocal

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

Specified by:

setVariablesLocal in interface VariableScope

removeVariables

public void removeVariables()

Specified by:

removeVariables in interface VariableScope

removeVariablesLocal

public void removeVariablesLocal()

Specified by:

removeVariablesLocal in interface VariableScope

removeVariables

public void removeVariables(Collection<String> variableNames)

Specified by:

removeVariables in interface VariableScope

removeVariablesLocal

public void removeVariablesLocal(Collection<String> variableNames)

Specified by:

removeVariablesLocal in interface VariableScope

setVariable

public void setVariable(String variableName,
 Object value)

Specified by:

setVariable in interface VariableContainer

Specified by:

setVariable in interface 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 VariableScope

setVariableLocal

public Object setVariableLocal(String variableName,
 Object value)

Specified by:

setVariableLocal in interface 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 VariableScope

createVariableLocal

protected void createVariableLocal(String variableName,
 Object value)

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 VariableScope

removeVariableLocal

public void removeVariableLocal(String variableName)

Specified by:

removeVariableLocal in interface VariableScope

deleteVariableInstanceForExplicitUserCall

protected void deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance)

updateVariableInstance

protected void updateVariableInstance(VariableInstanceEntity variableInstance,
 Object value)

createVariableInstance

protected VariableInstanceEntity createVariableInstance(String variableName,
 Object value)

storeVariableLocal

protected boolean storeVariableLocal(String variableName)

setTransientVariablesLocal

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

Specified by:

setTransientVariablesLocal in interface VariableScope

setTransientVariableLocal

public void setTransientVariableLocal(String variableName,
 Object variableValue)

Specified by:

setTransientVariableLocal in interface VariableScope

setTransientVariables

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

Specified by:

setTransientVariables in interface VariableScope

setTransientVariable

public void setTransientVariable(String variableName,
 Object variableValue)

Specified by:

setTransientVariable in interface VariableContainer

Specified by:

setTransientVariable in interface VariableScope

getTransientVariableLocal

public Object getTransientVariableLocal(String variableName)

Specified by:

getTransientVariableLocal in interface VariableScope

getTransientVariablesLocal

public Map<String,Object> getTransientVariablesLocal()

Specified by:

getTransientVariablesLocal in interface VariableScope

getTransientVariable

public Object getTransientVariable(String variableName)

Specified by:

getTransientVariable in interface VariableScope

getTransientVariables

public Map<String,Object> getTransientVariables()

Specified by:

getTransientVariables in interface VariableScope

collectTransientVariables

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

removeTransientVariableLocal

public void removeTransientVariableLocal(String variableName)

Specified by:

removeTransientVariableLocal in interface VariableScope

removeTransientVariablesLocal

public void removeTransientVariablesLocal()

Specified by:

removeTransientVariablesLocal in interface VariableScope

removeTransientVariable

public void removeTransientVariable(String variableName)

Specified by:

removeTransientVariable in interface VariableScope

removeTransientVariables

public void removeTransientVariables()

Specified by:

removeTransientVariables in interface VariableScope

isPropagateToHistoricVariable

protected abstract boolean isPropagateToHistoricVariable()

Return whether changes to the variables are propagated to the history storage.

getVariableServiceConfiguration

protected abstract VariableServiceConfiguration getVariableServiceConfiguration()

getCachedElContext

public ELContext getCachedElContext()

setCachedElContext

public void setCachedElContext(ELContext cachedElContext)

getVariable

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

Specified by:

getVariable in interface VariableScope

getVariableLocal

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

Specified by:

getVariableLocal in interface VariableScope

isExpression

protected boolean isExpression(String variableName)