EclipseLink Core 4.0.2 · org.eclipse.persistence.internal.indirection.ContainerIndirectionPolicy

Modifier and Type	Field and Description
private Class<?>	containerClass
private String	containerClassName
private transient Constructor<?>	containerConstructor

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

Method Summary

Modifier and Type	Method and Description
public Object	backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.backupCloneAttribute. INTERNAL: Return a backup clone of the attribute.
protected IndirectContainer<C>	buildContainer(final ValueHolderInterface<?> valueHolder) Build a container with the initialized constructor.
public Object	buildIndirectObject(ValueHolderInterface<T> valueHolder) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.cloneAttribute. INTERNAL: Return a clone of the attribute.
public AbstractRecord	extractReferenceRow(Object referenceObject) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.extractReferenceRow. INTERNAL: Return the reference row for the reference object.
public Class<?>	getContainerClass() Returns the Container class which implements IndirectContainer.
public String	getContainerClassName() INTERNAL: Used by MW.
protected Constructor<T>	Returns: java.lang.reflect.Constructor getContainerConstructor()
public Object	getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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.BasicIndirectionPolicy.getOriginalIndirectionObjectForMerge. INTERNAL: Return the original indirection object for a unit of work indirection object.
public Object	getRealAttributeValueFromObject(Object object, Object attribute) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.getRealAttributeValueFromObject. INTERNAL: Return the "real" attribute value, as opposed to any wrapper.
public void	initialize() Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.initialize. INTERNAL: Ensure the container class implements IndirectContainer and that it has a constructor which can be used.
public boolean	isAttributeValueFullyBuilt(Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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.BasicIndirectionPolicy.iterateOnAttributeValue. INTERNAL: Iterate over the specified attribute value,
public Object	nullValueFromRow() Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.nullValueFromRow. INTERNAL: Return the null value of the appropriate attribute.
public boolean	objectIsEasilyInstantiated(Object object) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.objectIsEasilyInstantiated. INTERNAL: Return whether the specified object can be instantiated without database access.
public boolean	objectIsInstantiated(Object object) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.objectIsInstantiated. INTERNAL: Return whether the specified object is instantiated.
public void	reset(Object target) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.reset. Reset the wrapper used to store the value.
public void	setContainerClass(Class<?> containerClass) Sets the Container class which implements IndirectContainer
public void	setContainterClassName(String containerClassName) Set the container classname for the MW
public void	setRealAttributeValueInObject(Object target, Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.setRealAttributeValueInObject. INTERNAL: Set the value of the appropriate attribute of target to attributeValue.
protected boolean	typeIsValid(Class<?> attributeType) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.typeIsValid. INTERNAL: Return whether the type is appropriate for the indirection policy.
public Object	validateAttributeOfInstantiatedObject(Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.validateAttributeOfInstantiatedObject. INTERNAL: Verify that the value of the attribute within an instantiated object is of the appropriate type for the indirection policy.
public Object	valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.valueFromBatchQuery. INTERNAL: Return the value to be stored in the object's attribute.
public Object	valueFromMethod(Object object, AbstractRecord row, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.valueFromMethod. INTERNAL: Return the value to be stored in the object's attribute.
public Object	valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.valueFromQuery. INTERNAL: Return the value to be stored in the object's attribute.
public Object	valueFromRow(Object object) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.valueFromRow. INTERNAL: Return the value to be stored in the object's attribute.

Inherited from org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy:: extractPrimaryKeyForReferenceObject fixObjectReferences getOriginalValueHolder getValueFromRemoteValueHolder mergeRemoteValueHolder setSourceObject validateDeclaredAttributeType validateGetMethodReturnType validateSetMethodParameterType valueFromQuery

containerClass	back to summary
private Class<?> containerClass

containerClassName	back to summary
private String containerClassName

containerConstructor	back to summary
private transient Constructor<?> containerConstructor

ContainerIndirectionPolicy	back to summary
public ContainerIndirectionPolicy() INTERNAL: Construct a new indirection policy.

Method Detail

backupCloneAttribute	back to summary
public Object backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.backupCloneAttribute. INTERNAL: Return a backup clone of the attribute. Annotations @Override

backupCloneAttribute

back to summary

public Object backupCloneAttribute(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork)

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

INTERNAL: Return a backup clone of the attribute.

Annotations

@Override

buildContainer	back to summary
protected IndirectContainer<C> buildContainer(final ValueHolderInterface<?> valueHolder) Build a container with the initialized constructor.

buildIndirectObject	back to summary
public Object buildIndirectObject(ValueHolderInterface<T> valueHolder) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

buildIndirectObject

back to summary

public Object buildIndirectObject(ValueHolderInterface<T> valueHolder)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

cloneAttribute	back to summary
public Object cloneAttribute(Object attributeValue, Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession, boolean buildDirectlyFromRow) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

cloneAttribute

back to summary

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

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

extractReferenceRow	back to summary
public AbstractRecord extractReferenceRow(Object referenceObject) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

extractReferenceRow

back to summary

public AbstractRecord extractReferenceRow(Object referenceObject)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

getContainerClass	back to summary
public Class<?> getContainerClass() Returns the Container class which implements IndirectContainer.

getContainerClassName	back to summary
public String getContainerClassName() INTERNAL: Used by MW.

getContainerConstructor	back to summary
protected Constructor<T> getContainerConstructor() Returns:Constructor<T> java.lang.reflect.Constructor

getOriginalIndirectionObject	back to summary
public Object getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.getOriginalIndirectionObject. INTERNAL: Return the original indirection object for a unit of work indirection object. Annotations @Override

getOriginalIndirectionObject

back to summary

public Object getOriginalIndirectionObject(Object unitOfWorkIndirectionObject, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.getOriginalIndirectionObject.

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

Annotations

@Override

getOriginalIndirectionObjectForMerge	back to summary
public Object getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.getOriginalIndirectionObjectForMerge. INTERNAL: Return the original indirection object for a unit of work indirection object. Annotations @Override

getOriginalIndirectionObjectForMerge

back to summary

public Object getOriginalIndirectionObjectForMerge(Object unitOfWorkIndirectionObject, AbstractSession session)

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

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

Annotations

@Override

getRealAttributeValueFromObject	back to summary
public Object getRealAttributeValueFromObject(Object object, Object attribute) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.getRealAttributeValueFromObject. INTERNAL: Return the "real" attribute value, as opposed to any wrapper. This will trigger the wrapper to instantiate the value. Annotations @Override

getRealAttributeValueFromObject

back to summary

public Object getRealAttributeValueFromObject(Object object, Object attribute)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.getRealAttributeValueFromObject.

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

Annotations

@Override

initialize	back to summary
public void initialize() Overrides org.eclipse.persistence.internal.indirection.IndirectionPolicy.initialize. INTERNAL: Ensure the container class implements IndirectContainer and that it has a constructor which can be used. Annotations @Override

initialize

back to summary

public void initialize()

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

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

Annotations

@Override

isAttributeValueFullyBuilt back to summary

isAttributeValueFullyBuilt	back to summary
public boolean isAttributeValueFullyBuilt(Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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)`

public boolean isAttributeValueFullyBuilt(Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

iterateOnAttributeValue	back to summary
public void iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.iterateOnAttributeValue. INTERNAL: Iterate over the specified attribute value, Annotations @Override

iterateOnAttributeValue

back to summary

public void iterateOnAttributeValue(DescriptorIterator iterator, Object attributeValue)

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

INTERNAL: Iterate over the specified attribute value,

Annotations

@Override

nullValueFromRow	back to summary
public Object nullValueFromRow() Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

nullValueFromRow

back to summary

public Object nullValueFromRow()

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

objectIsEasilyInstantiated	back to summary
public boolean objectIsEasilyInstantiated(Object object) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.objectIsEasilyInstantiated. INTERNAL: Return whether the specified object can be instantiated without database access. Annotations @Override

objectIsEasilyInstantiated

back to summary

public boolean objectIsEasilyInstantiated(Object object)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.objectIsEasilyInstantiated.

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

Annotations

@Override

objectIsInstantiated	back to summary
public boolean objectIsInstantiated(Object object) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.objectIsInstantiated. INTERNAL: Return whether the specified object is instantiated. Annotations @Override

objectIsInstantiated

back to summary

public boolean objectIsInstantiated(Object object)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.objectIsInstantiated.

INTERNAL: Return whether the specified object is instantiated.

Annotations

@Override

reset	back to summary
public void reset(Object target) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.reset. Reset the wrapper used to store the value. Annotations @Override

reset

back to summary

public void reset(Object target)

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

Reset the wrapper used to store the value.

Annotations

@Override

setContainerClass	back to summary
public void setContainerClass(Class<?> containerClass) Sets the Container class which implements IndirectContainer

setContainterClassName	back to summary
public void setContainterClassName(String containerClassName) Set the container classname for the MW

setRealAttributeValueInObject	back to summary
public void setRealAttributeValueInObject(Object target, Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

setRealAttributeValueInObject

back to summary

public void setRealAttributeValueInObject(Object target, Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

typeIsValid	back to summary
protected boolean typeIsValid(Class<?> attributeType) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.typeIsValid. INTERNAL: Return whether the type is appropriate for the indirection policy. In this case, the type must either be assignable from IndirectContainer or allow the conatinerClass to be assigned to it. Annotations @Override

typeIsValid

back to summary

protected boolean typeIsValid(Class<?> attributeType)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.typeIsValid.

INTERNAL: Return whether the type is appropriate for the indirection policy. In this case, the type must either be assignable from IndirectContainer or allow the conatinerClass to be assigned to it.

Annotations

@Override

validateAttributeOfInstantiatedObject	back to summary
public Object validateAttributeOfInstantiatedObject(Object attributeValue) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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. Annotations @Override

validateAttributeOfInstantiatedObject

back to summary

public Object validateAttributeOfInstantiatedObject(Object attributeValue)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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.

Annotations

@Override

valueFromBatchQuery	back to summary
public Object valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromBatchQuery

back to summary

public Object valueFromBatchQuery(ReadQuery batchQuery, AbstractRecord row, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromMethod	back to summary
public Object valueFromMethod(Object object, AbstractRecord row, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromMethod

back to summary

public Object valueFromMethod(Object object, AbstractRecord row, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromQuery	back to summary
public Object valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromQuery

back to summary

public Object valueFromQuery(ReadQuery query, AbstractRecord row, AbstractSession session)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromRow	back to summary
public Object valueFromRow(Object object) Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

valueFromRow

back to summary

public Object valueFromRow(Object object)

Overrides org.eclipse.persistence.internal.indirection.BasicIndirectionPolicy.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

public Class ContainerIndirectionPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail