Top Description Fields Constructors Methods
org.eclipse.persistence.internal.indirection

public Class BasicIndirectionPolicy

extends IndirectionPolicy
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.indirection.ContainerIndirectionPolicy, org.eclipse.persistence.internal.indirection.ProxyIndirectionPolicy, org.eclipse.persistence.internal.indirection.WeavedObjectBasicIndirectionPolicy
Imports
java.rmi.server.ObjID, java.util.Map, org.eclipse.persistence.exceptions.DescriptorException, .IntegrityChecker, org.eclipse.persistence.indirection.ValueHolder, .ValueHolderInterface, org.eclipse.persistence.internal.descriptors.DescriptorIterator, org.eclipse.persistence.internal.helper.ClassConstants, org.eclipse.persistence.internal.identitymaps.CacheKey, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, .MergeManager, .UnitOfWorkImpl, org.eclipse.persistence.internal.sessions.remote.ObjectDescriptor, .RemoteSessionController, .RemoteUnitOfWork, .RemoteValueHolder, org.eclipse.persistence.mappings.DatabaseMapping.WriteType, org.eclipse.persistence.queries.ObjectLevelReadQuery, .ReadObjectQuery, .ReadQuery, org.eclipse.persistence.sessions.remote.DistributedSession

Purpose

: BasicIndirectionPolicy implements the behavior necessary for a a org.eclipse.persistence.mappings.ForeignReferenceMapping (or TransformationMapping) to use ValueHolders to delay the reading of objects from the database until they are actually needed.
Author
Mike Norman
Since
TOPLink/Java 2.5

Field Summary

Inherited from org.eclipse.persistence.internal.indirection.IndirectionPolicy:
mapping

Constructor Summary

AccessConstructor and Description
public
BasicIndirectionPolicy()

INTERNAL: Construct a new indirection policy.

Method Summary

Modifier and TypeMethod and Description
public Object
backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.backupCloneAttribute.

INTERNAL: Return a backup clone of the attribute.
public Object
buildIndirectObject(ValueHolderInterface<T> valueHolder)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.buildIndirectObject.

INTERNAL: This method can be used when an Indirection Object is required to be built from a provided ValueHolderInterface object.
public Object
cloneAttribute(Object attributeValue, Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession, boolean
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.
buildDirectlyFromRow
)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.cloneAttribute.

INTERNAL: Return a clone of the attribute.
public Object
extractPrimaryKeyForReferenceObject(Object referenceObject, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.extractPrimaryKeyForReferenceObject.

INTERNAL: Return the primary key for the reference object (i.e. the object object referenced by domainObject and specified by mapping).
public AbstractRecord
extractReferenceRow(Object referenceObject)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.extractReferenceRow.

INTERNAL: Return the reference row for the reference object.
public void
fixObjectReferences(Object object, Map<Object, ObjectDescriptor> objectDescriptors, Map<Object, Object> processedObjects, ObjectLevelReadQuery query, DistributedSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.fixObjectReferences.

INTERNAL: An object has been serialized from the server to the client.
public Object
getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getOriginalIndirectionObject.

INTERNAL: Return the original indirection object for a unit of work indirection object.
public Object
getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.getOriginalIndirectionObjectForMerge.

INTERNAL: Return the original indirection object for a unit of work indirection object.
public Object
getOriginalValueHolder(Object unitOfWorkIndirectionObject, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getOriginalValueHolder.

INTERNAL: Return the original valueHolder object.
public Object
getRealAttributeValueFromObject(Object object, Object attribute)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getRealAttributeValueFromObject.

INTERNAL: Return the "real" attribute value, as opposed to any wrapper.
public Object
getValueFromRemoteValueHolder(RemoteValueHolder<?> remoteValueHolder)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getValueFromRemoteValueHolder.

INTERNAL: Extract and return the appropriate value from the specified remote value holder.
public boolean
isAttributeValueFullyBuilt(Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.isAttributeValueFullyBuilt.

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.
public void
iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.iterateOnAttributeValue.

INTERNAL: Iterate over the specified attribute value,
public void
mergeRemoteValueHolder(Object clientSideDomainObject, Object serverSideDomainObject, MergeManager mergeManager)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.mergeRemoteValueHolder.

INTERNAL Replace the client value holder with the server value holder, after copying some of the settings from the client value holder.
public Object
nullValueFromRow()

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.nullValueFromRow.

INTERNAL: Return the null value of the appropriate attribute.
public boolean
objectIsEasilyInstantiated(Object object)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.objectIsEasilyInstantiated.

INTERNAL: Return whether the specified object can be instantiated without database access.
public boolean
objectIsInstantiated(Object object)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.objectIsInstantiated.

INTERNAL: Return whether the specified object is instantiated.
public void
reset(Object target)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.reset.

Reset the wrapper used to store the value.
public void
setRealAttributeValueInObject(Object target, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.setRealAttributeValueInObject.

INTERNAL: Set the value of the appropriate attribute of target to attributeValue.
public void
setSourceObject(Object sourceObject, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.setSourceObject.

INTERNAL: set the source object into QueryBasedValueHolder.
protected boolean
typeIsValid(Class<?> attributeType)

INTERNAL: Return whether the type is appropriate for the indirection policy.

public Object
validateAttributeOfInstantiatedObject(Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateAttributeOfInstantiatedObject.

INTERNAL: Verify that the value of the attribute within an instantiated object is of the appropriate type for the indirection policy.
public void
validateDeclaredAttributeType(Class<?> attributeType, IntegrityChecker checker)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateDeclaredAttributeType.

INTERNAL: Verify that attributeType is correct for the indirection policy.
public void
validateGetMethodReturnType(Class<?> returnType, IntegrityChecker checker)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateGetMethodReturnType.

INTERNAL: Verify that getter returnType is correct for the indirection policy.
public void
validateSetMethodParameterType(Class<?> parameterType, IntegrityChecker checker)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateSetMethodParameterType.

INTERNAL: Verify that setter parameterType is correct for the indirection policy.
public Object
valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromBatchQuery.

INTERNAL: Return the value to be stored in the object's attribute.
public Object
valueFromMethod(Object object, AbstractRecord row, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromMethod.

INTERNAL: Return the value to be stored in the object's attribute.
public Object
valueFromQuery(ReadQuery query, AbstractRecord row, Object sourceObject, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromQuery.

INTERNAL: Return the value to be stored in the object's attribute.
public Object
valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromQuery.

INTERNAL: Return the value to be stored in the object's attribute.
public Object
valueFromRow(Object object)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromRow.

INTERNAL: Return the value to be stored in the object's attribute.
Inherited from org.eclipse.persistence.internal.indirection.IndirectionPolicy:
buildCascadeQueryclonegetCollectionMappinggetForeignReferenceMappinggetMappinggetOneToOneMappinggetTransformationMappinginitializeinstantiateObjectisWeavedObjectBasicIndirectionPolicymergeClientIntoServerValueHolderobjectIsInstantiatedOrChangedsetMappingsetRealAttributeValueInObjectsetUseLazyInstantiationshouldUseLazyInstantiationusesIndirectionusesTransparentIndirectionvalidateContainerPolicyvalidateDeclaredAttributeTypeForCollectionvalidateGetMethodReturnTypeForCollectionvalidateSetMethodParameterTypeForCollection

Constructor Detail

BasicIndirectionPolicyback to summary
public BasicIndirectionPolicy()

INTERNAL: Construct a new indirection policy.

Method Detail

backupCloneAttributeback to summary
public Object backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.backupCloneAttribute.

INTERNAL: Return a backup clone of the attribute.

Annotations
@Override
buildIndirectObjectback to summary
public Object buildIndirectObject(ValueHolderInterface<T> valueHolder)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.buildIndirectObject.

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.

Annotations
@Override
cloneAttributeback to summary
public Object cloneAttribute(Object attributeValue, Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession, boolean buildDirectlyFromRow)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.cloneAttribute.

INTERNAL: Return a clone of the attribute.

Parameters
buildDirectlyFromRow:boolean

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.

Annotations
@Override
extractPrimaryKeyForReferenceObjectback to summary
public Object extractPrimaryKeyForReferenceObject(Object referenceObject, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.extractPrimaryKeyForReferenceObject.

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.

Annotations
@Override
extractReferenceRowback to summary
public AbstractRecord extractReferenceRow(Object referenceObject)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.extractReferenceRow.

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.

Annotations
@Override
fixObjectReferencesback to summary
public void fixObjectReferences(Object object, Map<Object, ObjectDescriptor> objectDescriptors, Map<Object, Object> processedObjects, ObjectLevelReadQuery query, DistributedSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.fixObjectReferences.

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.

Annotations
@Override
getOriginalIndirectionObjectback to summary
public Object getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getOriginalIndirectionObject.

INTERNAL: Return the original indirection object for a unit of work indirection object. This is used when building a new object from the unit of work when the original fell out of the cache.

Annotations
@Override
getOriginalIndirectionObjectForMergeback to summary
public Object getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.getOriginalIndirectionObjectForMerge.

INTERNAL: Return the original indirection object for a unit of work indirection object.

Annotations
@Override
getOriginalValueHolderback to summary
public Object getOriginalValueHolder(Object unitOfWorkIndirectionObject, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getOriginalValueHolder.

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.

Annotations
@Override
getRealAttributeValueFromObjectback to summary
public Object getRealAttributeValueFromObject(Object object, Object attribute)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getRealAttributeValueFromObject.

INTERNAL: Return the "real" attribute value, as opposed to any wrapper. This will trigger the wrapper to instantiate the value.

Annotations
@Override
getValueFromRemoteValueHolderback to summary
public Object getValueFromRemoteValueHolder(RemoteValueHolder<?> remoteValueHolder)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.getValueFromRemoteValueHolder.

INTERNAL: Extract and return the appropriate value from the specified remote value holder.

Annotations
@Override
isAttributeValueFullyBuiltback to summary
public boolean isAttributeValueFullyBuilt(Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.isAttributeValueFullyBuilt.

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

Annotations
@Override
See Also
validateAttributeOfInstantiatedObject(Object attributeValue)
iterateOnAttributeValueback to summary
public void iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.iterateOnAttributeValue.

INTERNAL: Iterate over the specified attribute value,

Annotations
@Override
mergeRemoteValueHolderback to summary
public void mergeRemoteValueHolder(Object clientSideDomainObject, Object serverSideDomainObject, MergeManager mergeManager)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.mergeRemoteValueHolder.

INTERNAL Replace the client value holder with the server value holder, after copying some of the settings from the client value holder.

Annotations
@Override
nullValueFromRowback to summary
public Object nullValueFromRow()

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.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. In this case, return an empty ValueHolder.

Annotations
@Override
objectIsEasilyInstantiatedback to summary
public boolean objectIsEasilyInstantiated(Object object)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.objectIsEasilyInstantiated.

INTERNAL: Return whether the specified object can be instantiated without database access.

Annotations
@Override
objectIsInstantiatedback to summary
public boolean objectIsInstantiated(Object object)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.objectIsInstantiated.

INTERNAL: Return whether the specified object is instantiated.

Annotations
@Override
resetback to summary
public void reset(Object target)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.reset.

Reset the wrapper used to store the value.

Annotations
@Override
setRealAttributeValueInObjectback to summary
public void setRealAttributeValueInObject(Object target, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.setRealAttributeValueInObject.

INTERNAL: Set the value of the appropriate attribute of target to attributeValue. In this case, place the value inside the target's ValueHolder.

Annotations
@Override
@SuppressWarnings:unchecked
setSourceObjectback to summary
public void setSourceObject(Object sourceObject, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.setSourceObject.

INTERNAL: set the source object into QueryBasedValueHolder. Used only by transparent indirection.

Annotations
@Override
@SuppressWarnings:unchecked
typeIsValidback to summary
protected boolean typeIsValid(Class<?> attributeType)

INTERNAL: Return whether the type is appropriate for the indirection policy. In this case, the attribute type MUST be ValueHolderInterface.

validateAttributeOfInstantiatedObjectback to summary
public Object validateAttributeOfInstantiatedObject(Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateAttributeOfInstantiatedObject.

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 a ValueHolderInterface. If the value is null return a new indirection object to be used for the attribute.

Annotations
@Override
validateDeclaredAttributeTypeback to summary
public void validateDeclaredAttributeType(Class<?> attributeType, IntegrityChecker checker) throws DescriptorException

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateDeclaredAttributeType.

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 ValueHolderInterface.

Annotations
@Override
validateGetMethodReturnTypeback to summary
public void validateGetMethodReturnType(Class<?> returnType, IntegrityChecker checker) throws DescriptorException

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateGetMethodReturnType.

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 return type MUST be ValueHolderInterface.

Annotations
@Override
validateSetMethodParameterTypeback to summary
public void validateSetMethodParameterType(Class<?> parameterType, IntegrityChecker checker) throws DescriptorException

Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.validateSetMethodParameterType.

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 parameter type MUST be ValueHolderInterface.

Annotations
@Override
valueFromBatchQueryback to summary
public Object valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromBatchQuery.

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 a ValueHolder for later invocation.

Annotations
@Override
valueFromMethodback to summary
public Object valueFromMethod(Object object, AbstractRecord row, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromMethod.

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. In this case, wrap the row in a ValueHolder for later use.

Annotations
@Override
valueFromQueryback to summary
public Object valueFromQuery(ReadQuery query, AbstractRecord row, Object sourceObject, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromQuery.

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 a ValueHolder for later invocation.

Annotations
@Override
valueFromQueryback to summary
public Object valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromQuery.

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 a ValueHolder for later invocation.

Annotations
@Override
valueFromRowback to summary
public Object valueFromRow(Object object)

Implements abstract org.eclipse.persistence.internal.indirection.IndirectionPolicy.valueFromRow.

INTERNAL: Return the value to be stored in the object's attribute. This value is determined by the row. In this case, simply wrap the object in a ValueHolder.

Annotations
@Override