oracle.toplink.sdk
Interface SDKCollectionMapping

All Superinterfaces:

ContainerMapping

All Known Implementing Classes:

SDKAggregateCollectionMapping, SDKDirectCollectionMapping, SDKObjectCollectionMapping

public interface SDKCollectionMapping

extends ContainerMapping

Interface used by the SDKCollectionMappingHelper to interact with the assorted SDK collection mappings.

Since:

TOPLink/Java 3.0

See Also:

SDKCollectionMappingHelper

Method Summary

java.lang.Object	buildAddedElementFromChangeSet(java.lang.Object changeSet, oracle.toplink.internal.sessions.MergeManager mergeManager) Build and return a newly-added element based on the change set.
java.lang.Object	buildChangeSet(java.lang.Object element, oracle.toplink.internal.sessions.ObjectChangeSet owner, oracle.toplink.publicinterface.Session session) Build and return a change set for the specified element.
java.lang.Object	buildElementFromElement(java.lang.Object element, oracle.toplink.internal.sessions.MergeManager mergeManager) Build and return a new element based on the specified element.
java.lang.Object	buildRemovedElementFromChangeSet(java.lang.Object changeSet, oracle.toplink.internal.sessions.MergeManager mergeManager) Build and return a recently-removed element based on the change set.
boolean	compareElements(java.lang.Object element1, java.lang.Object element2, oracle.toplink.publicinterface.Session session) Compare the non-null elements and return true if they are alike.
boolean	compareElementsForChange(java.lang.Object element1, java.lang.Object element2, oracle.toplink.publicinterface.Session 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, oracle.toplink.publicinterface.Session session) Return the attribute value from the specified object, unwrapping the value holder if necessary.
boolean	mapKeyHasChanged(java.lang.Object element, oracle.toplink.publicinterface.Session 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 oracle.toplink.mappings.ContainerMapping

getContainerPolicy, setContainerPolicy, useCollectionClass, useMapClass

Method Detail

buildAddedElementFromChangeSet

public java.lang.Object buildAddedElementFromChangeSet(java.lang.Object changeSet,
                                                       oracle.toplink.internal.sessions.MergeManager mergeManager)

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

buildChangeSet

public java.lang.Object buildChangeSet(java.lang.Object element,
                                       oracle.toplink.internal.sessions.ObjectChangeSet owner,
                                       oracle.toplink.publicinterface.Session session)

Build and return a change set for the specified element.

buildElementFromElement

public java.lang.Object buildElementFromElement(java.lang.Object element,
                                                oracle.toplink.internal.sessions.MergeManager mergeManager)

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

buildRemovedElementFromChangeSet

public java.lang.Object buildRemovedElementFromChangeSet(java.lang.Object changeSet,
                                                         oracle.toplink.internal.sessions.MergeManager mergeManager)

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

compareElements

public boolean compareElements(java.lang.Object element1,
                               java.lang.Object element2,
                               oracle.toplink.publicinterface.Session session)

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

compareElementsForChange

public boolean compareElementsForChange(java.lang.Object element1,
                                        java.lang.Object element2,
                                        oracle.toplink.publicinterface.Session session)

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

getAttributeName

public java.lang.String getAttributeName()

Return the mapping's attribute name.

getRealCollectionAttributeValueFromObject

public java.lang.Object getRealCollectionAttributeValueFromObject(java.lang.Object object,
                                                                  oracle.toplink.publicinterface.Session 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

public boolean mapKeyHasChanged(java.lang.Object element,
                                oracle.toplink.publicinterface.Session session)

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

setRealAttributeValueInObject

public 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.