oracle.toplink.essentials.internal.indirection

Class NoIndirectionPolicy

java.lang.Object

oracle.toplink.essentials.internal.indirection.IndirectionPolicy

oracle.toplink.essentials.internal.indirection.NoIndirectionPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class NoIndirectionPolicy
extends IndirectionPolicy

Purpose

: NoIndirectionPolicy implements the behavior necessary for a a ForeignReferenceMapping (or TransformationMapping) to directly use domain objects, as opposed to ValueHolders.

Since:

TOPLink/Java 2.5

Author:

Mike Norman

See Also:

ForeignReferenceMapping, Serialized Form

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.indirection.IndirectionPolicy

mapping

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	cloneAttribute(java.lang.Object attributeValue, java.lang.Object original, java.lang.Object clone, UnitOfWorkImpl unitOfWork, boolean buildDirectlyFromRow) INTERNAL: Return a clone of the attribute.
protected boolean	collectionTypeIsValid(java.lang.Class collectionType) INTERNAL: Return whether the collection type is appropriate for the indirection policy.
AbstractRecord	extractReferenceRow(java.lang.Object referenceObject) INTERNAL: Return the reference row for the reference object.
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	getRealAttributeValueFromObject(java.lang.Object object, java.lang.Object attribute) INTERNAL: Return the "real" attribute value, as opposed to any wrapper.
java.lang.Object	nullValueFromRow() INTERNAL: Return the null value of the appropriate attribute.
boolean	objectIsInstantiated(java.lang.Object object) INTERNAL: Return whether the specified object is instantiated.
protected boolean	typeIsValid(java.lang.Class attributeType) INTERNAL: Return whether the type is appropriate for the indirection policy.
boolean	usesIndirection() INTERNAL: Return whether the indirection policy actually uses indirection.
void	validateDeclaredAttributeType(java.lang.Class attributeType, IntegrityChecker checker) INTERNAL: Verify that attributeType is correct for the indirection policy.
void	validateDeclaredAttributeTypeForCollection(java.lang.Class attributeType, IntegrityChecker checker) INTERNAL: Verify that attributeType is an appropriate collection type for the indirection policy.
void	validateGetMethodReturnType(java.lang.Class returnType, IntegrityChecker checker) INTERNAL: Verify that getter returnType is correct for the indirection policy.
void	validateGetMethodReturnTypeForCollection(java.lang.Class returnType, IntegrityChecker checker) INTERNAL: Verify that getter returnType is an appropriate collection type for the indirection policy.
void	validateSetMethodParameterType(java.lang.Class parameterType, IntegrityChecker checker) INTERNAL: Verify that setter parameterType is correct for the indirection policy.
void	validateSetMethodParameterTypeForCollection(java.lang.Class parameterType, IntegrityChecker checker) INTERNAL: Verify that setter parameterType is an appropriate collection type for the indirection policy.
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 oracle.toplink.essentials.internal.indirection.IndirectionPolicy

backupCloneAttribute, buildCascadeQuery, clone, extractPrimaryKeyForReferenceObject, getCollectionMapping, getForeignReferenceMapping, getMapping, getOneToOneMapping, getValueFromProxy, initialize, iterateOnAttributeValue, setMapping, setRealAttributeValueInObject, usesTransparentIndirection, validateAttributeOfInstantiatedObject, validateContainerPolicy

Methods inherited from class java.lang.Object

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

Constructor Detail

NoIndirectionPolicy

public NoIndirectionPolicy()

INTERNAL: Construct a new indirection policy.

Method Detail

cloneAttribute

public java.lang.Object cloneAttribute(java.lang.Object attributeValue,
                                       java.lang.Object original,
                                       java.lang.Object clone,
                                       UnitOfWorkImpl unitOfWork,
                                       boolean buildDirectlyFromRow)

INTERNAL: Return a clone of the attribute.

Specified by:

cloneAttribute in class IndirectionPolicy

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.

collectionTypeIsValid

protected boolean collectionTypeIsValid(java.lang.Class collectionType)

INTERNAL: Return whether the collection type is appropriate for the indirection policy. In this case, the type MUST be a Vector (or, in the case of jdk1.2, Collection or Map).

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.

Specified by:

extractReferenceRow in class IndirectionPolicy

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.

Specified by:

getOriginalIndirectionObject in class IndirectionPolicy

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.

Specified by:

getRealAttributeValueFromObject in class IndirectionPolicy

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.

Specified by:

nullValueFromRow in class IndirectionPolicy

objectIsInstantiated

public boolean objectIsInstantiated(java.lang.Object object)

INTERNAL: Return whether the specified object is instantiated.

Specified by:

objectIsInstantiated in class IndirectionPolicy

typeIsValid

protected boolean typeIsValid(java.lang.Class attributeType)

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

usesIndirection

public boolean usesIndirection()

INTERNAL: Return whether the indirection policy actually uses indirection. Here, we must reply false.

Overrides:

usesIndirection in class IndirectionPolicy

validateDeclaredAttributeType

public void validateDeclaredAttributeType(java.lang.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 CANNOT be ValueHolderInterface.

Overrides:

validateDeclaredAttributeType in class IndirectionPolicy

Throws:

DescriptorException

validateDeclaredAttributeTypeForCollection

public void validateDeclaredAttributeTypeForCollection(java.lang.Class attributeType,
                                                       IntegrityChecker checker)
                                                throws DescriptorException

INTERNAL: Verify that attributeType is an appropriate collection type for the indirection policy. If it is incorrect, add an exception to the integrity checker. In this case, the type MUST be a Vector (or, in the case of jdk1.2, Collection or Map).

Overrides:

validateDeclaredAttributeTypeForCollection in class IndirectionPolicy

Throws:

DescriptorException

validateGetMethodReturnType

public void validateGetMethodReturnType(java.lang.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 return type CANNOT be ValueHolderInterface.

Overrides:

validateGetMethodReturnType in class IndirectionPolicy

Throws:

DescriptorException

validateGetMethodReturnTypeForCollection

public void validateGetMethodReturnTypeForCollection(java.lang.Class returnType,
                                                     IntegrityChecker checker)
                                              throws DescriptorException

INTERNAL: Verify that getter returnType is an appropriate collection type for the indirection policy. If it is incorrect, add an exception to the integrity checker. In this case, the type MUST be a Vector (or, in the case of jdk1.2, Collection or Map).

Overrides:

validateGetMethodReturnTypeForCollection in class IndirectionPolicy

Throws:

DescriptorException

validateSetMethodParameterType

public void validateSetMethodParameterType(java.lang.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 parameter type CANNOT be ValueHolderInterface.

Overrides:

validateSetMethodParameterType in class IndirectionPolicy

Throws:

DescriptorException

validateSetMethodParameterTypeForCollection

public void validateSetMethodParameterTypeForCollection(java.lang.Class parameterType,
                                                        IntegrityChecker checker)
                                                 throws DescriptorException

INTERNAL: Verify that setter parameterType is an appropriate collection type for the indirection policy. If it is incorrect, add an exception to the integrity checker. In this case, the type MUST be a Vector (or, in the case of jdk1.2, Collection or Map).

Overrides:

validateSetMethodParameterTypeForCollection in class IndirectionPolicy

Throws:

DescriptorException

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, simply execute the query and return its results.

Specified by:

valueFromQuery in class IndirectionPolicy

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 return the object.

Specified by:

valueFromRow in class IndirectionPolicy