| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:04 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ContainerMapping (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ContainerMapping (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/mappings/CollectionMapping.html" title="class in org.eclipse.persistence.mappings"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/mappings/ContainerMapping.html" target="_top">Frames</a></li> |
| <li><a href="ContainerMapping.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.mappings</div> |
| <h2 title="Interface ContainerMapping" class="title">Interface ContainerMapping</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/mappings/structures/ArrayCollectionMapping.html" title="interface in org.eclipse.persistence.mappings.structures">ArrayCollectionMapping</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractCompositeCollectionMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractCompositeCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractCompositeDirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractCompositeDirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/AggregateCollectionMapping.html" title="class in org.eclipse.persistence.mappings">AggregateCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/structures/ArrayMapping.html" title="class in org.eclipse.persistence.mappings.structures">ArrayMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/CollectionMapping.html" title="class in org.eclipse.persistence.mappings">CollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings">DirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DirectMapMapping.html" title="class in org.eclipse.persistence.mappings">DirectMapMapping</a>, <a href="../../../../org/eclipse/persistence/eis/mappings/EISCompositeCollectionMapping.html" title="class in org.eclipse.persistence.eis.mappings">EISCompositeCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/eis/mappings/EISCompositeDirectCollectionMapping.html" title="class in org.eclipse.persistence.eis.mappings">EISCompositeDirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/eis/mappings/EISOneToManyMapping.html" title="class in org.eclipse.persistence.eis.mappings">EISOneToManyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings">ManyToManyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/structures/NestedTableMapping.html" title="class in org.eclipse.persistence.mappings.structures">NestedTableMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/structures/ObjectArrayMapping.html" title="class in org.eclipse.persistence.mappings.structures">ObjectArrayMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings">OneToManyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/UnidirectionalOneToManyMapping.html" title="class in org.eclipse.persistence.mappings">UnidirectionalOneToManyMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLAnyCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAnyCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLBinaryDataCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLBinaryDataCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLCollectionReferenceMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCollectionReferenceMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLCompositeCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCompositeCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLCompositeDirectCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCompositeDirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLFragmentCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLFragmentCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLInverseReferenceMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLInverseReferenceMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLVariableXPathCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLVariableXPathCollectionMapping</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ContainerMapping</span></pre> |
| <div class="block">Interface used by clients to interact |
| with the assorted mappings that use <code>ContainerPolicy</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ContainerPolicy</code></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Big Country</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>TOPLink/Java 4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.queries.ContainerPolicy</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#getContainerPolicy--">getContainerPolicy</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the mapping's container policy.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#setContainerPolicy-org.eclipse.persistence.internal.queries.ContainerPolicy-">setContainerPolicy</a></span>(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)</code> |
| <div class="block">PUBLIC: |
| Set the mapping's container policy.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#useCollectionClass-java.lang.Class-">useCollectionClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> concreteClass)</code> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#useCollectionClassName-java.lang.String-">useCollectionClassName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> concreteClass)</code> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#useListClassName-java.lang.String-">useListClassName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> concreteClass)</code> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#useMapClass-java.lang.Class-java.lang.String-">useMapClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> concreteClass, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> methodName)</code> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html#useMapClassName-java.lang.String-java.lang.String-">useMapClassName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> concreteClass, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> methodName)</code> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getContainerPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContainerPolicy</h4> |
| <pre>org.eclipse.persistence.internal.queries.ContainerPolicy getContainerPolicy()</pre> |
| <div class="block">PUBLIC: |
| Return the mapping's container policy.</div> |
| </li> |
| </ul> |
| <a name="setContainerPolicy-org.eclipse.persistence.internal.queries.ContainerPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContainerPolicy</h4> |
| <pre>void setContainerPolicy(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)</pre> |
| <div class="block">PUBLIC: |
| Set the mapping's container policy.</div> |
| </li> |
| </ul> |
| <a name="useCollectionClass-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useCollectionClass</h4> |
| <pre>void useCollectionClass(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> concreteClass)</pre> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects. |
| <p>The container class must implement (directly or indirectly) the |
| <code>java.util.Collection</code> interface.</div> |
| </li> |
| </ul> |
| <a name="useCollectionClassName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useCollectionClassName</h4> |
| <pre>void useCollectionClassName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> concreteClass)</pre> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects. |
| <p>The container class must implement (directly or indirectly) the |
| <code>java.util.Collection</code> interface.</div> |
| </li> |
| </ul> |
| <a name="useListClassName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useListClassName</h4> |
| <pre>void useListClassName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> concreteClass)</pre> |
| <div class="block">PUBLIC: |
| Configure the mapping to use an instance of the specified container class |
| to hold the target objects. |
| <p>The container class must implement (directly or indirectly) the |
| <code>java.util.List</code> interface.</div> |
| </li> |
| </ul> |
| <a name="useMapClass-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useMapClass</h4> |
| <pre>void useMapClass(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> concreteClass, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> methodName)</pre> |
| <div class="block">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 |
| <code>Map</code> 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 <code>Map</code>. |
| <p>The container class must implement (directly or indirectly) the |
| <code>java.util.Map</code> interface. |
| <p>To facilitate resolving the method, the mapping's referenceClass |
| must set before calling this method.</div> |
| </li> |
| </ul> |
| <a name="useMapClassName-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>useMapClassName</h4> |
| <pre>void useMapClassName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> concreteClass, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> methodName)</pre> |
| <div class="block">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 |
| <code>Map</code> 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 <code>Map</code>. |
| <p>The container class must implement (directly or indirectly) the |
| <code>java.util.Map</code> interface. |
| <p>To facilitate resolving the method, the mapping's referenceClass |
| must set before calling this method.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/mappings/CollectionMapping.html" title="class in org.eclipse.persistence.mappings"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/mappings/ContainerMapping.html" target="_top">Frames</a></li> |
| <li><a href="ContainerMapping.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
