Package org.eclipse.persistence.mappings.foundation

Class AbstractCompositeDirectCollectionMapping

    • Field Detail

      • field

        protected org.eclipse.persistence.internal.helper.DatabaseField field
        This is the field holding the nested collection.

      • elementDataTypeName

        protected java.lang.String elementDataTypeName
        This is the "data type" associated with each element in the nested collection. Depending on the data store, this could be optional.

      • valueConverter

        protected Converter valueConverter
        Allows user defined conversion between the object value and the database value.

    • Constructor Detail

      • AbstractCompositeDirectCollectionMapping

        public AbstractCompositeDirectCollectionMapping()
        Default constructor.

    • Method Detail

      • getValueConverter

        public Converter getValueConverter()
        PUBLIC: Return the converter on the mapping. A converter can be used to convert between the direct collection's object value and database value.

      • hasValueConverter

        public boolean hasValueConverter()
        PUBLIC: Indicates if there is a converter on the mapping.

      • setValueConverter

        public void setValueConverter​(Converter valueConverter)
        PUBLIC: Set the converter on the mapping. A converter can be used to convert between the direct collection's object value and database value.

      • buildAddedElementFromChangeSet

        public java.lang.Object buildAddedElementFromChangeSet​(java.lang.Object changeSet,
                                                       org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                       org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
        INTERNAL: Build and return a new element based on the change set.
        Specified by:
        buildAddedElementFromChangeSet in interface ArrayCollectionMapping

      • buildBackupClone

        public void buildBackupClone​(java.lang.Object clone,
                             java.lang.Object backup,
                             org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork)
        INTERNAL: Clone the attribute from the clone and assign it to the backup. For these mappings, this is the same as building the first clone.
        Specified by:
        buildBackupClone in class DatabaseMapping

      • buildChangeSet

        public java.lang.Object buildChangeSet​(java.lang.Object element,
                                       org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                                       org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Build and return a change set for the specified element. Direct collections simply store the element itself, since it is immutable.
        Specified by:
        buildChangeSet in interface ArrayCollectionMapping

      • buildClone

        public void buildClone​(java.lang.Object original,
                       org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                       java.lang.Object clone,
                       java.lang.Integer refreshCascade,
                       org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)
        INTERNAL: Clone the attribute from the original and assign it to the clone.
        Specified by:
        buildClone in class DatabaseMapping

      • buildCloneFromRow

        public void buildCloneFromRow​(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                              org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                              java.lang.Object clone,
                              org.eclipse.persistence.internal.identitymaps.CacheKey sharedCacheKey,
                              ObjectBuildingQuery sourceQuery,
                              org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork,
                              org.eclipse.persistence.internal.sessions.AbstractSession executionSession)
        INTERNAL: Extract value from the row and set the attribute to this value in the working copy clone. In order to bypass the shared cache when in transaction a UnitOfWork must be able to populate working copies directly from the row.
        Specified by:
        buildCloneFromRow in class DatabaseMapping

      • buildClonePart

        protected java.lang.Object buildClonePart​(java.lang.Object attributeValue,
                                          org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                                          org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)
        Build and return a clone of the specified attribute value.

      • buildCopy

        public void buildCopy​(java.lang.Object copy,
                      java.lang.Object original,
                      CopyGroup group)
        INTERNAL: Copy of the attribute of the object. This is NOT used for unit of work but for templatizing an object.
        Overrides:
        buildCopy in class DatabaseMapping

      • buildElementFromChangeSet

        protected java.lang.Object buildElementFromChangeSet​(java.lang.Object changeSet,
                                                     org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                     org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
        Build and return a new element based on the change set. Direct collections simply store the element itself, since it is immutable.

      • buildElementFromElement

        public java.lang.Object buildElementFromElement​(java.lang.Object object,
                                                org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
        INTERNAL: Build and return a new element based on the specified element. Direct collections simply return the element itself, since it is immutable.
        Specified by:
        buildElementFromElement in interface ArrayCollectionMapping

      • buildRemovedElementFromChangeSet

        public java.lang.Object buildRemovedElementFromChangeSet​(java.lang.Object changeSet,
                                                         org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                         org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
        INTERNAL: Build and return a new element based on the change set.
        Specified by:
        buildRemovedElementFromChangeSet in interface ArrayCollectionMapping

      • cascadePerformRemoveIfRequired

        public void cascadePerformRemoveIfRequired​(java.lang.Object object,
                                           org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                           java.util.Map visitedObjects)
        INTERNAL: Cascade perform delete through mappings that require the cascade
        Specified by:
        cascadePerformRemoveIfRequired in class DatabaseMapping

      • cascadeRegisterNewIfRequired

        public void cascadeRegisterNewIfRequired​(java.lang.Object object,
                                         org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                         java.util.Map visitedObjects)
        INTERNAL: Cascade registerNew for Create through mappings that require the cascade
        Specified by:
        cascadeRegisterNewIfRequired in class DatabaseMapping

      • collectFields

        protected java.util.Vector collectFields()
        Return the fields handled by the mapping.
        Overrides:
        collectFields in class DatabaseMapping

      • compareElements

        public boolean compareElements​(java.lang.Object element1,
                               java.lang.Object element2,
                               org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Compare the non-null elements. Return true if they are alike. Use #equals() to determine if two elements are the same.
        Specified by:
        compareElements in interface ArrayCollectionMapping

      • compareElementsForChange

        public boolean compareElementsForChange​(java.lang.Object element1,
                                        java.lang.Object element2,
                                        org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Compare the non-null elements and return true if they are alike.
        Specified by:
        compareElementsForChange in interface ArrayCollectionMapping

      • convertToChangeRecord

        protected org.eclipse.persistence.internal.sessions.ChangeRecord convertToChangeRecord​(java.lang.Object cloneCollection,
                                                                                       org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                                                                                       org.eclipse.persistence.internal.sessions.AbstractSession session)

      • fixObjectReferences

        public void fixObjectReferences​(java.lang.Object object,
                                java.util.Map objectDescriptors,
                                java.util.Map processedObjects,
                                ObjectLevelReadQuery query,
                                DistributedSession session)
        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.
        Specified by:
        fixObjectReferences in class DatabaseMapping

      • getAttributeElementClass

        public java.lang.Class getAttributeElementClass()
        PUBLIC: Return the class each element in the object's collection should be converted to, before the collection is inserted into the object. This is optional - if left null, the elements will be added to the object's collection unconverted.

      • getField

        public org.eclipse.persistence.internal.helper.DatabaseField getField()
        INTERNAL: Return the field that holds the nested collection.
        Overrides:
        getField in class DatabaseMapping

      • getFieldElementClass

        public java.lang.Class getFieldElementClass()
        PUBLIC: Return the class each element in the database row's collection should be converted to, before the collection is inserted into the database. This is optional - if left null, the elements will be added to the database row's collection unconverted.

      • getFieldName

        public java.lang.String getFieldName()
        PUBLIC: Return the name of the field that holds the nested collection.

      • iterate

        public void iterate​(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator)
        INTERNAL: Iterate on the appropriate attribute value.
        Specified by:
        iterate in class DatabaseMapping

      • mapKeyHasChanged

        public boolean mapKeyHasChanged​(java.lang.Object element,
                                org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Return whether the element's user-defined Map key has changed since it was cloned from the original version. Direct elements are not allowed to have keys.
        Specified by:
        mapKeyHasChanged in interface ArrayCollectionMapping

      • setAttributeElementClass

        public void setAttributeElementClass​(java.lang.Class attributeElementClass)
        PUBLIC: Set the class each element in the object's collection should be converted to, before the collection is inserted into the object. This is optional - if left null, the elements will be added to the object's collection unconverted.

      • setAttributeElementClassName

        public void setAttributeElementClassName​(java.lang.String attributeElementClass)
        PUBLIC: Set the class each element in the object's collection should be converted to, before the collection is inserted into the object. This is optional - if left null, the elements will be added to the object's collection unconverted.

      • setContainerPolicy

        public void setContainerPolicy​(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)
        ADVANCED: Set the mapping's containerPolicy.
        Specified by:
        setContainerPolicy in interface ContainerMapping

      • setField

        public void setField​(org.eclipse.persistence.internal.helper.DatabaseField field)
        Set the field that holds the nested collection.

      • setFieldElementClass

        public void setFieldElementClass​(java.lang.Class fieldElementClass)
        PUBLIC: Set the class each element in the database row's collection should be converted to, before the collection is inserted into the database. This is optional - if left null, the elements will be added to the database row's collection unconverted.

      • useCollectionClass

        public void useCollectionClass​(java.lang.Class concreteClass)
        PUBLIC: Configure the mapping to use an instance of the specified container class to hold the nested objects.

        jdk1.2.x: The container class must implement (directly or indirectly) the Collection interface.

        jdk1.1.x: The container class must be a subclass of Vector.

        Specified by:
        useCollectionClass in interface ContainerMapping

      • useCollectionClassName

        public void useCollectionClassName​(java.lang.String concreteClassName)
        INTERNAL: Used to set the collection class by name. This is required when building from metadata to allow the correct class loader to be used.
        Specified by:
        useCollectionClassName in interface ContainerMapping

      • useListClassName

        public void useListClassName​(java.lang.String concreteClassName)
        INTERNAL: Used to set the collection class by name. This is required when building from metadata to allow the correct class loader to be used.
        Specified by:
        useListClassName in interface ContainerMapping

      • useMapClass

        public void useMapClass​(java.lang.Class concreteClass,
                        java.lang.String methodName)
        PUBLIC: Mapping does not support Map containers. It supports only Collection containers.
        Specified by:
        useMapClass in interface ContainerMapping

      • useMapClassName

        public void useMapClassName​(java.lang.String concreteContainerClassName,
                            java.lang.String methodName)
        Description copied from interface: ContainerMapping
        PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects. The key used to index a value in the Map is the value returned by a call to the specified zero-argument method. The method must be implemented by the class (or a superclass) of any value to be inserted into the Map.

        The container class must implement (directly or indirectly) the java.util.Map interface.

        To facilitate resolving the method, the mapping's referenceClass must set before calling this method.

        Specified by:
        useMapClassName in interface ContainerMapping

      • setUsesSingleNode

        public void setUsesSingleNode​(boolean usesSingleNode)
        PUBLIC: Sets whether the mapping uses a single node.
        Parameters:
        usesSingleNode - true if the items in the collection are in a single node or false if each of the items in the collection is in its own node

      • usesSingleNode

        public boolean usesSingleNode()
        PUBLIC: Checks whether the mapping uses a single node.
        Returns:
        True if the items in the collection are in a single node or false if each of the items in the collection is in its own node.

      • valueFromRow

        public java.lang.Object valueFromRow​(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                     org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                     ObjectBuildingQuery sourceQuery,
                                     org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                                     org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                                     boolean isTargetProtected,
                                     java.lang.Boolean[] wasCacheUsed)
                              throws DatabaseException
        INTERNAL: Build the nested collection from the database row.
        Overrides:
        valueFromRow in class DatabaseMapping
        Throws:
        DatabaseException

      • writeFromObjectIntoRow

        public void writeFromObjectIntoRow​(java.lang.Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   DatabaseMapping.WriteType writeType)
        INTERNAL: Get the attribute value from the object and store it in the appropriate field of the row.
        Overrides:
        writeFromObjectIntoRow in class DatabaseMapping

      • writeFromObjectIntoRowWithChangeRecord

        public void writeFromObjectIntoRowWithChangeRecord​(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                   DatabaseMapping.WriteType writeType)
        INTERNAL: Get the appropriate attribute value from the object and put it in the appropriate field of the database row. Loop through the reference objects and extract the primary keys and put them in the vector of "nested" rows.
        Overrides:
        writeFromObjectIntoRowWithChangeRecord in class DatabaseMapping

      • writeInsertFieldsIntoRow

        public void writeInsertFieldsIntoRow​(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                     org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Write the fields needed for insert into the template with null values.
        Overrides:
        writeInsertFieldsIntoRow in class DatabaseMapping

      • getFieldClassification

        public java.lang.Class getFieldClassification​(org.eclipse.persistence.internal.helper.DatabaseField fieldToClassify)
        INTERNAL: Return the classifiction for the field contained in the mapping. This is used to convert the row value to a consistent java value. By default this is unknown.
        Overrides:
        getFieldClassification in class DatabaseMapping

      • convertClassNamesToClasses

        public void convertClassNamesToClasses​(java.lang.ClassLoader classLoader)
        Description copied from class: DatabaseMapping
        INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings This method is implemented by subclasses as necessary.
        Overrides:
        convertClassNamesToClasses in class DatabaseMapping

      • compareForChange

        public org.eclipse.persistence.internal.sessions.ChangeRecord compareForChange​(java.lang.Object clone,
                                                                               java.lang.Object backup,
                                                                               org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                                                                               org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Build and return the change record that results from comparing the two direct collection attributes.
        Specified by:
        compareForChange in class DatabaseMapping
        Returns:
        prototype.changeset.ChangeRecord

      • compareObjects

        public boolean compareObjects​(java.lang.Object object1,
                              java.lang.Object object2,
                              org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Compare the attributes belonging to this mapping for the objects.
        Specified by:
        compareObjects in class DatabaseMapping

      • mergeChangesIntoObject

        public void mergeChangesIntoObject​(java.lang.Object target,
                                   org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                                   java.lang.Object source,
                                   org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                   org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
        INTERNAL: Merge changes from the source to the target object.
        Specified by:
        mergeChangesIntoObject in class DatabaseMapping

      • mergeIntoObject

        public void mergeIntoObject​(java.lang.Object target,
                            boolean isTargetUnInitialized,
                            java.lang.Object source,
                            org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                            org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
        INTERNAL: Merge changes from the source to the target object. Simply replace the entire target collection.
        Specified by:
        mergeIntoObject in class DatabaseMapping

      • simpleAddToCollectionChangeRecord

        public void simpleAddToCollectionChangeRecord​(java.lang.Object referenceKey,
                                              java.lang.Object changeSetToAdd,
                                              org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                              org.eclipse.persistence.internal.sessions.AbstractSession session)
        ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
        Overrides:
        simpleAddToCollectionChangeRecord in class DatabaseMapping

      • simpleRemoveFromCollectionChangeRecord

        public void simpleRemoveFromCollectionChangeRecord​(java.lang.Object referenceKey,
                                                   java.lang.Object changeSetToRemove,
                                                   org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                                   org.eclipse.persistence.internal.sessions.AbstractSession session)
        ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
        Overrides:
        simpleRemoveFromCollectionChangeRecord in class DatabaseMapping

      • createMapComponentFromRow

        public java.lang.Object createMapComponentFromRow​(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow,
                                                  ObjectBuildingQuery query,
                                                  org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                                                  org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                  boolean isTargetProtected)
        INTERNAL Called when a DatabaseMapping is used to map the key in a collection. Returns the key.