EclipseLink1.0 - 20080707 API Reference

org.eclipse.persistence.sessions.changesets
Interface OrderedCollectionChangeRecord

All Superinterfaces:
ChangeRecord

public interface OrderedCollectionChangeRecord
extends ChangeRecord

Purpose: Provide public API to the OrderedCollectionChangeRecord.

Description: OrderedCollections, used in TopLink SDK, must be tracked differently from regulat Collections. As the objects in the collection have a particular index which must be stored. This class stores the objects which must be written into the collection and the indexes they must be written in at. Inserting a new element at the beginning of the list will result in the intire list being stored in the change set as the index of all other objects has changed. Everything after the remove index will be remove.


Method Summary
 java.util.Vector getAddIndexes()
          ADVANCED: This method returns the collection of indexes in which changes were made to this collection.
 java.util.Hashtable getAddObjectList()
          ADVANCED: This method returns the collection of ChangeSets that were added to the collection.
 int getStartRemoveIndex()
          ADVANCED: This method returns the index from where objects must be removed from the collection
 
Methods inherited from interface org.eclipse.persistence.sessions.changesets.ChangeRecord
getAttribute, getOwner
 

Method Detail

getAddIndexes

java.util.Vector getAddIndexes()
ADVANCED: This method returns the collection of indexes in which changes were made to this collection.

Returns:
java.util.Vector

getAddObjectList

java.util.Hashtable getAddObjectList()
ADVANCED: This method returns the collection of ChangeSets that were added to the collection. The indexes of these objects are the Keys of the Hashtable

Returns:
java.util.Hashtable

getStartRemoveIndex

int getStartRemoveIndex()
ADVANCED: This method returns the index from where objects must be removed from the collection

Returns:
int

EclipseLink1.0 - 20080707 API Reference