org.eclipse.persistence.internal.indirection

Class ContainerIndirectionPolicy

java.lang.Object

org.eclipse.persistence.internal.indirection.IndirectionPolicy

org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy

org.eclipse.persistence.internal.indirection.ContainerIndirectionPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ContainerIndirectionPolicy
extends BasicIndirectionPolicy

Purpose: Provide ability for developers to wrap ValueHolders (Basic Indirection)

Responsibilities:

• Wrap & un-wrap a ValueHolder within an IndirectContainer
• Reflectivly instantiate the containers as required

Since:

2.5.0.5

Author:

Doug Clarke (TOP)

See Also:

IndirectContainer, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContainerIndirectionPolicy() INTERNAL: Construct a new indirection policy.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	backupCloneAttribute(java.lang.Object attributeValue, java.lang.Object clone, java.lang.Object backup, UnitOfWorkImpl unitOfWork) INTERNAL: Return a backup clone of the attribute.
java.lang.Object	buildIndirectObject(ValueHolderInterface valueHolder) INTERNAL: This method can be used when an Indirection Object is required to be built from a provided ValueHolderInterface object.
java.lang.Object	cloneAttribute(java.lang.Object attributeValue, java.lang.Object original, CacheKey cacheKey, java.lang.Object clone, java.lang.Integer refreshCascade, AbstractSession cloningSession, boolean buildDirectlyFromRow) INTERNAL: Return a clone of the attribute.
AbstractRecord	extractReferenceRow(java.lang.Object referenceObject) INTERNAL: Return the reference row for the reference object.
java.lang.Class	getContainerClass() Returns the Container class which implements IndirectContainer.
java.lang.String	getContainerClassName() INTERNAL: Used by MW.
java.lang.Object	getOriginalIndirectionObject(java.lang.Object unitOfWorkIndirectionObject, AbstractSession session) INTERNAL: Return the original indirection object for a unit of work indirection object.
java.lang.Object	getOriginalIndirectionObjectForMerge(java.lang.Object unitOfWorkIndirectionObject, AbstractSession session) INTERNAL: Return the original indirection object for a unit of work indirection object.
java.lang.Object	getRealAttributeValueFromObject(java.lang.Object object, java.lang.Object attribute) INTERNAL: Return the "real" attribute value, as opposed to any wrapper.
void	initialize() INTERNAL: Ensure the container class implements IndirectContainer and that it has a constructor which can be used.
boolean	isAttributeValueFullyBuilt(java.lang.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, java.lang.Object attributeValue) INTERNAL: Iterate over the specified attribute value,
java.lang.Object	nullValueFromRow() INTERNAL: Return the null value of the appropriate attribute.
boolean	objectIsEasilyInstantiated(java.lang.Object object) INTERNAL: Return whether the specified object can be instantiated without database access.
boolean	objectIsInstantiated(java.lang.Object object) INTERNAL: Return whether the specified object is instantiated.
void	reset(java.lang.Object target) Reset the wrapper used to store the value.
void	setContainerClass(java.lang.Class containerClass) Sets the Container class which implements IndirectContainer
void	setContainterClassName(java.lang.String containerClassName) Set the container classname for the MW
void	setRealAttributeValueInObject(java.lang.Object target, java.lang.Object attributeValue) INTERNAL: Set the value of the appropriate attribute of target to attributeValue.
java.lang.Object	validateAttributeOfInstantiatedObject(java.lang.Object attributeValue) INTERNAL: Verify that the value of the attribute within an instantiated object is of the appropriate type for the indirection policy.
java.lang.Object	valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey) INTERNAL: Return the value to be stored in the object's attribute.
java.lang.Object	valueFromMethod(java.lang.Object object, AbstractRecord row, AbstractSession session) INTERNAL: Return the value to be stored in the object's attribute.
java.lang.Object	valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session) INTERNAL: Return the value to be stored in the object's attribute.
java.lang.Object	valueFromRow(java.lang.Object object) INTERNAL: Return the value to be stored in the object's attribute.

Methods inherited from class org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy

extractPrimaryKeyForReferenceObject, fixObjectReferences, getOriginalValueHolder, getValueFromRemoteValueHolder, mergeRemoteValueHolder, setSourceObject, validateDeclaredAttributeType, validateGetMethodReturnType, validateSetMethodParameterType, valueFromQuery

Methods inherited from class org.eclipse.persistence.internal.indirection.IndirectionPolicy

clone, getMapping, instantiateObject, isWeavedObjectBasicIndirectionPolicy, objectIsInstantiatedOrChanged, setMapping, setRealAttributeValueInObject, setUseLazyInstantiation, shouldUseLazyInstantiation, usesIndirection, usesTransparentIndirection, validateContainerPolicy, validateDeclaredAttributeTypeForCollection, validateGetMethodReturnTypeForCollection, validateSetMethodParameterTypeForCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerIndirectionPolicy

public ContainerIndirectionPolicy()

INTERNAL: Construct a new indirection policy.

Method Detail

backupCloneAttribute

public java.lang.Object backupCloneAttribute(java.lang.Object attributeValue,
                                             java.lang.Object clone,
                                             java.lang.Object backup,
                                             UnitOfWorkImpl unitOfWork)

INTERNAL: Return a backup clone of the attribute.

Overrides:

backupCloneAttribute in class BasicIndirectionPolicy

buildIndirectObject

public java.lang.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.

Overrides:

buildIndirectObject in class BasicIndirectionPolicy

cloneAttribute

public java.lang.Object cloneAttribute(java.lang.Object attributeValue,
                                       java.lang.Object original,
                                       CacheKey cacheKey,
                                       java.lang.Object clone,
                                       java.lang.Integer refreshCascade,
                                       AbstractSession cloningSession,
                                       boolean buildDirectlyFromRow)

INTERNAL: Return a clone of the attribute.

Overrides:

cloneAttribute in class BasicIndirectionPolicy

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.

extractReferenceRow

public AbstractRecord extractReferenceRow(java.lang.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.

Overrides:

extractReferenceRow in class BasicIndirectionPolicy

getContainerClass

public java.lang.Class getContainerClass()

Returns the Container class which implements IndirectContainer.

getContainerClassName

public java.lang.String getContainerClassName()

INTERNAL: Used by MW.

getOriginalIndirectionObject

public java.lang.Object getOriginalIndirectionObject(java.lang.Object unitOfWorkIndirectionObject,
                                                     AbstractSession session)

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

Overrides:

getOriginalIndirectionObject in class BasicIndirectionPolicy

getOriginalIndirectionObjectForMerge

public java.lang.Object getOriginalIndirectionObjectForMerge(java.lang.Object unitOfWorkIndirectionObject,
                                                             AbstractSession session)

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

Overrides:

getOriginalIndirectionObjectForMerge in class BasicIndirectionPolicy

getRealAttributeValueFromObject

public java.lang.Object getRealAttributeValueFromObject(java.lang.Object object,
                                                        java.lang.Object attribute)

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

Overrides:

getRealAttributeValueFromObject in class BasicIndirectionPolicy

initialize

public void initialize()

INTERNAL: Ensure the container class implements IndirectContainer and that it has a constructor which can be used.

Overrides:

initialize in class IndirectionPolicy

isAttributeValueFullyBuilt

public boolean isAttributeValueFullyBuilt(java.lang.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 class BasicIndirectionPolicy

Parameters:

attributeValue -

Returns:

See Also:

validateAttributeOfInstantiatedObject(Object attributeValue)

iterateOnAttributeValue

public void iterateOnAttributeValue(DescriptorIterator iterator,
                                    java.lang.Object attributeValue)

INTERNAL: Iterate over the specified attribute value,

Overrides:

iterateOnAttributeValue in class BasicIndirectionPolicy

nullValueFromRow

public java.lang.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. In this case, return an empty ValueHolder.

Overrides:

nullValueFromRow in class BasicIndirectionPolicy

reset

public void reset(java.lang.Object target)

Reset the wrapper used to store the value.

Overrides:

reset in class BasicIndirectionPolicy

objectIsInstantiated

public boolean objectIsInstantiated(java.lang.Object object)

INTERNAL: Return whether the specified object is instantiated.

Overrides:

objectIsInstantiated in class BasicIndirectionPolicy

objectIsEasilyInstantiated

public boolean objectIsEasilyInstantiated(java.lang.Object object)

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

Overrides:

objectIsEasilyInstantiated in class BasicIndirectionPolicy

setContainerClass

public void setContainerClass(java.lang.Class containerClass)

Sets the Container class which implements IndirectContainer

setContainterClassName

public void setContainterClassName(java.lang.String containerClassName)

Set the container classname for the MW

setRealAttributeValueInObject

public void setRealAttributeValueInObject(java.lang.Object target,
                                          java.lang.Object attributeValue)

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

Overrides:

setRealAttributeValueInObject in class BasicIndirectionPolicy

validateAttributeOfInstantiatedObject

public java.lang.Object validateAttributeOfInstantiatedObject(java.lang.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 a ValueHolderInterface.

Overrides:

validateAttributeOfInstantiatedObject in class BasicIndirectionPolicy

valueFromBatchQuery

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

Overrides:

valueFromBatchQuery in class BasicIndirectionPolicy

valueFromMethod

public java.lang.Object valueFromMethod(java.lang.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. In this case, wrap the row in a ValueHolder for later use.

Overrides:

valueFromMethod in class BasicIndirectionPolicy

valueFromQuery

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

Overrides:

valueFromQuery in class BasicIndirectionPolicy

valueFromRow

public java.lang.Object valueFromRow(java.lang.Object object)

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.

Overrides:

valueFromRow in class BasicIndirectionPolicy