blob: aa1bac248ddc0fbc4a6f9de4ea9ad173236fbba6 [file] [log] [blame]
<!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:38:37 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MapComponentMapping (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="MapComponentMapping (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/foundation/AbstractTransformationMapping.html" title="class in org.eclipse.persistence.mappings.foundation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/mappings/foundation/MapKeyMapping.html" title="interface in org.eclipse.persistence.mappings.foundation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/mappings/foundation/MapComponentMapping.html" target="_top">Frames</a></li>
<li><a href="MapComponentMapping.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.foundation</div>
<h2 title="Interface MapComponentMapping" class="title">Interface MapComponentMapping</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/foundation/MapKeyMapping.html" title="interface in org.eclipse.persistence.mappings.foundation">MapKeyMapping</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/AggregateCollectionMapping.html" title="class in org.eclipse.persistence.mappings">AggregateCollectionMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/AggregateObjectMapping.html" title="class in org.eclipse.persistence.mappings">AggregateObjectMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/DirectMapMapping.html" title="class in org.eclipse.persistence.mappings">DirectMapMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/DirectToFieldMapping.html" title="class in org.eclipse.persistence.mappings">DirectToFieldMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/xdb/DirectToXMLTypeMapping.html" title="class in org.eclipse.persistence.mappings.xdb">DirectToXMLTypeMapping</a>, <a href="../../../../../org/eclipse/persistence/eis/mappings/EISDirectMapping.html" title="class in org.eclipse.persistence.eis.mappings">EISDirectMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings">ManyToManyMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/ManyToOneMapping.html" title="class in org.eclipse.persistence.mappings">ManyToOneMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings">OneToManyMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/OneToOneMapping.html" title="class in org.eclipse.persistence.mappings">OneToOneMapping</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/XMLBinaryDataMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLBinaryDataMapping</a>, <a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLDirectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLDirectMapping</a>, <a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLFragmentMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLFragmentMapping</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MapComponentMapping</span></pre>
<div class="block">A MapComponentMapping is any mapping that can be used as the key or the value
in a mapping that uses a MappedKeyMapContainerPolicy. This interface is generally implemented
by mappings that provide the value in a mapping to a Map. Mappings that provide the key generally
implement sub-interface MapKeyMapping</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>MappedKeyMapContainerPolicy</code>,
<a href="../../../../../org/eclipse/persistence/mappings/foundation/MapKeyMapping.html" title="interface in org.eclipse.persistence.mappings.foundation"><code>MapKeyMapping</code></a>,
<a href="../../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings"><code>DirectCollectionMapping</code></a>,
<a href="../../../../../org/eclipse/persistence/mappings/AggregateCollectionMapping.html" title="class in org.eclipse.persistence.mappings"><code>AggregateCollectionMapping</code></a>,
<a href="../../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>OneToManyMapping</code></a>,
<a href="../../../../../org/eclipse/persistence/mappings/UnidirectionalOneToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>UnidirectionalOneToManyMapping</code></a>,
<a href="../../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>ManyToManyMapping</code></a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>tware</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/foundation/MapComponentMapping.html#clone--">clone</a></span>()</code>
<div class="block">INTERNAL
Called when cloning the container policy.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/foundation/MapComponentMapping.html#createMapComponentFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">createMapComponentFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;dbRow,
<a href="../../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;query,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
boolean&nbsp;isTargetProtected)</code>
<div class="block">INTERNAL
Called when a DatabaseMapping is used to map the key in a collection.</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="createMapComponentFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createMapComponentFromRow</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;createMapComponentFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;dbRow,
<a href="../../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;query,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
boolean&nbsp;isTargetProtected)</pre>
<div class="block">INTERNAL
Called when a DatabaseMapping is used to map the key in a collection. Returns the key.</div>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;clone()</pre>
<div class="block">INTERNAL
Called when cloning the container policy.</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/foundation/AbstractTransformationMapping.html" title="class in org.eclipse.persistence.mappings.foundation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/mappings/foundation/MapKeyMapping.html" title="interface in org.eclipse.persistence.mappings.foundation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/mappings/foundation/MapComponentMapping.html" target="_top">Frames</a></li>
<li><a href="MapComponentMapping.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>