ArrayCollectionMapping (EclipseLink 2.6.0, API Reference)

All Superinterfaces:

ContainerMapping

All Known Implementing Classes:

AbstractCompositeCollectionMapping, AbstractCompositeDirectCollectionMapping, ArrayMapping, EISCompositeCollectionMapping, EISCompositeDirectCollectionMapping, ObjectArrayMapping, XMLBinaryDataCollectionMapping, XMLCompositeCollectionMapping, XMLCompositeDirectCollectionMapping, XMLFragmentCollectionMapping, XMLVariableXPathCollectionMapping
```
public interface ArrayCollectionMapping
extends ContainerMapping
```
Interface used by the ArrayCollectionMappingHelper to interact with the assorted array collection mappings.

See Also:
ArrayCollectionMappingHelper

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`buildAddedElementFromChangeSet(java.lang.Object changeSet, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` Build and return a newly-added element based on the change set.
`java.lang.Object`	`buildChangeSet(java.lang.Object element, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, org.eclipse.persistence.internal.sessions.AbstractSession session)` Build and return a change set for the specified element.
`java.lang.Object`	`buildElementFromElement(java.lang.Object element, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` Build and return a new element based on the specified element.
`java.lang.Object`	`buildRemovedElementFromChangeSet(java.lang.Object changeSet, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` Build and return a recently-removed element based on the change set.
`boolean`	`compareElements(java.lang.Object element1, java.lang.Object element2, org.eclipse.persistence.internal.sessions.AbstractSession session)` Compare the non-null elements and return true if they are alike.
`boolean`	`compareElementsForChange(java.lang.Object element1, java.lang.Object element2, org.eclipse.persistence.internal.sessions.AbstractSession session)` Compare the non-null elements and return true if they are alike.
`java.lang.String`	`getAttributeName()` Return the mapping's attribute name.
`java.lang.Object`	`getRealCollectionAttributeValueFromObject(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session)` Return the attribute value from the specified object, unwrapping the value holder if necessary.
`boolean`	`mapKeyHasChanged(java.lang.Object element, org.eclipse.persistence.internal.sessions.AbstractSession session)` Return whether the element's user-defined Map key has changed since it was cloned from the original version.
`void`	`setRealAttributeValueInObject(java.lang.Object object, java.lang.Object attributeValue)` Set the attribute value for the specified object, wrapping it in a value holder if necessary.

Methods inherited from interface org.eclipse.persistence.mappings.ContainerMapping
getContainerPolicy, setContainerPolicy, useCollectionClass, useCollectionClassName, useListClassName, useMapClass, useMapClassName

Method Detail

buildAddedElementFromChangeSet

java.lang.Object buildAddedElementFromChangeSet(java.lang.Object changeSet,
                                              org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                              org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

Build and return a newly-added element based on the change set.

buildChangeSet

java.lang.Object buildChangeSet(java.lang.Object element,
                              org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                              org.eclipse.persistence.internal.sessions.AbstractSession session)

Build and return a change set for the specified element.

buildElementFromElement

java.lang.Object buildElementFromElement(java.lang.Object element,
                                       org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                       org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

Build and return a new element based on the specified element.

buildRemovedElementFromChangeSet

java.lang.Object buildRemovedElementFromChangeSet(java.lang.Object changeSet,
                                                org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

Build and return a recently-removed element based on the change set.

compareElements

boolean compareElements(java.lang.Object element1,
                      java.lang.Object element2,
                      org.eclipse.persistence.internal.sessions.AbstractSession session)

Compare the non-null elements and return true if they are alike.

compareElementsForChange

boolean compareElementsForChange(java.lang.Object element1,
                               java.lang.Object element2,
                               org.eclipse.persistence.internal.sessions.AbstractSession session)

Compare the non-null elements and return true if they are alike. This is used to build a change record.

getAttributeName
```
java.lang.String getAttributeName()
```
Return the mapping's attribute name.

getRealCollectionAttributeValueFromObject

java.lang.Object getRealCollectionAttributeValueFromObject(java.lang.Object object,
                                                         org.eclipse.persistence.internal.sessions.AbstractSession session)

Return the attribute value from the specified object, unwrapping the value holder if necessary. If the value is null, build a new container.

mapKeyHasChanged

boolean mapKeyHasChanged(java.lang.Object element,
                       org.eclipse.persistence.internal.sessions.AbstractSession session)

Return whether the element's user-defined Map key has changed since it was cloned from the original version.

setRealAttributeValueInObject

void setRealAttributeValueInObject(java.lang.Object object,
                                 java.lang.Object attributeValue)

Set the attribute value for the specified object, wrapping it in a value holder if necessary.

Interface ArrayCollectionMapping