Top Description Methods
org.eclipse.persistence.mappings

public Interface ContainerMapping

Known Direct Subinterfaces
org.eclipse.persistence.mappings.structures.ArrayCollectionMapping
Known Direct Implementers
org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping, org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping, org.eclipse.persistence.oxm.mappings.XMLAnyCollectionMapping, org.eclipse.persistence.oxm.mappings.XMLCollectionReferenceMapping, org.eclipse.persistence.oxm.mappings.XMLInverseReferenceMapping, org.eclipse.persistence.mappings.CollectionMapping
Imports
org.eclipse.persistence.internal.queries.*

Interface used by clients to interact with the assorted mappings that use ContainerPolicy.
Author
Big Country
Since
TOPLink/Java 4.0
See Also
org.eclipse.persistence.internal.queries.ContainerPolicy

Method Summary

Modifier and TypeMethod and Description
public ContainerPolicy
getContainerPolicy()

PUBLIC: Return the mapping's container policy.

public void
setContainerPolicy(ContainerPolicy containerPolicy)

PUBLIC: Set the mapping's container policy.

public void
useCollectionClass(Class<?> concreteClass)

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

public void
useCollectionClassName(String concreteClass)

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

public void
useListClassName(String concreteClass)

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

public void
useMapClass(Class<?> concreteClass, String methodName)

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

public void
useMapClassName(String concreteClass, String methodName)

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

Method Detail

getContainerPolicyback to summary
public ContainerPolicy getContainerPolicy()

PUBLIC: Return the mapping's container policy.

setContainerPolicyback to summary
public void setContainerPolicy(ContainerPolicy containerPolicy)

PUBLIC: Set the mapping's container policy.

useCollectionClassback to summary
public void useCollectionClass(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.

useCollectionClassNameback to summary
public void useCollectionClassName(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.

useListClassNameback to summary
public void useListClassName(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.

useMapClassback to summary
public void useMapClass(Class<?> concreteClass, 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.

useMapClassNameback to summary
public void useMapClassName(String concreteClass, 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.