org.eclipse.persistence.mappings
Interface ContainerMapping

All Known Subinterfaces:

ArrayCollectionMapping

All Known Implementing Classes:

AbstractCompositeCollectionMapping, AbstractCompositeDirectCollectionMapping, AggregateCollectionMapping, ArrayMapping, CollectionMapping, DirectCollectionMapping, DirectMapMapping, EISCompositeCollectionMapping, EISCompositeDirectCollectionMapping, EISOneToManyMapping, ManyToManyMapping, NestedTableMapping, ObjectArrayMapping, OneToManyMapping, UnidirectionalOneToManyMapping, XMLAnyCollectionMapping, XMLBinaryDataCollectionMapping, XMLCollectionReferenceMapping, XMLCompositeCollectionMapping, XMLCompositeDirectCollectionMapping, XMLFragmentCollectionMapping, XMLInverseReferenceMapping

public interface ContainerMapping

Interface used by clients to interact with the assorted mappings that use ContainerPolicy.

See Also:

ContainerPolicy

Author:

Big Country

Since:

TOPLink/Java 4.0

Method Summary

org.eclipse.persistence.internal.queries.ContainerPolicy	getContainerPolicy() PUBLIC: Return the mapping's container policy.
void	setContainerPolicy(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy) PUBLIC: Set the mapping's container policy.
void	useCollectionClass(java.lang.Class concreteClass) PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useCollectionClassName(java.lang.String concreteClass) PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useListClassName(java.lang.String concreteClass) PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useMapClass(java.lang.Class concreteClass, java.lang.String methodName) PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useMapClassName(java.lang.String concreteClass, java.lang.String methodName) PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

Method Detail

getContainerPolicy

org.eclipse.persistence.internal.queries.ContainerPolicy getContainerPolicy()

PUBLIC: Return the mapping's container policy.

setContainerPolicy

void setContainerPolicy(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)

PUBLIC: Set the mapping's container policy.

useCollectionClass

void useCollectionClass(java.lang.Class concreteClass)

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

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

useCollectionClassName

void useCollectionClassName(java.lang.String concreteClass)

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

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

useListClassName

void useListClassName(java.lang.String concreteClass)

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

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

useMapClass

void useMapClass(java.lang.Class concreteClass,
                 java.lang.String methodName)

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.

useMapClassName

void useMapClassName(java.lang.String concreteClass,
                     java.lang.String methodName)

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.