org.eclipse.persistence.mappings.ForeignReferenceMapping (or TransformationMapping) to
use ValueHolders to delay the reading of objects from the database
until they are actually needed.
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Object | backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork)
Overrides org. |
| public Object | buildIndirectObject(ValueHolderInterface<T> valueHolder)
Implements abstract org. |
| 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. |
| public Object | extractPrimaryKeyForReferenceObject(Object referenceObject, AbstractSession session)
Overrides org. |
| public AbstractRecord | extractReferenceRow(Object referenceObject)
Implements abstract org. |
| public void | fixObjectReferences(Object object, Map<Object, ObjectDescriptor> objectDescriptors, Map<Object, Object> processedObjects, ObjectLevelReadQuery query, DistributedSession session)
Implements abstract org. |
| public Object | getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session)
Implements abstract org. |
| public Object | getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session)
Overrides org. |
| public Object | getOriginalValueHolder(Object unitOfWorkIndirectionObject, AbstractSession session)
Implements abstract org. |
| public Object | getRealAttributeValueFromObject(Object object, Object attribute)
Implements abstract org. |
| public Object | getValueFromRemoteValueHolder(RemoteValueHolder<?> remoteValueHolder)
Implements abstract org. |
| public boolean | isAttributeValueFullyBuilt(Object attributeValue)
Overrides org. |
| public void | iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue)
Overrides org. |
| public void | mergeRemoteValueHolder(Object clientSideDomainObject, Object serverSideDomainObject, MergeManager mergeManager)
Implements abstract org. |
| public Object | nullValueFromRow()
Implements abstract org. |
| public boolean | objectIsEasilyInstantiated(Object object)
Implements abstract org. |
| public boolean | objectIsInstantiated(Object object)
Implements abstract org. |
| public void | reset(Object target)
Overrides org. |
| public void | setRealAttributeValueInObject(Object target, Object attributeValue)
Overrides org. |
| public void | setSourceObject(Object sourceObject, Object attributeValue)
Overrides org. |
| protected boolean | typeIsValid(Class<?> attributeType)
INTERNAL: Return whether the type is appropriate for the indirection policy. |
| public Object | validateAttributeOfInstantiatedObject(Object attributeValue)
Overrides org. |
| public void | validateDeclaredAttributeType(Class<?> attributeType, IntegrityChecker checker)
Overrides org. |
| public void | validateGetMethodReturnType(Class<?> returnType, IntegrityChecker checker)
Overrides org. |
| public void | validateSetMethodParameterType(Class<?> parameterType, IntegrityChecker checker)
Overrides org. |
| public Object | valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)
Implements abstract org. |
| public Object | valueFromMethod(Object object, AbstractRecord row, AbstractSession session)
Implements abstract org. |
| public Object | valueFromQuery(ReadQuery query, AbstractRecord row, Object sourceObject, AbstractSession session)
Implements abstract org. |
| public Object | valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session)
Implements abstract org. |
| public Object | valueFromRow(Object object)
Implements abstract org. |
| BasicIndirectionPolicy | back to summary |
|---|---|
| public BasicIndirectionPolicy() INTERNAL: Construct a new indirection policy. | |
| backupCloneAttribute | back to summary |
|---|---|
| public Object backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork) Overrides org. INTERNAL: Return a backup clone of the attribute.
| |
| buildIndirectObject | back to summary |
|---|---|
| public Object buildIndirectObject(ValueHolderInterface<T> valueHolder) Implements abstract org. 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.
| |
| cloneAttribute | back to summary |
|---|---|
| public Object cloneAttribute(Object attributeValue, Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession, boolean buildDirectlyFromRow) Implements abstract org. INTERNAL: Return a clone of the attribute.
| |
| extractPrimaryKeyForReferenceObject | back to summary |
|---|---|
| public Object extractPrimaryKeyForReferenceObject(Object referenceObject, AbstractSession session) Overrides org. 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.
| |
| extractReferenceRow | back to summary |
|---|---|
| public AbstractRecord extractReferenceRow(Object referenceObject) Implements abstract org. 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.
| |
| fixObjectReferences | back to summary |
|---|---|
| public void fixObjectReferences(Object object, Map<Object, ObjectDescriptor> objectDescriptors, Map<Object, Object> processedObjects, ObjectLevelReadQuery query, DistributedSession session) Implements abstract org. 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.
| |
| getOriginalIndirectionObject | back to summary |
|---|---|
| public Object getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session) Implements abstract org. 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.
| |
| getOriginalIndirectionObjectForMerge | back to summary |
|---|---|
| public Object getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session) Overrides org. INTERNAL: Return the original indirection object for a unit of work indirection object.
| |
| getOriginalValueHolder | back to summary |
|---|---|
| public Object getOriginalValueHolder(Object unitOfWorkIndirectionObject, AbstractSession session) Implements abstract org. 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.
| |
| getRealAttributeValueFromObject | back to summary |
|---|---|
| public Object getRealAttributeValueFromObject(Object object, Object attribute) Implements abstract org. INTERNAL: Return the "real" attribute value, as opposed to any wrapper. This will trigger the wrapper to instantiate the value.
| |
| getValueFromRemoteValueHolder | back to summary |
|---|---|
| public Object getValueFromRemoteValueHolder(RemoteValueHolder<?> remoteValueHolder) Implements abstract org. INTERNAL: Extract and return the appropriate value from the specified remote value holder.
| |
| isAttributeValueFullyBuilt | back to summary |
|---|---|
| public boolean isAttributeValueFullyBuilt(Object attributeValue) Overrides org. 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
| |
| iterateOnAttributeValue | back to summary |
|---|---|
| public void iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue) Overrides org. INTERNAL: Iterate over the specified attribute value,
| |
| mergeRemoteValueHolder | back to summary |
|---|---|
| public void mergeRemoteValueHolder(Object clientSideDomainObject, Object serverSideDomainObject, MergeManager mergeManager) Implements abstract org. INTERNAL Replace the client value holder with the server value holder, after copying some of the settings from the client value holder.
| |
| nullValueFromRow | back to summary |
|---|---|
| public Object nullValueFromRow() Implements abstract org. 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.
| |
| objectIsEasilyInstantiated | back to summary |
|---|---|
| public boolean objectIsEasilyInstantiated(Object object) Implements abstract org. INTERNAL: Return whether the specified object can be instantiated without database access.
| |
| objectIsInstantiated | back to summary |
|---|---|
| public boolean objectIsInstantiated(Object object) Implements abstract org. INTERNAL: Return whether the specified object is instantiated.
| |
| reset | back to summary |
|---|---|
| public void reset(Object target) Overrides org. Reset the wrapper used to store the value.
| |
| setRealAttributeValueInObject | back to summary |
|---|---|
| public void setRealAttributeValueInObject(Object target, Object attributeValue) Overrides org. INTERNAL: Set the value of the appropriate attribute of target to attributeValue. In this case, place the value inside the target's ValueHolder.
| |
| setSourceObject | back to summary |
|---|---|
| public void setSourceObject(Object sourceObject, Object attributeValue) Overrides org. INTERNAL: set the source object into QueryBasedValueHolder. Used only by transparent indirection.
| |
| typeIsValid | back 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. | |
| validateAttributeOfInstantiatedObject | back to summary |
|---|---|
| public Object validateAttributeOfInstantiatedObject(Object attributeValue) Overrides org. 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.
| |
| validateDeclaredAttributeType | back to summary |
|---|---|
| public void validateDeclaredAttributeType(Class<?> attributeType, IntegrityChecker checker) throws DescriptorException Overrides org. 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.
| |
| validateGetMethodReturnType | back to summary |
|---|---|
| public void validateGetMethodReturnType(Class<?> returnType, IntegrityChecker checker) throws DescriptorException Overrides org. 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.
| |
| validateSetMethodParameterType | back to summary |
|---|---|
| public void validateSetMethodParameterType(Class<?> parameterType, IntegrityChecker checker) throws DescriptorException Overrides org. 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.
| |
| valueFromBatchQuery | back to summary |
|---|---|
| public Object valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey) Implements abstract org. 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.
| |
| valueFromMethod | back to summary |
|---|---|
| public Object valueFromMethod(Object object, AbstractRecord row, AbstractSession session) Implements abstract org. 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.
| |
| valueFromQuery | back to summary |
|---|---|
| public Object valueFromQuery(ReadQuery query, AbstractRecord row, Object sourceObject, AbstractSession session) Implements abstract org. 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.
| |
| valueFromQuery | back to summary |
|---|---|
| public Object valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session) Implements abstract org. 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.
| |
| valueFromRow | back to summary |
|---|---|
| public Object valueFromRow(Object object) Implements abstract org. 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.
| |