Class TransparentIndirectionPolicy
- java.lang.Object
-
- org.eclipse.persistence.internal.indirection.IndirectionPolicy
-
- org.eclipse.persistence.internal.indirection.TransparentIndirectionPolicy
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class TransparentIndirectionPolicy extends IndirectionPolicy
Purpose
: TransparentIndirectionPolicy implements the behavior necessary for a a CollectionMapping to use IndirectContainers to delay the reading of objects from the database until they are actually needed.- Since:
- TOPLink/Java 2.5
- Author:
- Big Country
- See Also:
CollectionMapping
,IndirectContainer
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected ContainerPolicy
containerPolicy
PERF: Cache the mappings container policy.protected static Integer
defaultContainerSize
protected Boolean
useLazyInstantiation
IndirectList and IndirectSet can be configured not to instantiate the list from the database when you add and remove from them.-
Fields inherited from class org.eclipse.persistence.internal.indirection.IndirectionPolicy
mapping
-
-
Constructor Summary
Constructors Constructor Description TransparentIndirectionPolicy()
INTERNAL: Construct a new indirection policy.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork)
INTERNAL: Return a backup clone of the attribute.protected Object
buildBackupClone(IndirectContainer container)
INTERNAL: Return a backup clone of a clone container that has not been read from the database yet.protected IndirectContainer
buildIndirectContainer()
Construct and return an instance of the specified indirect container class.protected Object
buildIndirectContainer(ValueHolderInterface valueHolder)
Return a new IndirectContainer with the specified value holder.Object
buildIndirectObject(ValueHolderInterface valueHolder)
INTERNAL: This method can be used when an Indirection Object is required to be built from a provided ValueHolderInterface object.Object
cloneAttribute(Object attributeValue, Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession, boolean buildDirectlyFromRow)
Return a clone of the attribute.protected boolean
containerPolicyIsValid()
INTERNAL: Return whether the container policy is valid for the indirection policy.Object
extractPrimaryKeyForReferenceObject(Object referenceObject, AbstractSession session)
INTERNAL: Return the primary key for the reference object (i.e.AbstractRecord
extractReferenceRow(Object referenceObject)
INTERNAL: Return the reference row for the reference object.void
fixObjectReferences(Object object, Map objectDescriptors, Map processedObjects, ObjectLevelReadQuery query, DistributedSession session)
INTERNAL: An object has been serialized from the server to the client.protected Class
getContainerClass()
INTERNAL: Return the container class for the mapping.protected ContainerPolicy
getContainerPolicy()
INTERNAL: Return the container policy for the mapping.protected static int
getDefaultContainerSize()
INTERNAL: Return the the size to of container to create.Object
getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session)
INTERNAL: Return the original indirection object for a unit of work indirection object.Object
getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session)
INTERNAL: Return the original indirection object for a unit of work indirection object.Object
getOriginalValueHolder(Object unitOfWorkIndirectionObject, AbstractSession session)
INTERNAL: Return the original valueHolder object.Object
getRealAttributeValueFromObject(Object object, Object attribute)
INTERNAL: Return the "real" attribute value, as opposed to any wrapper.Boolean
getUseLazyInstantiation()
Object
getValueFromRemoteValueHolder(RemoteValueHolder remoteValueHolder)
INTERNAL: Extract and return the appropriate value from the specified remote value holder.void
instantiateObject(Object object, Object attribute)
INTERNAL: Trigger the instantiation of the value.boolean
isAttributeValueFullyBuilt(Object attributeValue)
INTERNAL: The method validateAttributeOfInstantiatedObject(Object attributeValue) fixes the value of the attributeValue in cases where it is null and indirection requires that it contain some specific data structure.void
iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue)
INTERNAL: Iterate over the specified attribute value.void
mergeRemoteValueHolder(Object clientSideDomainObject, Object serverSideDomainObject, MergeManager mergeManager)
INTERNAL Replace the client value holder with the server value holder, after copying some of the settings from the client value holder.Object
nullValueFromRow()
INTERNAL: Return the null value of the appropriate attribute.boolean
objectIsEasilyInstantiated(Object object)
INTERNAL: Return whether the specified object can be instantiated without database access.boolean
objectIsInstantiated(Object object)
INTERNAL: Return whether the specified object is instantiated.boolean
objectIsInstantiatedOrChanged(Object object)
INTERNAL: Return whether the specified object is instantiated, or if it has changes.static void
setDefaultContainerSize(int defaultSize)
ADVANCED: Set the size to of container to create.void
setRealAttributeValueInObject(Object target, Object attributeValue)
INTERNAL: Set the value of the appropriate attribute of target to attributeValue.void
setSourceObject(Object sourceObject, Object attributeValue)
INTERNAL: set the source object into QueryBasedValueHolder.void
setUseLazyInstantiation(Boolean useLazyInstantiation)
ADVANCED: IndirectList and IndirectSet can be configured not to instantiate the list from the database when you add and remove from them.Boolean
shouldUseLazyInstantiation()
ADVANCED: IndirectList and IndirectSet can be configured not to instantiate the list from the database when you add and remove from them.protected boolean
typeIsValid(Class declaredType)
INTERNAL: Return whether the type is appropriate for the indirection policy.boolean
usesTransparentIndirection()
INTERNAL: Return whether the indirection policy uses transparent indirection.Object
validateAttributeOfInstantiatedObject(Object attributeValue)
INTERNAL: Verify that the value of the attribute within an instantiated object is of the appropriate type for the indirection policy.void
validateContainerPolicy(IntegrityChecker checker)
INTERNAL: Verify that the container policy is compatible with the indirection policy.void
validateDeclaredAttributeType(Class attributeType, IntegrityChecker checker)
INTERNAL: Verify that attributeType is correct for the indirection policy.void
validateGetMethodReturnType(Class returnType, IntegrityChecker checker)
INTERNAL: Verify that getter returnType is correct for the indirection policy.void
validateSetMethodParameterType(Class parameterType, IntegrityChecker checker)
INTERNAL: Verify that setter parameterType is correct for the indirection policy.protected String
validTypeName()
INTERNAL: Return the type that is appropriate for the indirection policy.Object
valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)
INTERNAL: Return the value to be stored in the object's attribute.Object
valueFromMethod(Object object, AbstractRecord row, AbstractSession session)
INTERNAL: Return the value to be stored in the object's attribute.Object
valueFromQuery(ReadQuery query, AbstractRecord row, Object object, AbstractSession session)
INTERNAL: A combination of valueFromQuery and valueFromRow(object).Object
valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session)
INTERNAL: Return the value to be stored in the object's attribute.Object
valueFromRow(Object object)
INTERNAL: Return the value to be stored in the object's attribute.-
Methods inherited from class org.eclipse.persistence.internal.indirection.IndirectionPolicy
buildCascadeQuery, clone, getCollectionMapping, getForeignReferenceMapping, getMapping, getOneToOneMapping, getTransformationMapping, initialize, isWeavedObjectBasicIndirectionPolicy, mergeClientIntoServerValueHolder, reset, setMapping, setRealAttributeValueInObject, usesIndirection, validateDeclaredAttributeTypeForCollection, validateGetMethodReturnTypeForCollection, validateSetMethodParameterTypeForCollection
-
-
-
-
Field Detail
-
defaultContainerSize
protected static Integer defaultContainerSize
-
containerPolicy
protected ContainerPolicy containerPolicy
PERF: Cache the mappings container policy.
-
useLazyInstantiation
protected Boolean useLazyInstantiation
IndirectList and IndirectSet can be configured not to instantiate the list from the database when you add and remove from them. IndirectList defaults to this behavior. When Set to true, the collection associated with this TransparentIndirection will be setup so as not to instantiate for adds and removes. The weakness of this setting for an IndirectSet is that when the set is not instantiated, if a duplicate element is added, it will not be detected until commit time.
-
-
Method Detail
-
backupCloneAttribute
public Object backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork)
INTERNAL: Return a backup clone of the attribute.- Overrides:
backupCloneAttribute
in classIndirectionPolicy
-
buildBackupClone
protected Object buildBackupClone(IndirectContainer container)
INTERNAL: Return a backup clone of a clone container that has not been read from the database yet. This is used by the indirection policy to hook together a UOW clone with its backup clone - only when the clone (the working copy returned to the user) instantiates its contents from the database will these contents be copied to the backup clone.
-
buildIndirectContainer
protected IndirectContainer buildIndirectContainer()
Construct and return an instance of the specified indirect container class.
-
buildIndirectContainer
protected Object buildIndirectContainer(ValueHolderInterface valueHolder)
Return a new IndirectContainer with the specified value holder.
-
buildIndirectObject
public Object buildIndirectObject(ValueHolderInterface valueHolder)
INTERNAL: This method can be used when an Indirection Object is required to be built from a provided ValueHolderInterface object. This may be used for custom value holder types. Certain policies like the TransparentIndirectionPolicy may wrap the valueholder in another object.- Specified by:
buildIndirectObject
in classIndirectionPolicy
-
cloneAttribute
public Object cloneAttribute(Object attributeValue, Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession, boolean buildDirectlyFromRow)
Return a clone of the attribute.- Specified by:
cloneAttribute
in classIndirectionPolicy
- Parameters:
buildDirectlyFromRow
- indicates that we are building the clone directly from a row as opposed to building the original from the row, putting it in the shared cache, and then cloning the original.
-
containerPolicyIsValid
protected boolean containerPolicyIsValid()
INTERNAL: Return whether the container policy is valid for the indirection policy. In this case, the container policy MUST be configured for an IndirectContainer.
-
extractPrimaryKeyForReferenceObject
public Object extractPrimaryKeyForReferenceObject(Object referenceObject, AbstractSession session)
INTERNAL: Return the primary key for the reference object (i.e. the object object referenced by domainObject and specified by mapping). This key will be used by a RemoteValueHolder. OneToOneMappings should not be using transparent direction.- Overrides:
extractPrimaryKeyForReferenceObject
in classIndirectionPolicy
-
extractReferenceRow
public AbstractRecord extractReferenceRow(Object referenceObject)
INTERNAL: Return the reference row for the reference object. This allows the new row to be built without instantiating the reference object. Return null if the object has already been instantiated.- Specified by:
extractReferenceRow
in classIndirectionPolicy
-
fixObjectReferences
public void fixObjectReferences(Object object, Map objectDescriptors, Map processedObjects, ObjectLevelReadQuery query, DistributedSession session)
INTERNAL: An object has been serialized from the server to the client. Replace the transient attributes of the remote value holders with client-side objects.- Specified by:
fixObjectReferences
in classIndirectionPolicy
-
getContainerClass
protected Class getContainerClass()
INTERNAL: Return the container class for the mapping.
-
getContainerPolicy
protected ContainerPolicy getContainerPolicy()
INTERNAL: Return the container policy for the mapping.
-
getDefaultContainerSize
protected static int getDefaultContainerSize()
INTERNAL: Return the the size to of container to create. Default to using default constructor.
-
getOriginalIndirectionObject
public Object getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session)
INTERNAL: Return the original indirection object for a unit of work indirection object.- Specified by:
getOriginalIndirectionObject
in classIndirectionPolicy
-
getOriginalIndirectionObjectForMerge
public Object getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session)
INTERNAL: Return the original indirection object for a unit of work indirection object.- Overrides:
getOriginalIndirectionObjectForMerge
in classIndirectionPolicy
-
getOriginalValueHolder
public Object getOriginalValueHolder(Object unitOfWorkIndirectionObject, AbstractSession session)
INTERNAL: Return the original valueHolder object. Access to the underlying valueholder may be required when serializing the valueholder or converting the valueHolder to another type.- Specified by:
getOriginalValueHolder
in classIndirectionPolicy
-
getRealAttributeValueFromObject
public Object getRealAttributeValueFromObject(Object object, Object attribute)
INTERNAL: Return the "real" attribute value, as opposed to any wrapper. This will trigger the wrapper to instantiate the value.- Specified by:
getRealAttributeValueFromObject
in classIndirectionPolicy
-
instantiateObject
public void instantiateObject(Object object, Object attribute)
INTERNAL: Trigger the instantiation of the value.- Overrides:
instantiateObject
in classIndirectionPolicy
-
isAttributeValueFullyBuilt
public boolean isAttributeValueFullyBuilt(Object attributeValue)
INTERNAL: The method validateAttributeOfInstantiatedObject(Object attributeValue) fixes the value of the attributeValue in cases where it is null and indirection requires that it contain some specific data structure. Return whether this will happen. This method is used to help determine if indirection has been triggered- Overrides:
isAttributeValueFullyBuilt
in classIndirectionPolicy
- Parameters:
attributeValue
-- Returns:
- See Also:
validateAttributeOfInstantiatedObject(java.lang.Object)
-
getUseLazyInstantiation
public Boolean getUseLazyInstantiation()
-
getValueFromRemoteValueHolder
public Object getValueFromRemoteValueHolder(RemoteValueHolder remoteValueHolder)
INTERNAL: Extract and return the appropriate value from the specified remote value holder.- Specified by:
getValueFromRemoteValueHolder
in classIndirectionPolicy
-
setRealAttributeValueInObject
public void setRealAttributeValueInObject(Object target, Object attributeValue)
INTERNAL: Set the value of the appropriate attribute of target to attributeValue. If the Target has yet to be instantiated then we need to instantiate the target to ensure that the backup clone is instantiated for comparison.- Overrides:
setRealAttributeValueInObject
in classIndirectionPolicy
-
setSourceObject
public void setSourceObject(Object sourceObject, Object attributeValue)
INTERNAL: set the source object into QueryBasedValueHolder.- Overrides:
setSourceObject
in classIndirectionPolicy
-
setUseLazyInstantiation
public void setUseLazyInstantiation(Boolean useLazyInstantiation)
ADVANCED: IndirectList and IndirectSet can be configured not to instantiate the list from the database when you add and remove from them. IndirectList defaults to this behavior. When Set to true, the collection associated with this TransparentIndirection will be setup so as not to instantiate for adds and removes. The weakness of this setting for an IndirectSet is that when the set is not instantiated, if a duplicate element is added, it will not be detected until commit time.- Overrides:
setUseLazyInstantiation
in classIndirectionPolicy
-
shouldUseLazyInstantiation
public Boolean shouldUseLazyInstantiation()
ADVANCED: IndirectList and IndirectSet can be configured not to instantiate the list from the database when you add and remove from them. IndirectList defaults to this behavior. When Set to true, the collection associated with this TransparentIndirection will be setup so as not to instantiate for adds and removes. The weakness of this setting for an IndirectSet is that when the set is not instantiated, if a duplicate element is added, it will not be detected until commit time.- Overrides:
shouldUseLazyInstantiation
in classIndirectionPolicy
-
iterateOnAttributeValue
public void iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue)
INTERNAL: Iterate over the specified attribute value.- Overrides:
iterateOnAttributeValue
in classIndirectionPolicy
-
mergeRemoteValueHolder
public void mergeRemoteValueHolder(Object clientSideDomainObject, Object serverSideDomainObject, MergeManager mergeManager)
INTERNAL Replace the client value holder with the server value holder, after copying some of the settings from the client value holder.- Specified by:
mergeRemoteValueHolder
in classIndirectionPolicy
-
nullValueFromRow
public Object nullValueFromRow()
INTERNAL: Return the null value of the appropriate attribute. That is, the field from the database is NULL, return what should be placed in the object's attribute as a result. OneToOneMappings should not be using transparent direction.- Specified by:
nullValueFromRow
in classIndirectionPolicy
-
objectIsInstantiated
public boolean objectIsInstantiated(Object object)
INTERNAL: Return whether the specified object is instantiated.- Specified by:
objectIsInstantiated
in classIndirectionPolicy
-
objectIsEasilyInstantiated
public boolean objectIsEasilyInstantiated(Object object)
INTERNAL: Return whether the specified object can be instantiated without database access.- Specified by:
objectIsEasilyInstantiated
in classIndirectionPolicy
-
objectIsInstantiatedOrChanged
public boolean objectIsInstantiatedOrChanged(Object object)
INTERNAL: Return whether the specified object is instantiated, or if it has changes.- Overrides:
objectIsInstantiatedOrChanged
in classIndirectionPolicy
-
setDefaultContainerSize
public static void setDefaultContainerSize(int defaultSize)
ADVANCED: Set the size to of container to create. Default to using default constructor.
-
typeIsValid
protected boolean typeIsValid(Class declaredType)
INTERNAL: Return whether the type is appropriate for the indirection policy. In this case, the attribute type MUST be compatible with the one specified by the ContainerPolicy (i.e. either the container policy class is a subclass of the declared type [jdk1.1] or the container policy class implements the declared interface [jdk1.2]).
-
usesTransparentIndirection
public boolean usesTransparentIndirection()
INTERNAL: Return whether the indirection policy uses transparent indirection.- Overrides:
usesTransparentIndirection
in classIndirectionPolicy
-
validateAttributeOfInstantiatedObject
public Object validateAttributeOfInstantiatedObject(Object attributeValue)
INTERNAL: Verify that the value of the attribute within an instantiated object is of the appropriate type for the indirection policy. In this case, the attribute must be non-null and it must be at least a subclass or implementor of the container type. If the value is null return a new indirection object to be used for the attribute.- Overrides:
validateAttributeOfInstantiatedObject
in classIndirectionPolicy
-
validateContainerPolicy
public void validateContainerPolicy(IntegrityChecker checker) throws DescriptorException
INTERNAL: Verify that the container policy is compatible with the indirection policy. If it is incorrect, add an exception to the integrity checker.- Overrides:
validateContainerPolicy
in classIndirectionPolicy
- Throws:
DescriptorException
-
validateDeclaredAttributeType
public void validateDeclaredAttributeType(Class attributeType, IntegrityChecker checker) throws DescriptorException
INTERNAL: Verify that attributeType is correct for the indirection policy. If it is incorrect, add an exception to the integrity checker. In this case, the attribute type MUST be compatible with the one specified by the ContainerPolicy.- Overrides:
validateDeclaredAttributeType
in classIndirectionPolicy
- Throws:
DescriptorException
-
validateGetMethodReturnType
public void validateGetMethodReturnType(Class returnType, IntegrityChecker checker) throws DescriptorException
INTERNAL: Verify that getter returnType is correct for the indirection policy. If it is incorrect, add an exception to the integrity checker. In this case, the attribute type MUST be compatible with the one specified by the ContainerPolicy.- Overrides:
validateGetMethodReturnType
in classIndirectionPolicy
- Throws:
DescriptorException
-
validateSetMethodParameterType
public void validateSetMethodParameterType(Class parameterType, IntegrityChecker checker) throws DescriptorException
INTERNAL: Verify that setter parameterType is correct for the indirection policy. If it is incorrect, add an exception to the integrity checker. In this case, the attribute type MUST be compatible with the one specified by the ContainerPolicy.- Overrides:
validateSetMethodParameterType
in classIndirectionPolicy
- Throws:
DescriptorException
-
validTypeName
protected String validTypeName()
INTERNAL: Return the type that is appropriate for the indirection policy.
-
valueFromBatchQuery
public Object valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)
INTERNAL: Return the value to be stored in the object's attribute. This value is determined by the batchQuery. In this case, wrap the query in an IndirectContainer for later invocation.- Specified by:
valueFromBatchQuery
in classIndirectionPolicy
-
valueFromMethod
public Object valueFromMethod(Object object, AbstractRecord row, AbstractSession session)
INTERNAL: Return the value to be stored in the object's attribute. This value is determined by invoking the appropriate method on the object and passing it the row and session. TransformationMappings should not be using transparent direction.- Specified by:
valueFromMethod
in classIndirectionPolicy
-
valueFromQuery
public Object valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session)
INTERNAL: Return the value to be stored in the object's attribute. This value is determined by the query. In this case, wrap the query in an IndirectContainer for later invocation.- Specified by:
valueFromQuery
in classIndirectionPolicy
-
valueFromQuery
public Object valueFromQuery(ReadQuery query, AbstractRecord row, Object object, AbstractSession session)
INTERNAL: A combination of valueFromQuery and valueFromRow(object). Sometimes the attribute is known (joining) but we still need to hang on to the query (pessimistic locking).- Specified by:
valueFromQuery
in classIndirectionPolicy
-
valueFromRow
public Object valueFromRow(Object object)
INTERNAL: Return the value to be stored in the object's attribute. This allows wrapping of the real value, none is required for transparent.- Specified by:
valueFromRow
in classIndirectionPolicy
-
-