oracle.toplink.mappings.foundation
Class AbstractCompositeCollectionMapping

java.lang.Object
  oracle.toplink.mappings.DatabaseMapping
      oracle.toplink.mappings.AggregateMapping
          oracle.toplink.mappings.foundation.AbstractCompositeCollectionMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ContainerMapping

Direct Known Subclasses:

EISCompositeCollectionMapping, SDKAggregateCollectionMapping, XMLCompositeCollectionMapping

public abstract class AbstractCompositeCollectionMapping
extends AggregateMapping
implements ContainerMapping

See Also:

Serialized Form

Constructor Summary

AbstractCompositeCollectionMapping()
Default constructor.

Method Summary

Converter	getConverter() Return the converter on the mapping.
boolean	hasConverter() Indicates if there is a converter on the mapping.
void	setContainerPolicy(oracle.toplink.internal.queryframework.ContainerPolicy containerPolicy) ADVANCED: Set the mapping's containerPolicy.
void	setConverter(Converter converter) Set the converter on the mapping.
void	setField(DatabaseField field) Set the field in the mapping.
void	simpleAddToCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object changeSetToAdd, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.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.
void	simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object changeSetToRemove, oracle.toplink.internal.sessions.ObjectChangeSet changeSet, oracle.toplink.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.
void	useCollectionClass(java.lang.Class concreteContainerClass) Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useCollectionClassName(java.lang.String concreteContainerClassName)
void	useListClassName(java.lang.String concreteContainerClassName)
void	useMapClass(java.lang.Class concreteContainerClass, java.lang.String methodName) Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useMapClassName(java.lang.String concreteContainerClassName, java.lang.String methodName)

Methods inherited from class oracle.toplink.mappings.AggregateMapping

getReferenceClass, setReferenceClass

Methods inherited from class oracle.toplink.mappings.DatabaseMapping

getAttributeAccessor, getAttributeClassification, getAttributeName, getGetMethodName, getProperty, getSetMethodName, isLazy, isOptional, isUsingMethodAccess, readOnly, readWrite, setAttributeAccessor, setAttributeName, setGetMethodName, setIsLazy, setIsOptional, setIsReadOnly, setProperty, setSetMethodName, setWeight

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompositeCollectionMapping

public AbstractCompositeCollectionMapping()

Default constructor.

Method Detail

getConverter

public Converter getConverter()

Return the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

hasConverter

public boolean hasConverter()

Indicates if there is a converter on the mapping.

setContainerPolicy

public void setContainerPolicy(oracle.toplink.internal.queryframework.ContainerPolicy containerPolicy)

ADVANCED: Set the mapping's containerPolicy.

Specified by:

setContainerPolicy in interface ContainerMapping

setConverter

public void setConverter(Converter converter)

Set the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

setField

public void setField(DatabaseField field)

Set the field in the mapping.

simpleAddToCollectionChangeRecord

public void simpleAddToCollectionChangeRecord(java.lang.Object referenceKey,
                                              java.lang.Object changeSetToAdd,
                                              oracle.toplink.internal.sessions.ObjectChangeSet changeSet,
                                              oracle.toplink.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. PLEASE ENSURE that the changes have been made in the object model first.

Overrides:

simpleAddToCollectionChangeRecord in class DatabaseMapping

simpleRemoveFromCollectionChangeRecord

public void simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey,
                                                   java.lang.Object changeSetToRemove,
                                                   oracle.toplink.internal.sessions.ObjectChangeSet changeSet,
                                                   oracle.toplink.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. PLEASE ENSURE that the changes have been made in the object model first.

Overrides:

simpleRemoveFromCollectionChangeRecord in class DatabaseMapping

useCollectionClass

public void useCollectionClass(java.lang.Class concreteContainerClass)

Configure the mapping to use an instance of the specified container class to hold the target 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 concreteContainerClassName)

useListClassName

public void useListClassName(java.lang.String concreteContainerClassName)

useMapClass

public void useMapClass(java.lang.Class concreteContainerClass,
                        java.lang.String methodName)

Configure the mapping to use an instance of the specified container class to hold the target objects. The key used to index the 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 the value to be inserted into the Map.

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

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

The referenceClass must be set before calling this method.

Specified by:

useMapClass in interface ContainerMapping

useMapClassName

public void useMapClassName(java.lang.String concreteContainerClassName,
                            java.lang.String methodName)