FileDocCategorySizeDatePackage
ContainerMapping.javaAPI DocGlassfish v2 API3629Tue May 22 16:54:46 BST 2007oracle.toplink.essentials.mappings

ContainerMapping

public interface ContainerMapping
Interface used by clients to interact with the assorted mappings that use ContainerPolicy.
see
oracle.toplink.essentials.internal.queryframework.ContainerPolicy
author
Big Country
since
TOPLink/Java 4.0

Fields Summary
Constructors Summary
Methods Summary
public oracle.toplink.essentials.internal.queryframework.ContainerPolicygetContainerPolicy()
PUBLIC: Return the mapping's container policy.

public voidsetContainerPolicy(oracle.toplink.essentials.internal.queryframework.ContainerPolicy containerPolicy)
PUBLIC: Set the mapping's container policy.

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

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