Class CacheBasedValueHolder<T>
- All Implemented Interfaces:
Serializable
,Cloneable
,ValueHolderInterface<T>
,WeavedAttributeValueHolderInterface<T>
Purpose: In certain cases the contents of a relationship may be retrievable from a cache. This ValueHolder instance provides the mechanism to store a cached relationship and to load that relationship from a cache. This functionality requires that the persistent identities of the targets can be collected as database type foreign key queries are unavailable.
- Since:
- EclipseLink 1.1
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected ForeignReferenceMapping
protected Object[]
protected boolean
Setting to force the instantiation of the Collection on modificationFields inherited from class org.eclipse.persistence.internal.indirection.DatabaseValueHolder
isCoordinatedWithProperty, isInstantiated, row, session, value
Fields inherited from interface org.eclipse.persistence.indirection.ValueHolderInterface
shouldToStringInstantiate
-
Constructor Summary
ConstructorDescriptionCacheBasedValueHolder
(Object[] pks, AbstractRecord foreignKeys, AbstractSession session, ForeignReferenceMapping mapping) -
Method Summary
Modifier and TypeMethodDescriptionObject[]
getValue
(UnitOfWorkImpl uow) Process against the UOW and attempt to load a local copy before going to the shared cache If null is returned then the calling UOW will instantiate as normal.protected T
Instantiate the object.protected T
instantiate
(AbstractSession localSession) instantiateForUnitOfWorkValueHolder
(UnitOfWorkValueHolder<T> unitOfWorkValueHolder) Triggers UnitOfWork valueholders directly without triggering the wrapped valueholder (this).boolean
Answers if this valueholder is a pessimistic locking one.void
setShouldAllowInstantiationDeferral
(boolean shouldAllowInstantiationDeferral) Set if instantiation deferral on modification should be available.boolean
INTERNAL: Return if add/remove should trigger instantiation or avoid.Methods inherited from class org.eclipse.persistence.internal.indirection.DatabaseValueHolder
clone, getRow, getSession, getValue, getWrappedValueHolder, isCoordinatedWithProperty, isEasilyInstantiated, isInstantiated, isNewlyWeavedValueHolder, isSerializedRemoteUnitOfWorkValueHolder, isTransactionalValueHolder, postInstantiate, privilegedSetValue, releaseWrappedValueHolder, resetFields, setInstantiated, setIsCoordinatedWithProperty, setIsNewlyWeavedValueHolder, setRow, setSession, setUninstantiated, setValue, toString
-
Field Details
-
mapping
-
references
-
shouldAllowInstantiationDeferral
protected boolean shouldAllowInstantiationDeferralSetting to force the instantiation of the Collection on modification
-
-
Constructor Details
-
CacheBasedValueHolder
public CacheBasedValueHolder(Object[] pks, AbstractRecord foreignKeys, AbstractSession session, ForeignReferenceMapping mapping)
-
-
Method Details
-
getCachedPKs
-
getValue
Process against the UOW and attempt to load a local copy before going to the shared cache If null is returned then the calling UOW will instantiate as normal.- Overrides:
getValue
in classDatabaseValueHolder<T>
-
instantiate
Description copied from class:DatabaseValueHolder
Instantiate the object.- Specified by:
instantiate
in classDatabaseValueHolder<T>
- Throws:
DatabaseException
-
instantiate
- Throws:
DatabaseException
-
instantiateForUnitOfWorkValueHolder
Triggers UnitOfWork valueholders directly without triggering the wrapped valueholder (this).When in transaction and/or for pessimistic locking the UnitOfWorkValueHolder needs to be triggered directly without triggering the wrapped valueholder. However only the wrapped valueholder knows how to trigger the indirection, i.e. it may be a batchValueHolder, and it stores all the info like the row and the query. Note: This method is not thread-safe. It must be used in a synchronized manner
- Specified by:
instantiateForUnitOfWorkValueHolder
in classDatabaseValueHolder<T>
-
isPessimisticLockingValueHolder
public boolean isPessimisticLockingValueHolder()Description copied from class:DatabaseValueHolder
Answers if this valueholder is a pessimistic locking one. Such valueholders are special in that they can be triggered multiple times by different UnitsOfWork. Each time a lock query will be issued. Hence even if instantiated it may have to be instantiated again, and once instantiated all fields can not be reset. Note: Implementations of this method are not necessarily thread-safe. They must be used in a synchronizaed manner- Specified by:
isPessimisticLockingValueHolder
in classDatabaseValueHolder<T>
-
setShouldAllowInstantiationDeferral
public void setShouldAllowInstantiationDeferral(boolean shouldAllowInstantiationDeferral) Set if instantiation deferral on modification should be available. -
shouldAllowInstantiationDeferral
public boolean shouldAllowInstantiationDeferral()INTERNAL: Return if add/remove should trigger instantiation or avoid. Current instantiation is avoided is using change tracking.- Specified by:
shouldAllowInstantiationDeferral
in interfaceWeavedAttributeValueHolderInterface<T>
- Overrides:
shouldAllowInstantiationDeferral
in classDatabaseValueHolder<T>
-