org.eclipse.persistence.internal.queries

Class OrderedListContainerPolicy

java.lang.Object

org.eclipse.persistence.internal.queries.ContainerPolicy

org.eclipse.persistence.internal.queries.InterfaceContainerPolicy

org.eclipse.persistence.internal.queries.CollectionContainerPolicy

org.eclipse.persistence.internal.queries.ListContainerPolicy

org.eclipse.persistence.internal.queries.OrderedListContainerPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CoreContainerPolicy<AbstractSession>

public class OrderedListContainerPolicy
extends ListContainerPolicy

Purpose: A OrderedListContainerPolicy is ContainerPolicy whose container class implements the List interface and is ordered by an @OrderBy.

Responsibilities: Provide the functionality to operate on an instance of a List.

See Also:

ContainerPolicy, CollectionContainerPolicy, ListContainerPolicy, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OrderedListContainerPolicy() INTERNAL: Construct a new policy.
OrderedListContainerPolicy(java.lang.Class containerClass) INTERNAL: Construct a new policy for the specified class.
OrderedListContainerPolicy(java.lang.String containerClassName) INTERNAL: Construct a new policy for the specified class name.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalFieldsToQuery(ReadQuery selectionQuery, Expression baseExpression) INTERNAL: Add the index field to the query.
boolean	addAll(java.util.List elements, java.lang.Object container, AbstractSession session, java.util.List<AbstractRecord> dbRows, DataReadQuery query, CacheKey parentCacheKey, boolean isTargetProtected) INTERNAL: Add a list of elements to container.
boolean	addAll(java.util.List elements, java.lang.Object container, AbstractSession session, java.util.List<AbstractRecord> dbRows, ObjectBuildingQuery query, CacheKey parentCacheKey, boolean isTargetProtected) INTERNAL: Add a list of elements to container.
void	compareCollectionsForChange(java.lang.Object oldList, java.lang.Object newList, CollectionChangeRecord changeRecord, AbstractSession session, ClassDescriptor referenceDescriptor) INTERNAL: This method is used to calculate the differences between two collections.
java.util.List	correctOrderList(java.util.List<IndexedObject> indexedObjects) PUBLIC: Correct object's order in the list.
java.util.List<DatabaseField>	getAdditionalFieldsForJoin(CollectionMapping baseMapping) INTERNAL: Return any additional fields required by the policy for a fetch join.
java.util.List<DatabaseTable>	getAdditionalTablesForJoinQuery() INTERNAL: Return any tables that will be required when this mapping is used as part of a join query.
java.util.Iterator	getChangeValuesFrom(java.util.Map map) INTERNAL: Used to create an iterator on a the Map object passed to CollectionChangeRecord.addRemoveChange() to access the values to be removed.
DatabaseField	getListOrderField()
OrderCorrectionType	getOrderCorrectionType()
boolean	isOrderedListPolicy()
java.lang.Object	iteratorFor(java.lang.Object container) INTERNAL: Return an list iterator for the given container.
void	mergeChanges(CollectionChangeRecord changeRecord, java.lang.Object valueOfTarget, boolean shouldMergeCascadeParts, MergeManager mergeManager, AbstractSession targetSession, boolean isSynchronizeOnMerge) INTERNAL: Merge changes from the source to the target object.
void	recordAddToCollectionInChangeRecord(ObjectChangeSet changeSetToAdd, CollectionChangeRecord collectionChangeRecord) This method is used to bridge the behavior between Attribute Change Tracking and deferred change tracking with respect to adding the same instance multiple times.
void	recordRemoveFromCollectionInChangeRecord(ObjectChangeSet changeSetToRemove, CollectionChangeRecord collectionChangeRecord) This method is used to bridge the behavior between Attribute Change Tracking and deferred change tracking with respect to adding the same instance multiple times.
void	recordUpdateToCollectionInChangeRecord(CollectionChangeEvent event, ObjectChangeSet changeSet, CollectionChangeRecord collectionChangeRecord) This method is used to bridge the behavior between Attribute Change Tracking and deferred change tracking with respect to adding the same instance multiple times.
void	setListOrderField(DatabaseField field)
void	setOrderCorrectionType(OrderCorrectionType orderCorrectionType)
boolean	shouldAddAll() INTERNAL: Indicates whether addAll method should be called to add entire collection, or it's possible to call addInto multiple times instead.
void	updateChangeRecordForSelfMerge(ChangeRecord changeRecord, java.lang.Object source, java.lang.Object target, ForeignReferenceMapping mapping, UnitOfWorkChangeSet parentUOWChangeSet, UnitOfWorkImpl unitOfWork) INTERNAL: Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity.
int	updateJoinedMappingIndexesForMapKey(java.util.Map<DatabaseMapping,java.lang.Object> indexList, int index) INTERNAL: Add the index field count.

Methods inherited from class org.eclipse.persistence.internal.queries.ListContainerPolicy

get, hasOrder, indexOf, isListPolicy, isValidContainer, valueFromPKList

Methods inherited from class org.eclipse.persistence.internal.queries.CollectionContainerPolicy

addInto, buildContainerFromVector, clear, cloneFor, getInterfaceType, isCollectionPolicy, sizeFor

Methods inherited from class org.eclipse.persistence.internal.queries.InterfaceContainerPolicy

convertClassNamesToClasses, createChangeEvent, createQueryKeyForMapKey, equals, getCloneMethod, getContainerClass, getContainerClassName, getDirectKeyField, hasNext, isMapKeyAttribute, isValidContainerType, setCloneMethod, setContainerClass, setContainerClassName

Methods inherited from class org.eclipse.persistence.internal.queries.ContainerPolicy

addFieldsForMapKey, addInto, addInto, addInto, addNestedJoinsQueriesForMapKey, addNextValueFromIteratorInto, buildChangeSetForNewObjectInCollection, buildCloneForKey, buildCollectionEntry, buildDefaultPolicy, buildKey, buildKeyFromJoinedRow, buildPolicyFor, buildPolicyFor, buildReferencesPKList, buildSelectionQueryForDirectCollectionMapping, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, clone, clone, compareKeys, concatenateContainers, containerInstance, containerInstance, contains, copyMapDataToRow, createWrappedObjectFromExistingWrappedObject, deleteWrappedObject, execute, getCloneDataFromChangeSet, getDefaultContainerClass, getDescriptorForMapKey, getElementDescriptor, getIdentityFieldsForMapKey, getKeyMappingDataForWriteQuery, getKeySelectionCriteria, getKeyType, hasElementDescriptor, initialize, initializeConstructor, isCursoredStreamPolicy, isCursorPolicy, isDirectMapPolicy, isEmpty, isMapKeyObject, isMappedKeyMapPolicy, isMapPolicy, isScrollableCursorPolicy, iterateOnMapKey, keyFrom, keyFromEntry, keyFromIterator, mergeCascadeParts, next, nextEntry, nextEntry, overridesRead, postCalculateChanges, postCalculateChanges, postInitialize, prepare, prepareForExecution, processAdditionalWritableMapKeyFields, propagatesEventsToCollection, propogatePostDelete, propogatePostInsert, propogatePostUpdate, propogatePreDelete, propogatePreInsert, propogatePreUpdate, recordPrivateOwnedRemovals, remoteExecute, removeFrom, removeFrom, requiresDataModificationEvents, setDefaultContainerClass, setElementDescriptor, setKeyName, setKeyName, shouldIncludeKeyInDeleteEvent, shouldUpdateForeignKeysPostInsert, toString, unwrapElement, unwrapIteratorResult, vectorFor

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderedListContainerPolicy

public OrderedListContainerPolicy()

INTERNAL: Construct a new policy.

OrderedListContainerPolicy

public OrderedListContainerPolicy(java.lang.Class containerClass)

INTERNAL: Construct a new policy for the specified class.

OrderedListContainerPolicy

public OrderedListContainerPolicy(java.lang.String containerClassName)

INTERNAL: Construct a new policy for the specified class name.

Method Detail

addAll

public boolean addAll(java.util.List elements,
                      java.lang.Object container,
                      AbstractSession session,
                      java.util.List<AbstractRecord> dbRows,
                      ObjectBuildingQuery query,
                      CacheKey parentCacheKey,
                      boolean isTargetProtected)

INTERNAL: Add a list of elements to container. This is used to add to a collection independent of JDK 1.1 and 1.2. The session may be required to wrap for the wrapper policy. The row may be required by subclasses Return whether the container changed

Overrides:

addAll in class ContainerPolicy

addAll

public boolean addAll(java.util.List elements,
                      java.lang.Object container,
                      AbstractSession session,
                      java.util.List<AbstractRecord> dbRows,
                      DataReadQuery query,
                      CacheKey parentCacheKey,
                      boolean isTargetProtected)

INTERNAL: Add a list of elements to container. This is used to add to a collection independent of JDK 1.1 and 1.2. The session may be required to wrap for the wrapper policy. The row may be required by subclasses Return whether the container changed

Overrides:

addAll in class ContainerPolicy

compareCollectionsForChange

public void compareCollectionsForChange(java.lang.Object oldList,
                                        java.lang.Object newList,
                                        CollectionChangeRecord changeRecord,
                                        AbstractSession session,
                                        ClassDescriptor referenceDescriptor)

INTERNAL: This method is used to calculate the differences between two collections. This algorithm is a work in progress. It works great and all, but like anything, you can always make it better.

Overrides:

compareCollectionsForChange in class ContainerPolicy

correctOrderList

public java.util.List correctOrderList(java.util.List<IndexedObject> indexedObjects)

PUBLIC: Correct object's order in the list. The method is called only in one case - when the list of order indexes read from db is invalid (contains nulls, duplicates, negative values, values greater/equal list size). Each element of the indexedObjects is a pair of the order index and the corresponding object. The goal of the method is to return back the list of objects (not indexed objects!) in the correct order. The objects should not be altered. The default implementation of the method sorts indexedObjects according to their indexes (null less than any non-null). For example: indexedObjects = {{2, objectA}, {5, ObjectB}} returns {objectA, objectB}; indexedObjects = {{2, objectA}, {-1, ObjectB}} returns {objectB, objectA}; indexedObjects = {{2, objectA}, {null, ObjectB}} returns {objectB, objectA}; This method could be overridden by the user.

getChangeValuesFrom

public java.util.Iterator getChangeValuesFrom(java.util.Map map)

INTERNAL: Used to create an iterator on a the Map object passed to CollectionChangeRecord.addRemoveChange() to access the values to be removed. In the case of some container policies the values will actually be the keys.

Overrides:

getChangeValuesFrom in class ContainerPolicy

getListOrderField

public DatabaseField getListOrderField()

setListOrderField

public void setListOrderField(DatabaseField field)

getOrderCorrectionType

public OrderCorrectionType getOrderCorrectionType()

setOrderCorrectionType

public void setOrderCorrectionType(OrderCorrectionType orderCorrectionType)

iteratorFor

public java.lang.Object iteratorFor(java.lang.Object container)

INTERNAL: Return an list iterator for the given container.

Specified by:

iteratorFor in interface CoreContainerPolicy<AbstractSession>

Overrides:

iteratorFor in class CollectionContainerPolicy

Parameters:

container - java.lang.Object

Returns:

java.util.Enumeration/java.util.Iterator

See Also:

ContainerPolicy.hasNext(java.lang.Object), ContainerPolicy.next(java.lang.Object)

isOrderedListPolicy

public boolean isOrderedListPolicy()

Overrides:

isOrderedListPolicy in class ContainerPolicy

mergeChanges

public void mergeChanges(CollectionChangeRecord changeRecord,
                         java.lang.Object valueOfTarget,
                         boolean shouldMergeCascadeParts,
                         MergeManager mergeManager,
                         AbstractSession targetSession,
                         boolean isSynchronizeOnMerge)

INTERNAL: Merge changes from the source to the target object. Because this is a collection mapping, values are added to or removed from the collection based on the change set. Synchronize if system property is specified. If not, default to clone the target collection. No need to synchronize if the collection is new.

Overrides:

mergeChanges in class ContainerPolicy

recordAddToCollectionInChangeRecord

public void recordAddToCollectionInChangeRecord(ObjectChangeSet changeSetToAdd,
                                                CollectionChangeRecord collectionChangeRecord)

This method is used to bridge the behavior between Attribute Change Tracking and deferred change tracking with respect to adding the same instance multiple times. Each ContainerPolicy type will implement specific behavior for the collection type it is wrapping. These methods are only valid for collections containing object references

Overrides:

recordAddToCollectionInChangeRecord in class ListContainerPolicy

recordRemoveFromCollectionInChangeRecord

public void recordRemoveFromCollectionInChangeRecord(ObjectChangeSet changeSetToRemove,
                                                     CollectionChangeRecord collectionChangeRecord)

Description copied from class: ListContainerPolicy

This method is used to bridge the behavior between Attribute Change Tracking and deferred change tracking with respect to adding the same instance multiple times. Each ContainerPolicy type will implement specific behavior for the collection type it is wrapping. These methods are only valid for collections containing object references

Overrides:

recordRemoveFromCollectionInChangeRecord in class ListContainerPolicy

recordUpdateToCollectionInChangeRecord

public void recordUpdateToCollectionInChangeRecord(CollectionChangeEvent event,
                                                   ObjectChangeSet changeSet,
                                                   CollectionChangeRecord collectionChangeRecord)

Description copied from class: ContainerPolicy

This method is used to bridge the behavior between Attribute Change Tracking and deferred change tracking with respect to adding the same instance multiple times. Each ContainerPolicy type will implement specific behavior for the collection type it is wrapping. These methods are only valid for collections containing object references

Overrides:

recordUpdateToCollectionInChangeRecord in class ContainerPolicy

shouldAddAll

public boolean shouldAddAll()

INTERNAL: Indicates whether addAll method should be called to add entire collection, or it's possible to call addInto multiple times instead.

Overrides:

shouldAddAll in class ContainerPolicy

Returns:

getAdditionalFieldsForJoin

public java.util.List<DatabaseField> getAdditionalFieldsForJoin(CollectionMapping baseMapping)

INTERNAL: Return any additional fields required by the policy for a fetch join.

Overrides:

getAdditionalFieldsForJoin in class ContainerPolicy

updateJoinedMappingIndexesForMapKey

public int updateJoinedMappingIndexesForMapKey(java.util.Map<DatabaseMapping,java.lang.Object> indexList,
                                               int index)

INTERNAL: Add the index field count.

Overrides:

updateJoinedMappingIndexesForMapKey in class ContainerPolicy

updateChangeRecordForSelfMerge

public void updateChangeRecordForSelfMerge(ChangeRecord changeRecord,
                                           java.lang.Object source,
                                           java.lang.Object target,
                                           ForeignReferenceMapping mapping,
                                           UnitOfWorkChangeSet parentUOWChangeSet,
                                           UnitOfWorkImpl unitOfWork)

INTERNAL: Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity. This is used when an Entity is merged into itself and the Entity reference new or detached entities.

Overrides:

updateChangeRecordForSelfMerge in class ListContainerPolicy

getAdditionalTablesForJoinQuery

public java.util.List<DatabaseTable> getAdditionalTablesForJoinQuery()

INTERNAL: Return any tables that will be required when this mapping is used as part of a join query.

Overrides:

getAdditionalTablesForJoinQuery in class ContainerPolicy

addAdditionalFieldsToQuery

public void addAdditionalFieldsToQuery(ReadQuery selectionQuery,
                                       Expression baseExpression)

INTERNAL: Add the index field to the query.

Overrides:

addAdditionalFieldsToQuery in class ContainerPolicy

See Also:

MappedKeyMapContinerPolicy