Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / refs/heads/master / . / api / 3.0 / org / eclipse / persistence / mappings / ForeignReferenceMapping.html
blob: f72d30b607571d807242e31fdbe0798e948c2677 [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:39:05 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ForeignReferenceMapping (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="ForeignReferenceMapping (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10,"i6":10,"i7":6,"i8":10,"i9":6,"i10":10,"i11":10,"i12":6,"i13":10,"i14":6,"i15":6,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":6,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":6,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":6,"i147":10,"i148":10,"i149":10,"i150":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/EmbeddableMapping.html" title="interface in org.eclipse.persistence.mappings"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/mappings/ForeignReferenceMapping.html" target="_top">Frames</a></li>
<li><a href="ForeignReferenceMapping.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><a href="#nested.classes.inherited.from.class.org.eclipse.persistence.mappings.DatabaseMapping">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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</div>
<h2 title="Class ForeignReferenceMapping" class="title">Class ForeignReferenceMapping</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">org.eclipse.persistence.core.mappings.CoreMapping</a>&lt;<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">org.eclipse.persistence.mappings.DatabaseMapping</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.mappings.ForeignReferenceMapping</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/eclipse/persistence/mappings/CollectionMapping.html" title="class in org.eclipse.persistence.mappings">CollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/ObjectReferenceMapping.html" title="class in org.eclipse.persistence.mappings">ObjectReferenceMapping</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ForeignReferenceMapping</span>
extends <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></pre>
<div class="block"><b>Purpose</b>: Abstract class for relationship mappings</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.eclipse.persistence.mappings.ForeignReferenceMapping">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.persistence.mappings.DatabaseMapping">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.persistence.mappings.<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></h3>
<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations">BatchFetchType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#batchFetchType">batchFetchType</a></span></code>
<div class="block">Indicates whether the referenced object should always be batch read on read all queries,
and defines the type of batch fetch to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#cascadeDetach">cascadeDetach</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#cascadeMerge">cascadeMerge</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#cascadePersist">cascadePersist</a></span></code>
<div class="block">Cascading flags used by the EntityManager</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#cascadeRefresh">cascadeRefresh</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#cascadeRemove">cascadeRemove</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#forceInitializationOfSelectionCriteria">forceInitializationOfSelectionCriteria</a></span></code>
<div class="block">This is a way (after cloning) to force the initialization of the selection criteria</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#hasCustomSelectionQuery">hasCustomSelectionQuery</a></span></code>
<div class="block">Indicates whether the selection query is TopLink generated or defined by the user.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.indirection.IndirectionPolicy</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#indirectionPolicy">indirectionPolicy</a></span></code>
<div class="block">Implements indirection behavior</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#INNER_JOIN">INNER_JOIN</a></span></code>
<div class="block">Specify any INNER join on a join fetch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadeOnDeleteSetOnDatabase">isCascadeOnDeleteSetOnDatabase</a></span></code>
<div class="block">Support delete cascading on the database relationship constraint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isPrivateOwned">isPrivateOwned</a></span></code>
<div class="block">Indicates whether the referenced object is privately owned or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#joinFetch">joinFetch</a></span></code>
<div class="block">Define if the relationship should always be join fetched.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#mappedBy">mappedBy</a></span></code>
<div class="block">Stores JPA metadata about whether another mapping is the owning mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#NONE">NONE</a></span></code>
<div class="block">Specify no join fetch, this is the default.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#OUTER_JOIN">OUTER_JOIN</a></span></code>
<div class="block">Specify any OUTER join on a join fetch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#partitioningPolicy">partitioningPolicy</a></span></code>
<div class="block">Allow the mapping's queries to be targeted at specific connection pools.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#partitioningPolicyName">partitioningPolicyName</a></span></code>
<div class="block">Allow the mapping's queries to be targeted at specific connection pools.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#QUERY_BATCH_PARAMETER">QUERY_BATCH_PARAMETER</a></span></code>
<div class="block">Query parameter name used for IN batch ids.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#referenceClass">referenceClass</a></span></code>
<div class="block">This is used only in descriptor proxy in remote session</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#referenceClassName">referenceClassName</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#referenceDescriptor">referenceDescriptor</a></span></code>
<div class="block">The descriptor of the reference class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#relationshipPartner">relationshipPartner</a></span></code>
<div class="block">Used to reference the other half of a bi-directional relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#relationshipPartnerAttributeName">relationshipPartnerAttributeName</a></span></code>
<div class="block">Set by users, used to retrieve the backpointer for this mapping</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#requiresTransientWeavedFields">requiresTransientWeavedFields</a></span></code>
<div class="block">Flag used to determine if we need to weave the transient annotation on weaved fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#selectionQuery">selectionQuery</a></span></code>
<div class="block">This query is used to read referenced objects for this mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#tempInitSession">tempInitSession</a></span></code>
<div class="block">The session is temporarily used for initialization.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.mappings.DatabaseMapping">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.mappings.<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></h3>
<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#attributeAccessor">attributeAccessor</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#attributeName">attributeName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#derivedIdMapping">derivedIdMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#derivesId">derivesId</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#descriptor">descriptor</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#fields">fields</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCacheable">isCacheable</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInSopObject">isInSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isJPAId">isJPAId</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isLazy">isLazy</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isMapKeyMapping">isMapKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOptional">isOptional</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isPrimaryKeyMapping">isPrimaryKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isReadOnly">isReadOnly</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isRemotelyInitialized">isRemotelyInitialized</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#mapsIdValue">mapsIdValue</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#NO_FIELDS">NO_FIELDS</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#NO_WEIGHT">NO_WEIGHT</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#properties">properties</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#unconvertedProperties">unconvertedProperties</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#weight">weight</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_AGGREGATE">WEIGHT_AGGREGATE</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_DIRECT">WEIGHT_DIRECT</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_TO_ONE">WEIGHT_TO_ONE</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_TRANSFORM">WEIGHT_TRANSFORM</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#ForeignReferenceMapping--">ForeignReferenceMapping</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#addForeignKeyField-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.helper.DatabaseField-">addForeignKeyField</a></span>(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;sourceForeignKeyField,
org.eclipse.persistence.internal.helper.DatabaseField&nbsp;targetPrimaryKeyField)</code>
<div class="block">INTERNAL:
Allow subclass to define a foreign key in the source's table.</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/ForeignReferenceMapping.html#addTargetForeignKeyField-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.helper.DatabaseField-">addTargetForeignKeyField</a></span>(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;targetForeignKeyField,
org.eclipse.persistence.internal.helper.DatabaseField&nbsp;sourcePrimaryKeyField)</code>
<div class="block">INTERNAL:
Allow subclass to define a foreign key in the target's table.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <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/ForeignReferenceMapping.html#batchedValueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-">batchedValueFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey)</code>
<div class="block">INTERNAL:
Retrieve the value through using batch reading.</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/ForeignReferenceMapping.html#buildBackupClone-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">buildBackupClone</a></span>(<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,
<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;backup,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork)</code>
<div class="block">INTERNAL:
Clone the attribute from the clone and assign it to the backup.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <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/ForeignReferenceMapping.html#buildBackupCloneForPartObject-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">buildBackupCloneForPartObject</a></span>(<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;attributeValue,
<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,
<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;backup,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork)</code>
<div class="block">INTERNAL:
Used during building the backup shallow copy to copy the
target object without re-registering it.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#buildBatchCriteria-org.eclipse.persistence.expressions.ExpressionBuilder-org.eclipse.persistence.queries.ObjectLevelReadQuery-">buildBatchCriteria</a></span>(<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a>&nbsp;builder,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</code>
<div class="block">INTERNAL:
Return the selection criteria used to IN batch fetching.</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/ForeignReferenceMapping.html#buildClone-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-java.lang.Integer-org.eclipse.persistence.internal.sessions.AbstractSession-">buildClone</a></span>(<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;original,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey,
<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,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;refreshCascade,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;cloningSession)</code>
<div class="block">INTERNAL:
Clone the attribute from the original and assign it to the clone.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract <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/ForeignReferenceMapping.html#buildCloneForPartObject-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Integer-boolean-boolean-">buildCloneForPartObject</a></span>(<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;attributeValue,
<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;original,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey,
<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,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;cloningSession,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;refreshCascade,
boolean&nbsp;isExisting,
boolean&nbsp;isFromSharedCache)</code>
<div class="block">INTERNAL:
Require for cloning, the part must be cloned.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#buildCloneFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-">buildCloneFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;databaseRow,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<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,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;sharedCacheKey,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
<div class="block">INTERNAL:
A combination of readFromRowIntoObject and buildClone.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <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/ForeignReferenceMapping.html#buildReferencesPKList-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">buildReferencesPKList</a></span>(<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;entity,
<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;attribute,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
This method will access the target relationship and create a list of information to rebuild the relationship.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <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/ForeignReferenceMapping.html#checkCacheForBatchKey-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-java.util.Map-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">checkCacheForBatchKey</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;sourceRow,
<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;foreignKey,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;batchObjects,
<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;batchQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;originalQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Check if the target object is in the cache if possible based on the source row.</div>
</td>
</tr>
<tr id="i11" 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/ForeignReferenceMapping.html#clone--">clone</a></span>()</code>
<div class="block">INTERNAL:
The mapping clones itself to create deep copy.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#collectQueryParameters-java.util.Set-">collectQueryParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;&nbsp;cacheFields)</code>
<div class="block">INTERNAL:
This method is used to store the FK fields that can be cached that correspond to noncacheable mappings
the FK field values will be used to re-issue the query when cloning the shared cache entity</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#compareObjects-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">compareObjects</a></span>(<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;firstObject,
<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;secondObject,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL: Compare the attributes belonging to this mapping for the
objects.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#compareObjectsWithoutPrivateOwned-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">compareObjectsWithoutPrivateOwned</a></span>(<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;first,
<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;second,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">Compare two objects if their parts are not private owned</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#compareObjectsWithPrivateOwned-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">compareObjectsWithPrivateOwned</a></span>(<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;first,
<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;second,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">Compare two objects if their parts are private owned</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</code>
<div class="block">INTERNAL:
Convert all the class-name-based settings in this mapping to actual class-based
settings.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.indirection.DatabaseValueHolder</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#createCloneValueHolder-org.eclipse.persistence.indirection.ValueHolderInterface-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">createCloneValueHolder</a></span>(<a href="../../../../org/eclipse/persistence/indirection/ValueHolderInterface.html" title="interface in org.eclipse.persistence.indirection">ValueHolderInterface</a>&nbsp;attributeValue,
<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;original,
<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,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;cloningSession,
boolean&nbsp;buildDirectlyFromRow)</code>
<div class="block">INTERNAL:
Builder the unit of work value holder.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#dontDoMerge-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-">dontDoMerge</a></span>(<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;target,
<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;source,
org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</code>
<div class="block">INTERNAL:
Return true if the merge should be bypassed.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#dontUseBatchReading--">dontUseBatchReading</a></span>()</code>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#dontUseIndirection--">dontUseIndirection</a></span>()</code>
<div class="block">PUBLIC:
Indirection means that a ValueHolder will be put in-between the attribute and the real object.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#executeBatchQuery-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-java.util.Map-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">executeBatchQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;referenceObjectsByKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</code>
<div class="block">INTERNAL:
Prepare and execute the batch query and store the
results for each source object in a map keyed by the
mappings source keys of the source objects.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#extendPessimisticLockScopeInSourceQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-">extendPessimisticLockScopeInSourceQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;sourceQuery)</code>
<div class="block">INTERNAL:
Called if shouldExtendPessimisticLockScopeInSourceQuery is true.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#extendPessimisticLockScopeInTargetQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.queries.ObjectBuildingQuery-">extendPessimisticLockScopeInTargetQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;targetQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery)</code>
<div class="block">INTERNAL:
Called if shouldExtendPessimisticLockScopeInTargetQuery() is true.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>protected <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/ForeignReferenceMapping.html#extractBatchKeyFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">extractBatchKeyFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;targetRow,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Extract the batch key value from the source row.</div>
</td>
</tr>
<tr id="i25" 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/ForeignReferenceMapping.html#extractResultFromBatchQuery-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.ObjectLevelReadQuery-">extractResultFromBatchQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;batchQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;sourceRow,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;originalQuery)</code>
<div class="block">INTERNAL:
Extract the value from the batch optimized query, this should be supported by most query types.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#fixObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-">fixObjectReferences</a></span>(<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;object,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;objectDescriptors,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;processedObjects,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query,
<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a>&nbsp;session)</code>
<div class="block">INTERNAL:
An object has been serialized from the server to the client.</div>
</td>
</tr>
<tr id="i27" 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/ForeignReferenceMapping.html#getAttributeValueFromObject-java.lang.Object-">getAttributeValueFromObject</a></span>(<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;object)</code>
<div class="block">INTERNAL:
Return the value of an attribute which this mapping represents for an object.</div>
</td>
</tr>
<tr id="i28" 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/ForeignReferenceMapping.html#getAttributeValueWithClonedValueHolders-java.lang.Object-">getAttributeValueWithClonedValueHolders</a></span>(<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;object)</code>
<div class="block">INTERNAL:
Returns the attribute value from the reference object.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations">BatchFetchType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getBatchFetchType--">getBatchFetchType</a></span>()</code>
<div class="block">PUBLIC:
Return the type of batch fetching to use for all queries for this class if configured.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getExtendPessimisticLockScopeDedicatedQuery-org.eclipse.persistence.internal.sessions.AbstractSession-short-">getExtendPessimisticLockScopeDedicatedQuery</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
short&nbsp;lockMode)</code>
<div class="block">INTERNAL:
Should be overridden by subclass that allows setting
extendPessimisticLockScope to DEDICATED_QUERY.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getFieldsForTranslationInAggregate--">getFieldsForTranslationInAggregate</a></span>()</code>
<div class="block">INTERNAL:
Return source key fields for translation by an AggregateObjectMapping
By default, return an empty NonSynchronizedVector</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.indirection.IndirectionPolicy</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getIndirectionPolicy--">getIndirectionPolicy</a></span>()</code>
<div class="block">INTERNAL:
Return the mapping's indirection policy.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getJoinCriteria-org.eclipse.persistence.internal.expressions.ObjectExpression-org.eclipse.persistence.expressions.Expression-">getJoinCriteria</a></span>(org.eclipse.persistence.internal.expressions.ObjectExpression&nbsp;context,
<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;base)</code>
<div class="block">INTERNAL:
Returns the join criteria stored in the mapping selection query.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getJoinFetch--">getJoinFetch</a></span>()</code>
<div class="block">PUBLIC:
Return if this relationship should always be join fetched.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getMappedBy--">getMappedBy</a></span>()</code>
<div class="block">ADVANCED: Allows the retrieval of the owning mapping for a particular
mapping.</div>
</td>
</tr>
<tr id="i36" 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/ForeignReferenceMapping.html#getObjectCorrespondingTo-java.lang.Object-org.eclipse.persistence.sessions.remote.DistributedSession-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-">getObjectCorrespondingTo</a></span>(<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;object,
<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a>&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;objectDescriptors,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;processedObjects,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</code>
<div class="block">INTERNAL:
return the object on the client corresponding to the specified object.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getOrderByNormalizedExpressions-org.eclipse.persistence.expressions.Expression-">getOrderByNormalizedExpressions</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;base)</code>
<div class="block">INTERNAL:
Relationships order by their target primary key fields by default.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getPartitioningPolicy--">getPartitioningPolicy</a></span>()</code>
<div class="block">PUBLIC:
Return the mapping's partitioning policy.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getPartitioningPolicyName--">getPartitioningPolicyName</a></span>()</code>
<div class="block">PUBLIC:
Return the name of the mapping's partitioning policy.</div>
</td>
</tr>
<tr id="i40" 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/ForeignReferenceMapping.html#getRealAttributeValueFromAttribute-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealAttributeValueFromAttribute</a></span>(<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;attributeValue,
<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;object,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Returns the attribute value from the reference object.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getReferenceClass--">getReferenceClass</a></span>()</code>
<div class="block">PUBLIC:
Returns the reference class.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getReferenceClassName--">getReferenceClassName</a></span>()</code>
<div class="block">INTERNAL:
Returns the reference class name.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getReferenceDescriptor--">getReferenceDescriptor</a></span>()</code>
<div class="block">INTERNAL:
Return the referenceDescriptor.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getRelationshipPartner--">getRelationshipPartner</a></span>()</code>
<div class="block">INTERNAL:
Return the relationshipPartner mapping for this bi-directional mapping.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getRelationshipPartnerAttributeName--">getRelationshipPartnerAttributeName</a></span>()</code>
<div class="block">PUBLIC:
Use this method retrieve the relationship partner attribute name of this bidirectional Mapping.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getSelectionCriteria--">getSelectionCriteria</a></span>()</code>
<div class="block">INTERNAL:
Returns the selection criteria stored in the mapping selection query.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getSelectionQuery--">getSelectionQuery</a></span>()</code>
<div class="block">INTERNAL:
Returns the read query associated with the mapping.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#getTempSession--">getTempSession</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i49" 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/ForeignReferenceMapping.html#getValueFromRemoteValueHolder-org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder-">getValueFromRemoteValueHolder</a></span>(org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder&nbsp;remoteValueHolder)</code>
<div class="block">INTERNAL:
Extract and return the appropriate value from the
specified remote value holder.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#hasCustomSelectionQuery--">hasCustomSelectionQuery</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether the selection query is TopLink generated or defined by
the user.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#hasDependency--">hasDependency</a></span>()</code>
<div class="block">INTERNAL:
Return if the mapping has any ownership or other dependency over its target object(s).</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#hasNestedIdentityReference--">hasNestedIdentityReference</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether the mapping (or at least one of its nested mappings, at any nested depth)
references an entity.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Initialize the state of mapping.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#initializeReferenceDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">initializeReferenceDescriptor</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">Initialize and set the descriptor for the referenced class in this mapping.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#initializeSelectionQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">initializeSelectionQuery</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">A subclass should implement this method if it wants non default behavior.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#instantiateAttribute-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">instantiateAttribute</a></span>(<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;object,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Trigger the instantiation of the attribute if lazy.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isAttributeValueFromObjectInstantiated-java.lang.Object-">isAttributeValueFromObjectInstantiated</a></span>(<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;object)</code>
<div class="block">INTERNAL:
Return whether the specified object is instantiated.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isAttributeValueFullyBuilt-java.lang.Object-">isAttributeValueFullyBuilt</a></span>(<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;object)</code>
<div class="block">INTERNAL:
The method validateAttributeOfInstantiatedObject(Object attributeValue) fixes the value of the attributeValue
in cases where it is null and indirection requires that it contain some specific data structure.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isAttributeValueInstantiated-java.lang.Object-">isAttributeValueInstantiated</a></span>(<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;object)</code>
<div class="block">INTERNAL:
The referenced object is checked if it is instantiated or not</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadeDetach--">isCascadeDetach</a></span>()</code>
<div class="block">PUBLIC:
Check cascading value for the detach operation.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadeMerge--">isCascadeMerge</a></span>()</code>
<div class="block">PUBLIC:
Check cascading value for the MERGE operation.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadeOnDeleteSetOnDatabase--">isCascadeOnDeleteSetOnDatabase</a></span>()</code>
<div class="block">ADVANCED:
Return if delete cascading has been set on the database for the
mapping's foreign key constraint.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadePersist--">isCascadePersist</a></span>()</code>
<div class="block">PUBLIC:
Check cascading value for the CREATE operation.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadeRefresh--">isCascadeRefresh</a></span>()</code>
<div class="block">PUBLIC:
Check cascading value for the REFRESH operation.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isCascadeRemove--">isCascadeRemove</a></span>()</code>
<div class="block">PUBLIC:
Check cascading value for the REMOVE operation.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isExtendingPessimisticLockScope-org.eclipse.persistence.queries.ObjectBuildingQuery-">isExtendingPessimisticLockScope</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery)</code>
<div class="block">INTERNAL:
Indicates whether the source query's pessimistic lock scope scope should be extended in the target query.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isForeignReferenceMapping--">isForeignReferenceMapping</a></span>()</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isInnerJoinFetched--">isInnerJoinFetched</a></span>()</code>
<div class="block">PUBLIC:
Return if this relationship should always be INNER join fetched.</div>
</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isJoinFetched--">isJoinFetched</a></span>()</code>
<div class="block">PUBLIC:
Return if this relationship should always be join fetched.</div>
</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isJoiningSupported--">isJoiningSupported</a></span>()</code>
<div class="block">INTERNAL:
Return if this mapping supports joining.</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isLazy--">isLazy</a></span>()</code>
<div class="block">Return if this mapping is lazy.</div>
</td>
</tr>
<tr id="i72" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isLockableMapping--">isLockableMapping</a></span>()</code>
<div class="block">INTERNAL:
Return whether this mapping should be traversed when we are locking.</div>
</td>
</tr>
<tr id="i73" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isOuterJoinFetched--">isOuterJoinFetched</a></span>()</code>
<div class="block">PUBLIC:
Return if this relationship should always be OUTER join fetched.</div>
</td>
</tr>
<tr id="i74" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#isPrivateOwned--">isPrivateOwned</a></span>()</code>
<div class="block">PUBLIC:
Return true if referenced objects are privately owned else false.</div>
</td>
</tr>
<tr id="i75" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#iterate-org.eclipse.persistence.internal.descriptors.DescriptorIterator-">iterate</a></span>(org.eclipse.persistence.internal.descriptors.DescriptorIterator&nbsp;iterator)</code>
<div class="block">INTERNAL:
Iterate on the iterator's current object's attribute defined by this mapping.</div>
</td>
</tr>
<tr id="i76" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#iterateOnRealAttributeValue-org.eclipse.persistence.internal.descriptors.DescriptorIterator-java.lang.Object-">iterateOnRealAttributeValue</a></span>(org.eclipse.persistence.internal.descriptors.DescriptorIterator&nbsp;iterator,
<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;realAttributeValue)</code>
<div class="block">INTERNAL:
Iterate on the attribute value.</div>
</td>
</tr>
<tr id="i77" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#load-java.lang.Object-org.eclipse.persistence.internal.queries.AttributeItem-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">load</a></span>(<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;object,
org.eclipse.persistence.internal.queries.AttributeItem&nbsp;item,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
boolean&nbsp;fromFetchGroup)</code>
<div class="block">Force instantiation of the load group.</div>
</td>
</tr>
<tr id="i78" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#mergeRemoteValueHolder-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-">mergeRemoteValueHolder</a></span>(<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;clientSideDomainObject,
<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;serverSideDomainObject,
org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</code>
<div class="block">INTERNAL:
Replace the client value holder with the server value holder,
after copying some of the settings from the client value holder.</div>
</td>
</tr>
<tr id="i79" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#postPrepareNestedBatchQuery-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-">postPrepareNestedBatchQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;batchQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</code>
<div class="block">INTERNAL:
Allow the mapping the do any further batch preparation.</div>
</td>
</tr>
<tr id="i80" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#preInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">preInitialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Initialize the state of mapping.</div>
</td>
</tr>
<tr id="i81" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#prepareHistoricalQuery-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">prepareHistoricalQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;targetQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
<div class="block">INTERNAL:
Allow for the mapping to perform any historical query additions.</div>
</td>
</tr>
<tr id="i82" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#prepareNestedBatchQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-">prepareNestedBatchQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</code>
<div class="block">INTERNAL:
Clone and prepare the selection query as a nested batch read query.</div>
</td>
</tr>
<tr id="i83" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#prepareNestedJoinQueryClone-org.eclipse.persistence.internal.sessions.AbstractRecord-java.util.List-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">prepareNestedJoinQueryClone</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;dataResults,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
<div class="block">INTERNAL:
Prepare the clone of the nested query for joining.</div>
</td>
</tr>
<tr id="i84" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#prepareNestedJoins-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">prepareNestedJoins</a></span>(org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;baseQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Clone and prepare the JoinedAttributeManager nested JoinedAttributeManager.</div>
</td>
</tr>
<tr id="i85" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#privateOwnedRelationship--">privateOwnedRelationship</a></span>()</code>
<div class="block">PUBLIC:
Sets the reference object to be a private owned.</div>
</td>
</tr>
<tr id="i86" 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/ForeignReferenceMapping.html#readFromRowIntoObject-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">readFromRowIntoObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;databaseRow,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<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;targetObject,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;isTargetProtected)</code>
<div class="block">INTERNAL:
Extract value from the row and set the attribute to this value in the object.</div>
</td>
</tr>
<tr id="i87" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#remoteInitialization-org.eclipse.persistence.sessions.remote.DistributedSession-">remoteInitialization</a></span>(<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a>&nbsp;session)</code>
<div class="block">INTERNAL:
Once descriptors are serialized to the remote session.</div>
</td>
</tr>
<tr id="i88" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-">replaceValueHoldersIn</a></span>(<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;object,
org.eclipse.persistence.internal.sessions.remote.RemoteSessionController&nbsp;controller)</code>
<div class="block">INTERNAL:
replace the value holders in the specified reference object(s)</div>
</td>
</tr>
<tr id="i89" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#requiresTransientWeavedFields--">requiresTransientWeavedFields</a></span>()</code>
<div class="block">Returns true if this mappings associated weaved field requires a
transient setting to avoid metadata processing.</div>
</td>
</tr>
<tr id="i90" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setBatchFetchType-org.eclipse.persistence.annotations.BatchFetchType-">setBatchFetchType</a></span>(<a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations">BatchFetchType</a>&nbsp;batchFetchType)</code>
<div class="block">PUBLIC:
Set the type of batch fetching to use for all queries for this class.</div>
</td>
</tr>
<tr id="i91" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCascadeAll-boolean-">setCascadeAll</a></span>(boolean&nbsp;value)</code>
<div class="block">PUBLIC:
Sets the cascading for all JPA operations.</div>
</td>
</tr>
<tr id="i92" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCascadeDetach-boolean-">setCascadeDetach</a></span>(boolean&nbsp;value)</code>
<div class="block">PUBLIC:
Sets the cascading for the JPA detach operation.</div>
</td>
</tr>
<tr id="i93" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCascadeMerge-boolean-">setCascadeMerge</a></span>(boolean&nbsp;value)</code>
<div class="block">PUBLIC:
Sets the cascading for the JPA MERGE operation.</div>
</td>
</tr>
<tr id="i94" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCascadePersist-boolean-">setCascadePersist</a></span>(boolean&nbsp;value)</code>
<div class="block">PUBLIC:
Sets the cascading for the JPA CREATE operation.</div>
</td>
</tr>
<tr id="i95" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCascadeRefresh-boolean-">setCascadeRefresh</a></span>(boolean&nbsp;value)</code>
<div class="block">PUBLIC:
Sets the cascading for the JPA REFRESH operation.</div>
</td>
</tr>
<tr id="i96" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCascadeRemove-boolean-">setCascadeRemove</a></span>(boolean&nbsp;value)</code>
<div class="block">PUBLIC:
Sets the cascading for the JPA REMOVE operation.</div>
</td>
</tr>
<tr id="i97" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setCustomSelectionQuery-org.eclipse.persistence.queries.ReadQuery-">setCustomSelectionQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;query)</code>
<div class="block">PUBLIC:
Relationship mappings creates a read query to read reference objects.</div>
</td>
</tr>
<tr id="i98" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setForceInitializationOfSelectionCriteria-boolean-">setForceInitializationOfSelectionCriteria</a></span>(boolean&nbsp;bool)</code>
<div class="block">INTERNAL:
A way of forcing the selection criteria to be rebuilt.</div>
</td>
</tr>
<tr id="i99" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setHasCustomSelectionQuery-boolean-">setHasCustomSelectionQuery</a></span>(boolean&nbsp;bool)</code>&nbsp;</td>
</tr>
<tr id="i100" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setIndirectionPolicy-org.eclipse.persistence.internal.indirection.IndirectionPolicy-">setIndirectionPolicy</a></span>(org.eclipse.persistence.internal.indirection.IndirectionPolicy&nbsp;indirectionPolicy)</code>
<div class="block">ADVANCED:
Set the indirection policy.</div>
</td>
</tr>
<tr id="i101" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setIsCacheable-boolean-">setIsCacheable</a></span>(boolean&nbsp;cacheable)</code>
<div class="block">Used to signal that this mapping references a protected/isolated entity and requires
special merge/object building behaviour.</div>
</td>
</tr>
<tr id="i102" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setIsCascadeOnDeleteSetOnDatabase-boolean-">setIsCascadeOnDeleteSetOnDatabase</a></span>(boolean&nbsp;isCascadeOnDeleteSetOnDatabase)</code>
<div class="block">ADVANCED:
Set if delete cascading has been set on the database for the
mapping's foreign key constraint.</div>
</td>
</tr>
<tr id="i103" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setIsPrivateOwned-boolean-">setIsPrivateOwned</a></span>(boolean&nbsp;isPrivateOwned)</code>
<div class="block">PUBLIC:
Set if the relationship is privately owned.</div>
</td>
</tr>
<tr id="i104" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setJoinFetch-int-">setJoinFetch</a></span>(int&nbsp;joinFetch)</code>
<div class="block">PUBLIC:
Indicates whether the referenced object(s) should always be joined on read queries.</div>
</td>
</tr>
<tr id="i105" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setMappedBy-java.lang.String-">setMappedBy</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>&nbsp;mappedBy)</code>
<div class="block">INTERNAL: Called by JPA metadata processing to store the owning mapping
for this mapping</div>
</td>
</tr>
<tr id="i106" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setPartitioningPolicy-org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy-">setPartitioningPolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a>&nbsp;partitioningPolicy)</code>
<div class="block">PUBLIC:
Set the mapping's partitioning policy.</div>
</td>
</tr>
<tr id="i107" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setPartitioningPolicyName-java.lang.String-">setPartitioningPolicyName</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>&nbsp;partitioningPolicyName)</code>
<div class="block">PUBLIC:
Set the name of the mapping's partitioning policy.</div>
</td>
</tr>
<tr id="i108" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setRealAttributeValueInObject-java.lang.Object-java.lang.Object-">setRealAttributeValueInObject</a></span>(<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;object,
<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;value)</code>
<div class="block">INTERNAL:
Set the value of the attribute mapped by this mapping,
placing it inside a value holder if necessary.</div>
</td>
</tr>
<tr id="i109" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setReferenceClass-java.lang.Class-">setReferenceClass</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>&nbsp;referenceClass)</code>
<div class="block">PUBLIC:
Set the referenced class.</div>
</td>
</tr>
<tr id="i110" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setReferenceClassName-java.lang.String-">setReferenceClassName</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>&nbsp;referenceClassName)</code>
<div class="block">INTERNAL:
Used by MW.</div>
</td>
</tr>
<tr id="i111" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setReferenceDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setReferenceDescriptor</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;aDescriptor)</code>
<div class="block">Set the referenceDescriptor.</div>
</td>
</tr>
<tr id="i112" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setRelationshipPartner-org.eclipse.persistence.mappings.DatabaseMapping-">setRelationshipPartner</a></span>(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a>&nbsp;mapping)</code>
<div class="block">INTERNAL:
Sets the relationshipPartner mapping for this bi-directional mapping.</div>
</td>
</tr>
<tr id="i113" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setRelationshipPartnerAttributeName-java.lang.String-">setRelationshipPartnerAttributeName</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>&nbsp;attributeName)</code>
<div class="block">PUBLIC:
Use this method to specify the relationship partner attribute name of a bidirectional Mapping.</div>
</td>
</tr>
<tr id="i114" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setRequiresTransientWeavedFields-boolean-">setRequiresTransientWeavedFields</a></span>(boolean&nbsp;requiresTransientWeavedFields)</code>
<div class="block">Set this flag if this mappings associated weaved field requires a
transient setting to avoid metadata processing.</div>
</td>
</tr>
<tr id="i115" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setSelectionCall-org.eclipse.persistence.queries.Call-">setSelectionCall</a></span>(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a>&nbsp;call)</code>
<div class="block">PUBLIC:
This is a property on the mapping which will allow custom call to be
substituted for reading a reference object.</div>
</td>
</tr>
<tr id="i116" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setSelectionCriteria-org.eclipse.persistence.expressions.Expression-">setSelectionCriteria</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;anExpression)</code>
<div class="block">PUBLIC:
Sets the selection criteria to be used as a where clause to read
reference objects.</div>
</td>
</tr>
<tr id="i117" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setSelectionQuery-org.eclipse.persistence.queries.ReadQuery-">setSelectionQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;aQuery)</code>
<div class="block">Sets the query</div>
</td>
</tr>
<tr id="i118" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setSelectionSQLString-java.lang.String-">setSelectionSQLString</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>&nbsp;sqlString)</code>
<div class="block">PUBLIC:
This is a property on the mapping which will allow custom SQL to be
substituted for reading a reference object.</div>
</td>
</tr>
<tr id="i119" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setShouldExtendPessimisticLockScope-boolean-">setShouldExtendPessimisticLockScope</a></span>(boolean&nbsp;shouldExtend)</code>
<div class="block">ADVANCED:
Indicates whether pessimistic lock of ObjectLevelReadQuery with isPessimisticLockScopeExtended set to true
should be applied through this mapping beyond the tables mapped to the source object.</div>
</td>
</tr>
<tr id="i120" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setTempSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setTempSession</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i121" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setUsesBatchReading-boolean-">setUsesBatchReading</a></span>(boolean&nbsp;usesBatchReading)</code>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.</div>
</td>
</tr>
<tr id="i122" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setUsesIndirection-boolean-">setUsesIndirection</a></span>(boolean&nbsp;usesIndirection)</code>
<div class="block">PUBLIC:
Indirection means that a ValueHolder will be put in-between the attribute and the real object.</div>
</td>
</tr>
<tr id="i123" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldExtendPessimisticLockScope--">shouldExtendPessimisticLockScope</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether pessimistic lock of ObjectLevelReadQuery with isPessimisticLockScopeExtended set to true
should be applied through this mapping beyond the tables mapped to the source object.</div>
</td>
</tr>
<tr id="i124" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldExtendPessimisticLockScopeInDedicatedQuery--">shouldExtendPessimisticLockScopeInDedicatedQuery</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i125" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldExtendPessimisticLockScopeInSourceQuery--">shouldExtendPessimisticLockScopeInSourceQuery</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i126" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldExtendPessimisticLockScopeInTargetQuery--">shouldExtendPessimisticLockScopeInTargetQuery</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i127" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldForceInitializationOfSelectionCriteria--">shouldForceInitializationOfSelectionCriteria</a></span>()</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i128" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldInitializeSelectionCriteria--">shouldInitializeSelectionCriteria</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i129" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldMergeCascadeParts-org.eclipse.persistence.internal.sessions.MergeManager-">shouldMergeCascadeParts</a></span>(org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</code>
<div class="block">INTERNAL:
Returns true if the merge should cascade to the mappings reference's parts.</div>
</td>
</tr>
<tr id="i130" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldMergeCascadeReference-org.eclipse.persistence.internal.sessions.MergeManager-">shouldMergeCascadeReference</a></span>(org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</code>
<div class="block">Returns true if the merge should cascade to the mappings reference.</div>
</td>
</tr>
<tr id="i131" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldObjectModifyCascadeToParts-org.eclipse.persistence.queries.ObjectLevelModifyQuery-">shouldObjectModifyCascadeToParts</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a>&nbsp;query)</code>
<div class="block">Returns true if any process leading to object modification should also affect its parts
Usually used by write, insert, update and delete.</div>
</td>
</tr>
<tr id="i132" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldRefreshCascadeParts-org.eclipse.persistence.internal.sessions.MergeManager-">shouldRefreshCascadeParts</a></span>(org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</code>
<div class="block">INTERNAL:
Returns true if the merge should cascade to the mappings reference's parts.</div>
</td>
</tr>
<tr id="i133" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldUseBatchReading--">shouldUseBatchReading</a></span>()</code>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.</div>
</td>
</tr>
<tr id="i134" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#shouldUseValueFromRowWithJoin-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-">shouldUseValueFromRowWithJoin</a></span>(org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery)</code>
<div class="block">INTERNAL:
Indicates whether valueFromRow should call valueFromRowInternalWithJoin (true)
or valueFromRowInternal (false)</div>
</td>
</tr>
<tr id="i135" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractRecord</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#trimRowForJoin-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.internal.sessions.AbstractSession-">trimRowForJoin</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
<div class="block">INTERNAL:
Return a sub-partition of the row starting at the index for the mapping.</div>
</td>
</tr>
<tr id="i136" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractRecord</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#trimRowForJoin-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">trimRowForJoin</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
<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;value,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
<div class="block">INTERNAL:
Return a sub-partition of the row starting at the index.</div>
</td>
</tr>
<tr id="i137" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#updateChangeRecordForSelfMerge-org.eclipse.persistence.internal.sessions.ChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">updateChangeRecordForSelfMerge</a></span>(org.eclipse.persistence.internal.sessions.ChangeRecord&nbsp;changeRecord,
<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;source,
<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;target,
org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet&nbsp;parentUOWChangeSet,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork)</code>
<div class="block">INTERNAL:
Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity.</div>
</td>
</tr>
<tr id="i138" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useBasicIndirection--">useBasicIndirection</a></span>()</code>
<div class="block">PUBLIC:
Indirection means that a ValueHolder will be put in-between the attribute and the real object.</div>
</td>
</tr>
<tr id="i139" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useBatchReading--">useBatchReading</a></span>()</code>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.</div>
</td>
</tr>
<tr id="i140" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useContainerIndirection-java.lang.Class-">useContainerIndirection</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>&nbsp;containerClass)</code>
<div class="block">PUBLIC:
Indirection means that a IndirectContainer (wrapping a ValueHolder) will be put in-between the attribute and the real object.</div>
</td>
</tr>
<tr id="i141" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useInnerJoinFetch--">useInnerJoinFetch</a></span>()</code>
<div class="block">PUBLIC:
Specify this relationship to always be join fetched using an INNER join.</div>
</td>
</tr>
<tr id="i142" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useOuterJoinFetch--">useOuterJoinFetch</a></span>()</code>
<div class="block">PUBLIC:
Specify this relationship to always be join fetched using an OUTER join.</div>
</td>
</tr>
<tr id="i143" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#usesIndirection--">usesIndirection</a></span>()</code>
<div class="block">PUBLIC:
Indirection means that some sort of indirection object will be put in-between the attribute and the real object.</div>
</td>
</tr>
<tr id="i144" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useWeavedIndirection-java.lang.String-java.lang.String-boolean-">useWeavedIndirection</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>&nbsp;getMethodName,
<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>&nbsp;setMethodName,
boolean&nbsp;hasUsedMethodAccess)</code>
<div class="block">INTERNAL:
Configures the mapping to used weaved indirection.</div>
</td>
</tr>
<tr id="i145" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#validateBeforeInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-">validateBeforeInitialization</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
To validate mappings declaration</div>
</td>
</tr>
<tr id="i146" class="altColor">
<td class="colFirst"><code>abstract <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/ForeignReferenceMapping.html#valueFromPKList-java.lang.Object:A-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">valueFromPKList</a></span>(<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;pks,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;foreignKeys,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">This method is used to load a relationship from a list of PKs.</div>
</td>
</tr>
<tr id="i147" 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/ForeignReferenceMapping.html#valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-java.lang.Boolean:A-">valueFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;isTargetProtected,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>[]&nbsp;wasCacheUsed)</code>
<div class="block">INTERNAL: Return the value of the reference attribute or a value holder.</div>
</td>
</tr>
<tr id="i148" class="altColor">
<td class="colFirst"><code>protected <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/ForeignReferenceMapping.html#valueFromRowInternal-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">valueFromRowInternal</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
<div class="block">INTERNAL:
Return the value of the reference attribute or a value holder.</div>
</td>
</tr>
<tr id="i149" class="rowColor">
<td class="colFirst"><code>protected <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/ForeignReferenceMapping.html#valueFromRowInternal-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">valueFromRowInternal</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;shouldUseSopObject)</code>
<div class="block">INTERNAL:
Return the value of the reference attribute or a value holder.</div>
</td>
</tr>
<tr id="i150" class="altColor">
<td class="colFirst"><code>protected <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/ForeignReferenceMapping.html#valueFromRowInternalWithJoin-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">valueFromRowInternalWithJoin</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;isTargetProtected)</code>
<div class="block">INTERNAL:
If the query used joining or partial attributes, build the target object directly.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.mappings.DatabaseMapping">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.mappings.<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></h3>
<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#addUnconvertedProperty-java.lang.String-java.lang.String-java.lang.String-">addUnconvertedProperty</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildChangeRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">buildChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildContainerClone-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">buildContainerClone</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildCopy-java.lang.Object-java.lang.Object-org.eclipse.persistence.sessions.CopyGroup-">buildCopy</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildExpression-java.lang.Object-org.eclipse.persistence.queries.QueryByExamplePolicy-org.eclipse.persistence.expressions.Expression-java.util.Map-org.eclipse.persistence.internal.sessions.AbstractSession-">buildExpression</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildObjectJoinExpression-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractSession-">buildObjectJoinExpression</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildObjectJoinExpression-org.eclipse.persistence.expressions.Expression-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">buildObjectJoinExpression</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildShallowOriginalFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">buildShallowOriginalFromRow</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#calculateDeferredChanges-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">calculateDeferredChanges</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadeDiscoverAndPersistUnregisteredNewObjects-java.lang.Object-java.util.Map-java.util.Map-java.util.Map-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Set-">cascadeDiscoverAndPersistUnregisteredNewObjects</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadePerformRemoveIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-">cascadePerformRemoveIfRequired</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-">cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadeRegisterNewIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-">cascadeRegisterNewIfRequired</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cloneFields-java.util.Vector-">cloneFields</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#collectFields--">collectFields</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#compareForChange-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">compareForChange</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#convertConverterClassNamesToClasses-org.eclipse.persistence.mappings.converters.Converter-java.lang.ClassLoader-">convertConverterClassNamesToClasses</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#derivesId--">derivesId</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#earlyPreDelete-org.eclipse.persistence.queries.DeleteObjectQuery-java.lang.Object-">earlyPreDelete</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#extractNestedExpressions-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-">extractNestedExpressions</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#extractNestedNonAggregateExpressions-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-boolean-">extractNestedNonAggregateExpressions</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#fixRealObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-">fixRealObjectReferences</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeAccessor--">getAttributeAccessor</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeClassification--">getAttributeClassification</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeName--">getAttributeName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getContainerPolicy--">getContainerPolicy</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getDerivedIdMapping--">getDerivedIdMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getDescriptor--">getDescriptor</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getField--">getField</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getFieldClassification-org.eclipse.persistence.internal.helper.DatabaseField-">getFieldClassification</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getFields--">getFields</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getGetMethodName--">getGetMethodName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getMapsIdValue--">getMapsIdValue</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getProperties--">getProperties</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getProperty-java.lang.Object-">getProperty</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRealAttributeValueFromObject-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealAttributeValueFromObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRealCollectionAttributeValueFromObject-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealCollectionAttributeValueFromObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getSelectFields--">getSelectFields</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getSelectTables--">getSelectTables</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getSetMethodName--">getSetMethodName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getUnconvertedProperties--">getUnconvertedProperties</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getWeight--">getWeight</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasConstraintDependency--">hasConstraintDependency</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasInverseConstraintDependency--">hasInverseConstraintDependency</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasMapsIdValue--">hasMapsIdValue</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasRootExpressionThatShouldUseOuterJoin-java.util.List-">hasRootExpressionThatShouldUseOuterJoin</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasUnconvertedProperties--">hasUnconvertedProperties</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractColumnMapping--">isAbstractColumnMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractCompositeCollectionMapping--">isAbstractCompositeCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractCompositeDirectCollectionMapping--">isAbstractCompositeDirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractCompositeObjectMapping--">isAbstractCompositeObjectMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractDirectMapping--">isAbstractDirectMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAggregateCollectionMapping--">isAggregateCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAggregateMapping--">isAggregateMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAggregateObjectMapping--">isAggregateObjectMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCacheable--">isCacheable</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCandidateForPrivateOwnedRemoval--">isCandidateForPrivateOwnedRemoval</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCascadedLockingSupported--">isCascadedLockingSupported</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isChangeTrackingSupported-org.eclipse.persistence.sessions.Project-">isChangeTrackingSupported</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCloningRequired--">isCloningRequired</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCollectionMapping--">isCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDatabaseMapping--">isDatabaseMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectCollectionMapping--">isDirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectMapMapping--">isDirectMapMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectToFieldMapping--">isDirectToFieldMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectToXMLTypeMapping--">isDirectToXMLTypeMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isEISMapping--">isEISMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isElementCollectionMapping--">isElementCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInAndOutSopObject--">isInAndOutSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInOnlySopObject--">isInOnlySopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInSopObject--">isInSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isJPAId--">isJPAId</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isManyToManyMapping--">isManyToManyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isManyToOneMapping--">isManyToOneMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isMapKeyMapping--">isMapKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isMultitenantPrimaryKeyMapping--">isMultitenantPrimaryKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isNestedTableMapping--">isNestedTableMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isObjectReferenceMapping--">isObjectReferenceMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOneToManyMapping--">isOneToManyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOneToOneMapping--">isOneToOneMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOptional--">isOptional</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOutOnlySopObject--">isOutOnlySopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOutSopObject--">isOutSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOwned--">isOwned</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isPrimaryKeyMapping--">isPrimaryKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isReadOnly--">isReadOnly</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isReferenceMapping--">isReferenceMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isRelationalMapping--">isRelationalMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isRemotelyInitialized--">isRemotelyInitialized</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isStructureMapping--">isStructureMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isTransformationMapping--">isTransformationMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isUnidirectionalOneToManyMapping--">isUnidirectionalOneToManyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isUsingMethodAccess--">isUsingMethodAccess</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isVariableOneToOneMapping--">isVariableOneToOneMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isWriteOnly--">isWriteOnly</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isXMLMapping--">isXMLMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#loadAll-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.IdentityHashSet-">loadAll</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#mergeChangesIntoObject-java.lang.Object-org.eclipse.persistence.internal.sessions.ChangeRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-org.eclipse.persistence.internal.sessions.AbstractSession-">mergeChangesIntoObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#mergeIntoObject-java.lang.Object-boolean-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-org.eclipse.persistence.internal.sessions.AbstractSession-">mergeIntoObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#performDataModificationEvent-java.lang.Object:A-org.eclipse.persistence.internal.sessions.AbstractSession-">performDataModificationEvent</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postCalculateChanges-org.eclipse.persistence.sessions.changesets.ChangeRecord-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">postCalculateChanges</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postCalculateChangesOnDeleted-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">postCalculateChangesOnDeleted</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postDelete-org.eclipse.persistence.queries.DeleteObjectQuery-">postDelete</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">postInitialize</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postInitializeSourceAndTargetExpressions--">postInitializeSourceAndTargetExpressions</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postInsert-org.eclipse.persistence.queries.WriteObjectQuery-">postInsert</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postUpdate-org.eclipse.persistence.queries.WriteObjectQuery-">postUpdate</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preDelete-org.eclipse.persistence.queries.DeleteObjectQuery-">preDelete</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preInsert-org.eclipse.persistence.queries.WriteObjectQuery-">preInsert</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#prepareCascadeLockingPolicy--">prepareCascadeLockingPolicy</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preUpdate-org.eclipse.persistence.queries.WriteObjectQuery-">preUpdate</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readFromResultSetIntoObject-java.sql.ResultSet-java.lang.Object-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor-java.sql.ResultSetMetaData-int-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-">readFromResultSetIntoObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readOnly--">readOnly</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readWrite--">readWrite</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#recordPrivateOwnedRemovals-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">recordPrivateOwnedRemovals</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#rehashFieldDependancies-org.eclipse.persistence.internal.sessions.AbstractSession-">rehashFieldDependancies</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#remotelyInitialized--">remotelyInitialized</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setAttributeAccessor-org.eclipse.persistence.mappings.AttributeAccessor-">setAttributeAccessor</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setAttributeName-java.lang.String-">setAttributeName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setAttributeValueInObject-java.lang.Object-java.lang.Object-">setAttributeValueInObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setChangeListener-java.lang.Object-java.beans.PropertyChangeListener-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">setChangeListener</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setDerivedIdMapping-org.eclipse.persistence.mappings.DatabaseMapping-">setDerivedIdMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setDerivesId-boolean-">setDerivesId</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setFields-java.util.Vector-">setFields</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setGetMethodName-java.lang.String-">setGetMethodName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsInAndOutSopObject--">setIsInAndOutSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsInSopObject--">setIsInSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsJPAId--">setIsJPAId</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsLazy-boolean-">setIsLazy</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsMapKeyMapping-boolean-">setIsMapKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsOptional-boolean-">setIsOptional</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsOutSopObject--">setIsOutSopObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsPrimaryKeyMapping-boolean-">setIsPrimaryKeyMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsReadOnly-boolean-">setIsReadOnly</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setMapsIdValue-java.lang.String-">setMapsIdValue</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setProperties-java.util.Map-">setProperties</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setProperty-java.lang.Object-java.lang.Object-">setProperty</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setSetMethodName-java.lang.String-">setSetMethodName</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setWeight-java.lang.Integer-">setWeight</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#simpleAddToCollectionChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">simpleAddToCollectionChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#simpleRemoveFromCollectionChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">simpleRemoveFromCollectionChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#toString--">toString</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#updateChangeRecord-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">updateChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#updateCollectionChangeRecord-org.eclipse.persistence.descriptors.changetracking.CollectionChangeEvent-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">updateCollectionChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#validateAfterInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-">validateAfterInitialization</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromObject-java.lang.Object-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.sessions.AbstractSession-">valueFromObject</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromResultSet-java.sql.ResultSet-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor-java.sql.ResultSetMetaData-int-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-">valueFromResultSet</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-boolean-">valueFromRow</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#verifyDelete-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">verifyDelete</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromAttributeIntoRow-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeFromAttributeIntoRow</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRow-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.mappings.DatabaseMapping.WriteType-">writeFromObjectIntoRow</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForShallowInsert-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeFromObjectIntoRowForShallowInsert</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForShallowInsertWithChangeRecord-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeFromObjectIntoRowForShallowInsertWithChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForUpdate-org.eclipse.persistence.queries.WriteObjectQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">writeFromObjectIntoRowForUpdate</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForUpdateAfterShallowInsert-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.DatabaseTable-">writeFromObjectIntoRowForUpdateAfterShallowInsert</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForUpdateBeforeShallowDelete-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.DatabaseTable-">writeFromObjectIntoRowForUpdateBeforeShallowDelete</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForWhereClause-org.eclipse.persistence.queries.ObjectLevelModifyQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">writeFromObjectIntoRowForWhereClause</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowWithChangeRecord-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.mappings.DatabaseMapping.WriteType-">writeFromObjectIntoRowWithChangeRecord</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeInsertFieldsIntoRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeInsertFieldsIntoRow</a>, <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeUpdateFieldsIntoRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeUpdateFieldsIntoRow</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<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></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="QUERY_BATCH_PARAMETER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>QUERY_BATCH_PARAMETER</h4>
<pre>public static final&nbsp;<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> QUERY_BATCH_PARAMETER</pre>
<div class="block">Query parameter name used for IN batch ids.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.mappings.ForeignReferenceMapping.QUERY_BATCH_PARAMETER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="referenceClass">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>referenceClass</h4>
<pre>protected&nbsp;<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> referenceClass</pre>
<div class="block">This is used only in descriptor proxy in remote session</div>
</li>
</ul>
<a name="referenceClassName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>referenceClassName</h4>
<pre>protected&nbsp;<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> referenceClassName</pre>
</li>
</ul>
<a name="tempInitSession">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tempInitSession</h4>
<pre>protected transient&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession tempInitSession</pre>
<div class="block">The session is temporarily used for initialization. Once used, it is set to null</div>
</li>
</ul>
<a name="referenceDescriptor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>referenceDescriptor</h4>
<pre>protected transient&nbsp;<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> referenceDescriptor</pre>
<div class="block">The descriptor of the reference class.</div>
</li>
</ul>
<a name="selectionQuery">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectionQuery</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a> selectionQuery</pre>
<div class="block">This query is used to read referenced objects for this mapping.</div>
</li>
</ul>
<a name="isPrivateOwned">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrivateOwned</h4>
<pre>protected&nbsp;boolean isPrivateOwned</pre>
<div class="block">Indicates whether the referenced object is privately owned or not.</div>
</li>
</ul>
<a name="batchFetchType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchFetchType</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations">BatchFetchType</a> batchFetchType</pre>
<div class="block">Indicates whether the referenced object should always be batch read on read all queries,
and defines the type of batch fetch to use.</div>
</li>
</ul>
<a name="indirectionPolicy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indirectionPolicy</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.indirection.IndirectionPolicy indirectionPolicy</pre>
<div class="block">Implements indirection behavior</div>
</li>
</ul>
<a name="hasCustomSelectionQuery">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCustomSelectionQuery</h4>
<pre>protected transient&nbsp;boolean hasCustomSelectionQuery</pre>
<div class="block">Indicates whether the selection query is TopLink generated or defined by the user.</div>
</li>
</ul>
<a name="relationshipPartner">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>relationshipPartner</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> relationshipPartner</pre>
<div class="block">Used to reference the other half of a bi-directional relationship.</div>
</li>
</ul>
<a name="relationshipPartnerAttributeName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>relationshipPartnerAttributeName</h4>
<pre>protected&nbsp;<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> relationshipPartnerAttributeName</pre>
<div class="block">Set by users, used to retrieve the backpointer for this mapping</div>
</li>
</ul>
<a name="cascadePersist">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadePersist</h4>
<pre>protected&nbsp;boolean cascadePersist</pre>
<div class="block">Cascading flags used by the EntityManager</div>
</li>
</ul>
<a name="cascadeMerge">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadeMerge</h4>
<pre>protected&nbsp;boolean cascadeMerge</pre>
</li>
</ul>
<a name="cascadeRefresh">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadeRefresh</h4>
<pre>protected&nbsp;boolean cascadeRefresh</pre>
</li>
</ul>
<a name="cascadeRemove">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadeRemove</h4>
<pre>protected&nbsp;boolean cascadeRemove</pre>
</li>
</ul>
<a name="cascadeDetach">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadeDetach</h4>
<pre>protected&nbsp;boolean cascadeDetach</pre>
</li>
</ul>
<a name="requiresTransientWeavedFields">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiresTransientWeavedFields</h4>
<pre>protected&nbsp;boolean requiresTransientWeavedFields</pre>
<div class="block">Flag used to determine if we need to weave the transient annotation on weaved fields.</div>
</li>
</ul>
<a name="joinFetch">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinFetch</h4>
<pre>protected&nbsp;int joinFetch</pre>
<div class="block">Define if the relationship should always be join fetched.</div>
</li>
</ul>
<a name="INNER_JOIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INNER_JOIN</h4>
<pre>public static final&nbsp;int INNER_JOIN</pre>
<div class="block">Specify any INNER join on a join fetch.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.mappings.ForeignReferenceMapping.INNER_JOIN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OUTER_JOIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OUTER_JOIN</h4>
<pre>public static final&nbsp;int OUTER_JOIN</pre>
<div class="block">Specify any OUTER join on a join fetch.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.mappings.ForeignReferenceMapping.OUTER_JOIN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NONE</h4>
<pre>public static final&nbsp;int NONE</pre>
<div class="block">Specify no join fetch, this is the default.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.mappings.ForeignReferenceMapping.NONE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="forceInitializationOfSelectionCriteria">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceInitializationOfSelectionCriteria</h4>
<pre>protected&nbsp;boolean forceInitializationOfSelectionCriteria</pre>
<div class="block">This is a way (after cloning) to force the initialization of the selection criteria</div>
</li>
</ul>
<a name="isCascadeOnDeleteSetOnDatabase">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadeOnDeleteSetOnDatabase</h4>
<pre>protected&nbsp;boolean isCascadeOnDeleteSetOnDatabase</pre>
<div class="block">Support delete cascading on the database relationship constraint.</div>
</li>
</ul>
<a name="partitioningPolicy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitioningPolicy</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a> partitioningPolicy</pre>
<div class="block">Allow the mapping's queries to be targeted at specific connection pools.</div>
</li>
</ul>
<a name="partitioningPolicyName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitioningPolicyName</h4>
<pre>protected&nbsp;<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> partitioningPolicyName</pre>
<div class="block">Allow the mapping's queries to be targeted at specific connection pools.</div>
</li>
</ul>
<a name="mappedBy">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mappedBy</h4>
<pre>protected&nbsp;<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> mappedBy</pre>
<div class="block">Stores JPA metadata about whether another mapping is the owning mapping. Only populated for JPA models</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ForeignReferenceMapping--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ForeignReferenceMapping</h4>
<pre>protected&nbsp;ForeignReferenceMapping()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMappedBy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMappedBy</h4>
<pre>public&nbsp;<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>&nbsp;getMappedBy()</pre>
<div class="block">ADVANCED: Allows the retrieval of the owning mapping for a particular
mapping. Note: This will only be set for JPA models</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getPartitioningPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitioningPolicy</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a>&nbsp;getPartitioningPolicy()</pre>
<div class="block">PUBLIC:
Return the mapping's partitioning policy.</div>
</li>
</ul>
<a name="setPartitioningPolicy-org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitioningPolicy</h4>
<pre>public&nbsp;void&nbsp;setPartitioningPolicy(<a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a>&nbsp;partitioningPolicy)</pre>
<div class="block">PUBLIC:
Set the mapping's partitioning policy.
A PartitioningPolicy is used to partition, load-balance or replicate data across multiple difference databases
or across a database cluster such as Oracle RAC.
Partitioning can provide improved scalability by allowing multiple database machines to service requests.
Setting a policy on a mapping will set the policy on all of its mappings.</div>
</li>
</ul>
<a name="getPartitioningPolicyName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitioningPolicyName</h4>
<pre>public&nbsp;<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>&nbsp;getPartitioningPolicyName()</pre>
<div class="block">PUBLIC:
Return the name of the mapping's partitioning policy.
A PartitioningPolicy with the same name must be defined on the Project.
A PartitioningPolicy is used to partition the data for a class across multiple difference databases
or across a database cluster such as Oracle RAC.
Partitioning can provide improved scalability by allowing multiple database machines to service requests.</div>
</li>
</ul>
<a name="setPartitioningPolicyName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitioningPolicyName</h4>
<pre>public&nbsp;void&nbsp;setPartitioningPolicyName(<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>&nbsp;partitioningPolicyName)</pre>
<div class="block">PUBLIC:
Set the name of the mapping's partitioning policy.
A PartitioningPolicy with the same name must be defined on the Project.
A PartitioningPolicy is used to partition the data for a class across multiple difference databases
or across a database cluster such as Oracle RAC.
Partitioning can provide improved scalability by allowing multiple database machines to service requests.</div>
</li>
</ul>
<a name="batchedValueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchedValueFromRow</h4>
<pre>protected&nbsp;<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;batchedValueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey)</pre>
<div class="block">INTERNAL:
Retrieve the value through using batch reading.
This executes a single query to read the target for all of the objects and stores the
result of the batch query in the original query to allow the other objects to share the results.</div>
</li>
</ul>
<a name="buildBackupClone-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildBackupClone</h4>
<pre>public&nbsp;void&nbsp;buildBackupClone(<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,
<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;backup,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork)</pre>
<div class="block">INTERNAL:
Clone the attribute from the clone and assign it to the backup.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildBackupClone-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">buildBackupClone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="buildBackupCloneForPartObject-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildBackupCloneForPartObject</h4>
<pre>public abstract&nbsp;<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;buildBackupCloneForPartObject(<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;attributeValue,
<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,
<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;backup,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork)</pre>
<div class="block">INTERNAL:
Used during building the backup shallow copy to copy the
target object without re-registering it.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildBackupCloneForPartObject-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">buildBackupCloneForPartObject</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="buildClone-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-java.lang.Integer-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildClone</h4>
<pre>public&nbsp;void&nbsp;buildClone(<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;original,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey,
<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,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;refreshCascade,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;cloningSession)</pre>
<div class="block">INTERNAL:
Clone the attribute from the original and assign it to the clone.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildClone-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-java.lang.Integer-org.eclipse.persistence.internal.sessions.AbstractSession-">buildClone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="buildCloneFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildCloneFromRow</h4>
<pre>public&nbsp;void&nbsp;buildCloneFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;databaseRow,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<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,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;sharedCacheKey,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</pre>
<div class="block">INTERNAL:
A combination of readFromRowIntoObject and buildClone.
<p>
buildClone assumes the attribute value exists on the original and can
simply be copied.
<p>
readFromRowIntoObject assumes that one is building an original.
<p>
Both of the above assumptions are false in this method, and actually
attempts to do both at the same time.
<p>
Extract value from the row and set the attribute to this value in the
working copy clone.
In order to bypass the shared cache when in transaction a UnitOfWork must
be able to populate working copies directly from the row.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildCloneFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-">buildCloneFromRow</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="buildCloneForPartObject-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Integer-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildCloneForPartObject</h4>
<pre>public abstract&nbsp;<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;buildCloneForPartObject(<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;attributeValue,
<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;original,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey,
<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,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;cloningSession,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;refreshCascade,
boolean&nbsp;isExisting,
boolean&nbsp;isFromSharedCache)</pre>
<div class="block">INTERNAL:
Require for cloning, the part must be cloned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildCloneForPartObject-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Integer-boolean-boolean-">buildCloneForPartObject</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<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:
The mapping clones itself to create deep copy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="buildReferencesPKList-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildReferencesPKList</h4>
<pre>public abstract&nbsp;<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;buildReferencesPKList(<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;entity,
<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;attribute,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
This method will access the target relationship and create a list of information to rebuild the relationship.
This method is used in combination with the CachedValueHolder to store references to PK's to be loaded from
a cache instead of a query.</div>
</li>
</ul>
<a name="compareObjects-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareObjects</h4>
<pre>public&nbsp;boolean&nbsp;compareObjects(<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;firstObject,
<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;secondObject,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL: Compare the attributes belonging to this mapping for the
objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#compareObjects-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">compareObjects</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="compareObjectsWithoutPrivateOwned-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareObjectsWithoutPrivateOwned</h4>
<pre>protected abstract&nbsp;boolean&nbsp;compareObjectsWithoutPrivateOwned(<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;first,
<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;second,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">Compare two objects if their parts are not private owned</div>
</li>
</ul>
<a name="compareObjectsWithPrivateOwned-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareObjectsWithPrivateOwned</h4>
<pre>protected abstract&nbsp;boolean&nbsp;compareObjectsWithPrivateOwned(<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;first,
<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;second,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">Compare two objects if their parts are private owned</div>
</li>
</ul>
<a name="convertClassNamesToClasses-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertClassNamesToClasses</h4>
<pre>public&nbsp;void&nbsp;convertClassNamesToClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</pre>
<div class="block">INTERNAL:
Convert all the class-name-based settings in this mapping to actual class-based
settings. This method is used when converting a project that has been built
with class names to a project with classes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="createCloneValueHolder-org.eclipse.persistence.indirection.ValueHolderInterface-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCloneValueHolder</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.indirection.DatabaseValueHolder&nbsp;createCloneValueHolder(<a href="../../../../org/eclipse/persistence/indirection/ValueHolderInterface.html" title="interface in org.eclipse.persistence.indirection">ValueHolderInterface</a>&nbsp;attributeValue,
<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;original,
<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,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;cloningSession,
boolean&nbsp;buildDirectlyFromRow)</pre>
<div class="block">INTERNAL:
Builder the unit of work value holder.
Ignore the original object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#createCloneValueHolder-org.eclipse.persistence.indirection.ValueHolderInterface-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">createCloneValueHolder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buildDirectlyFromRow</code> - indicates that we are building the clone directly
from a row as opposed to building the original from the row, putting it in
the shared cache, and then cloning the original.</dd>
</dl>
</li>
</ul>
<a name="dontDoMerge-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dontDoMerge</h4>
<pre>protected&nbsp;boolean&nbsp;dontDoMerge(<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;target,
<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;source,
org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</pre>
<div class="block">INTERNAL:
Return true if the merge should be bypassed. This would be the case for several reasons, depending on
the kind of merge taking place.</div>
</li>
</ul>
<a name="dontUseBatchReading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dontUseBatchReading</h4>
<pre>public&nbsp;void&nbsp;dontUseBatchReading()</pre>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.
Batch reading will read all of the related objects in a single query when accessed from an originating read all.
This should only be used if it is know that the related objects are always required with the source object, or indirection is not used.</div>
</li>
</ul>
<a name="dontUseIndirection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dontUseIndirection</h4>
<pre>public&nbsp;void&nbsp;dontUseIndirection()</pre>
<div class="block">PUBLIC:
Indirection means that a ValueHolder will be put in-between the attribute and the real object.
This allows for the reading of the target from the database to be delayed until accessed.
This defaults to true and is strongly suggested as it give a huge performance gain.</div>
</li>
</ul>
<a name="extendPessimisticLockScopeInTargetQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.queries.ObjectBuildingQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extendPessimisticLockScopeInTargetQuery</h4>
<pre>protected&nbsp;void&nbsp;extendPessimisticLockScopeInTargetQuery(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;targetQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery)</pre>
<div class="block">INTERNAL:
Called if shouldExtendPessimisticLockScopeInTargetQuery() is true.
Adds locking clause to the target query to extend pessimistic lock scope.</div>
</li>
</ul>
<a name="extendPessimisticLockScopeInSourceQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extendPessimisticLockScopeInSourceQuery</h4>
<pre>public&nbsp;void&nbsp;extendPessimisticLockScopeInSourceQuery(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;sourceQuery)</pre>
<div class="block">INTERNAL:
Called if shouldExtendPessimisticLockScopeInSourceQuery is true.
Adds fields to be locked to the where clause of the source query.
Note that the sourceQuery must be ObjectLevelReadQuery so that it has ExpressionBuilder.
This method must be implemented in subclasses that allow
setting shouldExtendPessimisticLockScopeInSourceQuery to true.</div>
</li>
</ul>
<a name="extractResultFromBatchQuery-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.ObjectLevelReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractResultFromBatchQuery</h4>
<pre>public&nbsp;<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;extractResultFromBatchQuery(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;batchQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;sourceRow,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;originalQuery)
throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre>
<div class="block">INTERNAL:
Extract the value from the batch optimized query, this should be supported by most query types.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
</dl>
</li>
</ul>
<a name="extractBatchKeyFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractBatchKeyFromRow</h4>
<pre>protected&nbsp;<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;extractBatchKeyFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;targetRow,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Extract the batch key value from the source row.
Used for batch reading, most following same order and fields as in the mapping.
The method should be overridden by classes that support batch reading.</div>
</li>
</ul>
<a name="collectQueryParameters-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectQueryParameters</h4>
<pre>public abstract&nbsp;void&nbsp;collectQueryParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;&nbsp;cacheFields)</pre>
<div class="block">INTERNAL:
This method is used to store the FK fields that can be cached that correspond to noncacheable mappings
the FK field values will be used to re-issue the query when cloning the shared cache entity</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#collectQueryParameters-java.util.Set-">collectQueryParameters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="checkCacheForBatchKey-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-java.util.Map-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkCacheForBatchKey</h4>
<pre>protected&nbsp;<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;checkCacheForBatchKey(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;sourceRow,
<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;foreignKey,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;batchObjects,
<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;batchQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;originalQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Check if the target object is in the cache if possible based on the source row.
If in the cache, add the object to the batch results.
Return null if not possible or not in the cache.</div>
</li>
</ul>
<a name="executeBatchQuery-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-java.util.Map-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeBatchQuery</h4>
<pre>protected&nbsp;void&nbsp;executeBatchQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;referenceObjectsByKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</pre>
<div class="block">INTERNAL:
Prepare and execute the batch query and store the
results for each source object in a map keyed by the
mappings source keys of the source objects.</div>
</li>
</ul>
<a name="prepareNestedJoins-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareNestedJoins</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;prepareNestedJoins(org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;baseQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Clone and prepare the JoinedAttributeManager nested JoinedAttributeManager.
This is used for nested joining as the JoinedAttributeManager passed to the joined build object.</div>
</li>
</ul>
<a name="postPrepareNestedBatchQuery-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postPrepareNestedBatchQuery</h4>
<pre>protected&nbsp;void&nbsp;postPrepareNestedBatchQuery(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;batchQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</pre>
<div class="block">INTERNAL:
Allow the mapping the do any further batch preparation.</div>
</li>
</ul>
<a name="buildBatchCriteria-org.eclipse.persistence.expressions.ExpressionBuilder-org.eclipse.persistence.queries.ObjectLevelReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildBatchCriteria</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;buildBatchCriteria(<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a>&nbsp;builder,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</pre>
<div class="block">INTERNAL:
Return the selection criteria used to IN batch fetching.</div>
</li>
</ul>
<a name="prepareNestedBatchQuery-org.eclipse.persistence.queries.ObjectLevelReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareNestedBatchQuery</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;prepareNestedBatchQuery(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</pre>
<div class="block">INTERNAL:
Clone and prepare the selection query as a nested batch read query.
This is used for nested batch reading.</div>
</li>
</ul>
<a name="fixObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixObjectReferences</h4>
<pre>public&nbsp;void&nbsp;fixObjectReferences(<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;object,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;objectDescriptors,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;processedObjects,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query,
<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a>&nbsp;session)</pre>
<div class="block">INTERNAL:
An object has been serialized from the server to the client.
Replace the transient attributes of the remote value holders
with client-side objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#fixObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-">fixObjectReferences</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="getAttributeValueFromObject-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValueFromObject</h4>
<pre>public&nbsp;<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;getAttributeValueFromObject(<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;object)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">INTERNAL:
Return the value of an attribute which this mapping represents for an object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeValueFromObject-java.lang.Object-">getAttributeValueFromObject</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAttributeValueWithClonedValueHolders-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValueWithClonedValueHolders</h4>
<pre>public&nbsp;<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;getAttributeValueWithClonedValueHolders(<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;object)</pre>
<div class="block">INTERNAL:
Returns the attribute value from the reference object.
If the attribute is using indirection the value of the value-holder is returned.
If the value holder is not instantiated then it is instantiated.</div>
</li>
</ul>
<a name="getFieldsForTranslationInAggregate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldsForTranslationInAggregate</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getFieldsForTranslationInAggregate()</pre>
<div class="block">INTERNAL:
Return source key fields for translation by an AggregateObjectMapping
By default, return an empty NonSynchronizedVector</div>
</li>
</ul>
<a name="getExtendPessimisticLockScopeDedicatedQuery-org.eclipse.persistence.internal.sessions.AbstractSession-short-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtendPessimisticLockScopeDedicatedQuery</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;getExtendPessimisticLockScopeDedicatedQuery(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
short&nbsp;lockMode)</pre>
<div class="block">INTERNAL:
Should be overridden by subclass that allows setting
extendPessimisticLockScope to DEDICATED_QUERY.</div>
</li>
</ul>
<a name="getIndirectionPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndirectionPolicy</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.indirection.IndirectionPolicy&nbsp;getIndirectionPolicy()</pre>
<div class="block">INTERNAL:
Return the mapping's indirection policy.</div>
</li>
</ul>
<a name="isAttributeValueFromObjectInstantiated-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttributeValueFromObjectInstantiated</h4>
<pre>public&nbsp;boolean&nbsp;isAttributeValueFromObjectInstantiated(<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;object)</pre>
<div class="block">INTERNAL:
Return whether the specified object is instantiated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAttributeValueFromObjectInstantiated-java.lang.Object-">isAttributeValueFromObjectInstantiated</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="getJoinCriteria-org.eclipse.persistence.internal.expressions.ObjectExpression-org.eclipse.persistence.expressions.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoinCriteria</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;getJoinCriteria(org.eclipse.persistence.internal.expressions.ObjectExpression&nbsp;context,
<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;base)</pre>
<div class="block">INTERNAL:
Returns the join criteria stored in the mapping selection query. This criteria
is used to read reference objects across the tables from the database.</div>
</li>
</ul>
<a name="getObjectCorrespondingTo-java.lang.Object-org.eclipse.persistence.sessions.remote.DistributedSession-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectCorrespondingTo</h4>
<pre>public&nbsp;<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;getObjectCorrespondingTo(<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;object,
<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a>&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;objectDescriptors,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;processedObjects,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;query)</pre>
<div class="block">INTERNAL:
return the object on the client corresponding to the specified object.
ForeignReferenceMappings have to worry about
maintaining object identity.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getObjectCorrespondingTo-java.lang.Object-org.eclipse.persistence.sessions.remote.DistributedSession-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-">getObjectCorrespondingTo</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="getRealAttributeValueFromAttribute-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRealAttributeValueFromAttribute</h4>
<pre>public&nbsp;<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;getRealAttributeValueFromAttribute(<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;attributeValue,
<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;object,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Returns the attribute value from the reference object.
If the attribute is using indirection the value of the value-holder is returned.
If the value holder is not instantiated then it is instantiated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRealAttributeValueFromAttribute-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealAttributeValueFromAttribute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="isLazy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLazy</h4>
<pre>public&nbsp;boolean&nbsp;isLazy()</pre>
<div class="block">Return if this mapping is lazy.
For relationship mappings this should normally be the same value as indirection,
however for eager relationships this can be used with indirection to allow
indirection locking and change tracking, but still always force instantiation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isLazy--">isLazy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="isLockableMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLockableMapping</h4>
<pre>public&nbsp;boolean&nbsp;isLockableMapping()</pre>
<div class="block">INTERNAL:
Return whether this mapping should be traversed when we are locking.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isLockableMapping--">isLockableMapping</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="instantiateAttribute-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instantiateAttribute</h4>
<pre>public&nbsp;void&nbsp;instantiateAttribute(<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;object,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Trigger the instantiation of the attribute if lazy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#instantiateAttribute-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">instantiateAttribute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="getReferenceClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceClass</h4>
<pre>public&nbsp;<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>&nbsp;getReferenceClass()</pre>
<div class="block">PUBLIC:
Returns the reference class.</div>
</li>
</ul>
<a name="getReferenceClassName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceClassName</h4>
<pre>public&nbsp;<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>&nbsp;getReferenceClassName()</pre>
<div class="block">INTERNAL:
Returns the reference class name.</div>
</li>
</ul>
<a name="getReferenceDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceDescriptor</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;getReferenceDescriptor()</pre>
<div class="block">INTERNAL:
Return the referenceDescriptor. This is a descriptor which is associated with
the reference class.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getReferenceDescriptor--">getReferenceDescriptor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="getRelationshipPartner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelationshipPartner</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a>&nbsp;getRelationshipPartner()</pre>
<div class="block">INTERNAL:
Return the relationshipPartner mapping for this bi-directional mapping. If the relationshipPartner is null then
this is a uni-directional mapping.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRelationshipPartner--">getRelationshipPartner</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="getRelationshipPartnerAttributeName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelationshipPartnerAttributeName</h4>
<pre>public&nbsp;<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>&nbsp;getRelationshipPartnerAttributeName()</pre>
<div class="block">PUBLIC:
Use this method retrieve the relationship partner attribute name of this bidirectional Mapping.</div>
</li>
</ul>
<a name="getSelectionCriteria--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectionCriteria</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;getSelectionCriteria()</pre>
<div class="block">INTERNAL:
Returns the selection criteria stored in the mapping selection query. This criteria
is used to read reference objects from the database. It will return null before
initialization. To obtain the selection criteria before initialization (e.g., in a
customizer) you can use the buildSelectionCriteria() method defined by some subclasses.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html#buildSelectionCriteria--"><code>OneToOneMapping.buildSelectionCriteria()</code></a>,
<a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html#buildSelectionCriteria--"><code>OneToManyMapping.buildSelectionCriteria()</code></a></dd>
</dl>
</li>
</ul>
<a name="getSelectionQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectionQuery</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;getSelectionQuery()</pre>
<div class="block">INTERNAL:
Returns the read query associated with the mapping.</div>
</li>
</ul>
<a name="getTempSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTempSession</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getTempSession()</pre>
</li>
</ul>
<a name="getValueFromRemoteValueHolder-org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueFromRemoteValueHolder</h4>
<pre>public&nbsp;<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;getValueFromRemoteValueHolder(org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder&nbsp;remoteValueHolder)</pre>
<div class="block">INTERNAL:
Extract and return the appropriate value from the
specified remote value holder.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getValueFromRemoteValueHolder-org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder-">getValueFromRemoteValueHolder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="hasCustomSelectionQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCustomSelectionQuery</h4>
<pre>public&nbsp;boolean&nbsp;hasCustomSelectionQuery()</pre>
<div class="block">INTERNAL:
Indicates whether the selection query is TopLink generated or defined by
the user.</div>
</li>
</ul>
<a name="hasNestedIdentityReference--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNestedIdentityReference</h4>
<pre>public&nbsp;boolean&nbsp;hasNestedIdentityReference()</pre>
<div class="block">INTERNAL:
Indicates whether the mapping (or at least one of its nested mappings, at any nested depth)
references an entity.
To return true the mapping (or nested mapping) should be ForeignReferenceMapping with non-null and non-aggregate reference descriptor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasNestedIdentityReference--">hasNestedIdentityReference</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="preInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preInitialize</h4>
<pre>public&nbsp;void&nbsp;preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">INTERNAL:
Initialize the state of mapping.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">preInitialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">INTERNAL:
Initialize the state of mapping.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="initializeReferenceDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeReferenceDescriptor</h4>
<pre>protected&nbsp;void&nbsp;initializeReferenceDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">Initialize and set the descriptor for the referenced class in this mapping.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="isAttributeValueFullyBuilt-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttributeValueFullyBuilt</h4>
<pre>public&nbsp;boolean&nbsp;isAttributeValueFullyBuilt(<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;object)</pre>
<div class="block">INTERNAL:
The method validateAttributeOfInstantiatedObject(Object attributeValue) fixes the value of the attributeValue
in cases where it is null and indirection requires that it contain some specific data structure. Return whether this will happen.
This method is used to help determine if indirection has been triggered</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>IndirectionPolicy.validateAttributeOfInstantiatedObject(Object)</code></dd>
</dl>
</li>
</ul>
<a name="initializeSelectionQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeSelectionQuery</h4>
<pre>protected&nbsp;void&nbsp;initializeSelectionQuery(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">A subclass should implement this method if it wants non default behavior.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="isAttributeValueInstantiated-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttributeValueInstantiated</h4>
<pre>public&nbsp;boolean&nbsp;isAttributeValueInstantiated(<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;object)</pre>
<div class="block">INTERNAL:
The referenced object is checked if it is instantiated or not</div>
</li>
</ul>
<a name="isCascadeDetach--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadeDetach</h4>
<pre>public&nbsp;boolean&nbsp;isCascadeDetach()</pre>
<div class="block">PUBLIC:
Check cascading value for the detach operation.</div>
</li>
</ul>
<a name="isCascadePersist--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadePersist</h4>
<pre>public&nbsp;boolean&nbsp;isCascadePersist()</pre>
<div class="block">PUBLIC:
Check cascading value for the CREATE operation.</div>
</li>
</ul>
<a name="isCascadeMerge--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadeMerge</h4>
<pre>public&nbsp;boolean&nbsp;isCascadeMerge()</pre>
<div class="block">PUBLIC:
Check cascading value for the MERGE operation.</div>
</li>
</ul>
<a name="isCascadeRefresh--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadeRefresh</h4>
<pre>public&nbsp;boolean&nbsp;isCascadeRefresh()</pre>
<div class="block">PUBLIC:
Check cascading value for the REFRESH operation.</div>
</li>
</ul>
<a name="isCascadeRemove--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadeRemove</h4>
<pre>public&nbsp;boolean&nbsp;isCascadeRemove()</pre>
<div class="block">PUBLIC:
Check cascading value for the REMOVE operation.</div>
</li>
</ul>
<a name="hasDependency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasDependency</h4>
<pre>public&nbsp;boolean&nbsp;hasDependency()</pre>
<div class="block">INTERNAL:
Return if the mapping has any ownership or other dependency over its target object(s).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasDependency--">hasDependency</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="isForeignReferenceMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isForeignReferenceMapping</h4>
<pre>public&nbsp;boolean&nbsp;isForeignReferenceMapping()</pre>
<div class="block">INTERNAL:</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isForeignReferenceMapping--">isForeignReferenceMapping</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="isJoiningSupported--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJoiningSupported</h4>
<pre>public&nbsp;boolean&nbsp;isJoiningSupported()</pre>
<div class="block">INTERNAL:
Return if this mapping supports joining.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isJoiningSupported--">isJoiningSupported</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="isPrivateOwned--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrivateOwned</h4>
<pre>public&nbsp;boolean&nbsp;isPrivateOwned()</pre>
<div class="block">PUBLIC:
Return true if referenced objects are privately owned else false.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isPrivateOwned--">isPrivateOwned</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="iterate-org.eclipse.persistence.internal.descriptors.DescriptorIterator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterate</h4>
<pre>public&nbsp;void&nbsp;iterate(org.eclipse.persistence.internal.descriptors.DescriptorIterator&nbsp;iterator)</pre>
<div class="block">INTERNAL:
Iterate on the iterator's current object's attribute defined by this mapping.
The iterator's settings for cascading and value holders determine how the
iteration continues from here.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#iterate-org.eclipse.persistence.internal.descriptors.DescriptorIterator-">iterate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="iterateOnRealAttributeValue-org.eclipse.persistence.internal.descriptors.DescriptorIterator-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateOnRealAttributeValue</h4>
<pre>public abstract&nbsp;void&nbsp;iterateOnRealAttributeValue(org.eclipse.persistence.internal.descriptors.DescriptorIterator&nbsp;iterator,
<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;realAttributeValue)</pre>
<div class="block">INTERNAL:
Iterate on the attribute value.
The value holder has already been processed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#iterateOnRealAttributeValue-org.eclipse.persistence.internal.descriptors.DescriptorIterator-java.lang.Object-">iterateOnRealAttributeValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="load-java.lang.Object-org.eclipse.persistence.internal.queries.AttributeItem-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre>public&nbsp;void&nbsp;load(<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;object,
org.eclipse.persistence.internal.queries.AttributeItem&nbsp;item,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
boolean&nbsp;fromFetchGroup)</pre>
<div class="block">Force instantiation of the load group.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#load-java.lang.Object-org.eclipse.persistence.internal.queries.AttributeItem-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">load</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="mergeRemoteValueHolder-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeRemoteValueHolder</h4>
<pre>public&nbsp;void&nbsp;mergeRemoteValueHolder(<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;clientSideDomainObject,
<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;serverSideDomainObject,
org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</pre>
<div class="block">INTERNAL:
Replace the client value holder with the server value holder,
after copying some of the settings from the client value holder.</div>
</li>
</ul>
<a name="privateOwnedRelationship--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>privateOwnedRelationship</h4>
<pre>public&nbsp;void&nbsp;privateOwnedRelationship()</pre>
<div class="block">PUBLIC:
Sets the reference object to be a private owned.
The default behavior is non private owned, or independent.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setIsPrivateOwned-boolean-"><code>setIsPrivateOwned(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="readFromRowIntoObject-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFromRowIntoObject</h4>
<pre>public&nbsp;<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;readFromRowIntoObject(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;databaseRow,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<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;targetObject,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;isTargetProtected)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
Extract value from the row and set the attribute to this value in the object.
return value as this value will have been converted to the appropriate type for
the object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readFromRowIntoObject-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">readFromRowIntoObject</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
</dl>
</li>
</ul>
<a name="remoteInitialization-org.eclipse.persistence.sessions.remote.DistributedSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remoteInitialization</h4>
<pre>public&nbsp;void&nbsp;remoteInitialization(<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a>&nbsp;session)</pre>
<div class="block">INTERNAL:
Once descriptors are serialized to the remote session. All its mappings and reference descriptors are traversed. Usually
mappings are initialized and serialized reference descriptors are replaced with local descriptors if they already exist on the
remote session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#remoteInitialization-org.eclipse.persistence.sessions.remote.DistributedSession-">remoteInitialization</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replaceValueHoldersIn</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;replaceValueHoldersIn(<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;object,
org.eclipse.persistence.internal.sessions.remote.RemoteSessionController&nbsp;controller)</pre>
<div class="block">INTERNAL:
replace the value holders in the specified reference object(s)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-">replaceValueHoldersIn</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="requiresTransientWeavedFields--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiresTransientWeavedFields</h4>
<pre>public&nbsp;boolean&nbsp;requiresTransientWeavedFields()</pre>
<div class="block">Returns true if this mappings associated weaved field requires a
transient setting to avoid metadata processing.</div>
</li>
</ul>
<a name="setCascadeAll-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCascadeAll</h4>
<pre>public&nbsp;void&nbsp;setCascadeAll(boolean&nbsp;value)</pre>
<div class="block">PUBLIC:
Sets the cascading for all JPA operations.</div>
</li>
</ul>
<a name="setCascadeDetach-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCascadeDetach</h4>
<pre>public&nbsp;void&nbsp;setCascadeDetach(boolean&nbsp;value)</pre>
<div class="block">PUBLIC:
Sets the cascading for the JPA detach operation.</div>
</li>
</ul>
<a name="setCascadePersist-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCascadePersist</h4>
<pre>public&nbsp;void&nbsp;setCascadePersist(boolean&nbsp;value)</pre>
<div class="block">PUBLIC:
Sets the cascading for the JPA CREATE operation.</div>
</li>
</ul>
<a name="setCascadeMerge-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCascadeMerge</h4>
<pre>public&nbsp;void&nbsp;setCascadeMerge(boolean&nbsp;value)</pre>
<div class="block">PUBLIC:
Sets the cascading for the JPA MERGE operation.</div>
</li>
</ul>
<a name="setCascadeRefresh-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCascadeRefresh</h4>
<pre>public&nbsp;void&nbsp;setCascadeRefresh(boolean&nbsp;value)</pre>
<div class="block">PUBLIC:
Sets the cascading for the JPA REFRESH operation.</div>
</li>
</ul>
<a name="setCascadeRemove-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCascadeRemove</h4>
<pre>public&nbsp;void&nbsp;setCascadeRemove(boolean&nbsp;value)</pre>
<div class="block">PUBLIC:
Sets the cascading for the JPA REMOVE operation.</div>
</li>
</ul>
<a name="setCustomSelectionQuery-org.eclipse.persistence.queries.ReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCustomSelectionQuery</h4>
<pre>public&nbsp;void&nbsp;setCustomSelectionQuery(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;query)</pre>
<div class="block">PUBLIC:
Relationship mappings creates a read query to read reference objects. If this default
query needs to be customize then user can specify its own read query to do the reading
of reference objects. One must instance of ReadQuery or subclasses of the ReadQuery.</div>
</li>
</ul>
<a name="setHasCustomSelectionQuery-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHasCustomSelectionQuery</h4>
<pre>protected&nbsp;void&nbsp;setHasCustomSelectionQuery(boolean&nbsp;bool)</pre>
</li>
</ul>
<a name="setForceInitializationOfSelectionCriteria-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForceInitializationOfSelectionCriteria</h4>
<pre>public&nbsp;void&nbsp;setForceInitializationOfSelectionCriteria(boolean&nbsp;bool)</pre>
<div class="block">INTERNAL:
A way of forcing the selection criteria to be rebuilt.</div>
</li>
</ul>
<a name="setIndirectionPolicy-org.eclipse.persistence.internal.indirection.IndirectionPolicy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndirectionPolicy</h4>
<pre>public&nbsp;void&nbsp;setIndirectionPolicy(org.eclipse.persistence.internal.indirection.IndirectionPolicy&nbsp;indirectionPolicy)</pre>
<div class="block">ADVANCED:
Set the indirection policy.</div>
</li>
</ul>
<a name="setIsPrivateOwned-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsPrivateOwned</h4>
<pre>public&nbsp;void&nbsp;setIsPrivateOwned(boolean&nbsp;isPrivateOwned)</pre>
<div class="block">PUBLIC:
Set if the relationship is privately owned.
A privately owned relationship means the target object is a dependent part of the source
object and is not referenced by any other object and cannot exist on its own.
Private ownership causes many operations to be cascaded across the relationship,
including, deletion, insertion, refreshing, locking (when cascaded).
It also ensures that private objects removed from collections are deleted and object added are inserted.</div>
</li>
</ul>
<a name="setRealAttributeValueInObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRealAttributeValueInObject</h4>
<pre>public&nbsp;void&nbsp;setRealAttributeValueInObject(<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;object,
<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;value)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">INTERNAL:
Set the value of the attribute mapped by this mapping,
placing it inside a value holder if necessary.
If the value holder is not instantiated then it is instantiated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setRealAttributeValueInObject-java.lang.Object-java.lang.Object-">setRealAttributeValueInObject</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="setReferenceClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReferenceClass</h4>
<pre>public&nbsp;void&nbsp;setReferenceClass(<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>&nbsp;referenceClass)</pre>
<div class="block">PUBLIC:
Set the referenced class.</div>
</li>
</ul>
<a name="setReferenceClassName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReferenceClassName</h4>
<pre>public&nbsp;void&nbsp;setReferenceClassName(<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>&nbsp;referenceClassName)</pre>
<div class="block">INTERNAL:
Used by MW.</div>
</li>
</ul>
<a name="setReferenceDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReferenceDescriptor</h4>
<pre>protected&nbsp;void&nbsp;setReferenceDescriptor(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;aDescriptor)</pre>
<div class="block">Set the referenceDescriptor. This is a descriptor which is associated with
the reference class.</div>
</li>
</ul>
<a name="setRelationshipPartner-org.eclipse.persistence.mappings.DatabaseMapping-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRelationshipPartner</h4>
<pre>public&nbsp;void&nbsp;setRelationshipPartner(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a>&nbsp;mapping)</pre>
<div class="block">INTERNAL:
Sets the relationshipPartner mapping for this bi-directional mapping. If the relationshipPartner is null then
this is a uni-directional mapping.</div>
</li>
</ul>
<a name="setRelationshipPartnerAttributeName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRelationshipPartnerAttributeName</h4>
<pre>public&nbsp;void&nbsp;setRelationshipPartnerAttributeName(<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>&nbsp;attributeName)</pre>
<div class="block">PUBLIC:
Use this method to specify the relationship partner attribute name of a bidirectional Mapping.
TopLink will use the attribute name to find the back pointer mapping to maintain referential integrity of
the bi-directional mappings.</div>
</li>
</ul>
<a name="setRequiresTransientWeavedFields-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequiresTransientWeavedFields</h4>
<pre>public&nbsp;void&nbsp;setRequiresTransientWeavedFields(boolean&nbsp;requiresTransientWeavedFields)</pre>
<div class="block">Set this flag if this mappings associated weaved field requires a
transient setting to avoid metadata processing.</div>
</li>
</ul>
<a name="setSelectionCriteria-org.eclipse.persistence.expressions.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectionCriteria</h4>
<pre>public&nbsp;void&nbsp;setSelectionCriteria(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;anExpression)</pre>
<div class="block">PUBLIC:
Sets the selection criteria to be used as a where clause to read
reference objects. This criteria is automatically generated by the
TopLink if not explicitly specified by the user.</div>
</li>
</ul>
<a name="setSelectionQuery-org.eclipse.persistence.queries.ReadQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectionQuery</h4>
<pre>protected&nbsp;void&nbsp;setSelectionQuery(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;aQuery)</pre>
<div class="block">Sets the query</div>
</li>
</ul>
<a name="setSelectionSQLString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectionSQLString</h4>
<pre>public&nbsp;void&nbsp;setSelectionSQLString(<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>&nbsp;sqlString)</pre>
<div class="block">PUBLIC:
This is a property on the mapping which will allow custom SQL to be
substituted for reading a reference object.</div>
</li>
</ul>
<a name="setSelectionCall-org.eclipse.persistence.queries.Call-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectionCall</h4>
<pre>public&nbsp;void&nbsp;setSelectionCall(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a>&nbsp;call)</pre>
<div class="block">PUBLIC:
This is a property on the mapping which will allow custom call to be
substituted for reading a reference object.</div>
</li>
</ul>
<a name="setShouldExtendPessimisticLockScope-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShouldExtendPessimisticLockScope</h4>
<pre>public&nbsp;void&nbsp;setShouldExtendPessimisticLockScope(boolean&nbsp;shouldExtend)</pre>
<div class="block">ADVANCED:
Indicates whether pessimistic lock of ObjectLevelReadQuery with isPessimisticLockScopeExtended set to true
should be applied through this mapping beyond the tables mapped to the source object.</div>
</li>
</ul>
<a name="setTempSession-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTempSession</h4>
<pre>protected&nbsp;void&nbsp;setTempSession(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
</li>
</ul>
<a name="setUsesBatchReading-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsesBatchReading</h4>
<pre>public&nbsp;void&nbsp;setUsesBatchReading(boolean&nbsp;usesBatchReading)</pre>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.
Batch reading will read all of the related objects in a single query when accessed from an originating read all.
This should only be used if it is know that the related objects are always required with the source object, or indirection is not used.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#setBatchFetchType-org.eclipse.persistence.annotations.BatchFetchType-"><code>setBatchFetchType(BatchFetchType)</code></a></dd>
</dl>
</li>
</ul>
<a name="setUsesIndirection-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsesIndirection</h4>
<pre>public&nbsp;void&nbsp;setUsesIndirection(boolean&nbsp;usesIndirection)</pre>
<div class="block">PUBLIC:
Indirection means that a ValueHolder will be put in-between the attribute and the real object.
This allows for the reading of the target from the database to be delayed until accessed.
This defaults to true and is strongly suggested as it give a huge performance gain.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#useBasicIndirection--"><code>useBasicIndirection()</code></a>,
<a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html#dontUseIndirection--"><code>dontUseIndirection()</code></a></dd>
</dl>
</li>
</ul>
<a name="shouldExtendPessimisticLockScope--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldExtendPessimisticLockScope</h4>
<pre>public&nbsp;boolean&nbsp;shouldExtendPessimisticLockScope()</pre>
<div class="block">INTERNAL:
Indicates whether pessimistic lock of ObjectLevelReadQuery with isPessimisticLockScopeExtended set to true
should be applied through this mapping beyond the tables mapped to the source object.</div>
</li>
</ul>
<a name="shouldExtendPessimisticLockScopeInSourceQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldExtendPessimisticLockScopeInSourceQuery</h4>
<pre>public&nbsp;boolean&nbsp;shouldExtendPessimisticLockScopeInSourceQuery()</pre>
</li>
</ul>
<a name="shouldExtendPessimisticLockScopeInTargetQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldExtendPessimisticLockScopeInTargetQuery</h4>
<pre>public&nbsp;boolean&nbsp;shouldExtendPessimisticLockScopeInTargetQuery()</pre>
</li>
</ul>
<a name="shouldExtendPessimisticLockScopeInDedicatedQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldExtendPessimisticLockScopeInDedicatedQuery</h4>
<pre>public&nbsp;boolean&nbsp;shouldExtendPessimisticLockScopeInDedicatedQuery()</pre>
</li>
</ul>
<a name="shouldForceInitializationOfSelectionCriteria--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldForceInitializationOfSelectionCriteria</h4>
<pre>protected&nbsp;boolean&nbsp;shouldForceInitializationOfSelectionCriteria()</pre>
<div class="block">INTERNAL:</div>
</li>
</ul>
<a name="shouldInitializeSelectionCriteria--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldInitializeSelectionCriteria</h4>
<pre>protected&nbsp;boolean&nbsp;shouldInitializeSelectionCriteria()</pre>
</li>
</ul>
<a name="shouldMergeCascadeParts-org.eclipse.persistence.internal.sessions.MergeManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldMergeCascadeParts</h4>
<pre>public&nbsp;boolean&nbsp;shouldMergeCascadeParts(org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</pre>
<div class="block">INTERNAL:
Returns true if the merge should cascade to the mappings reference's parts.</div>
</li>
</ul>
<a name="shouldRefreshCascadeParts-org.eclipse.persistence.internal.sessions.MergeManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldRefreshCascadeParts</h4>
<pre>public&nbsp;boolean&nbsp;shouldRefreshCascadeParts(org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</pre>
<div class="block">INTERNAL:
Returns true if the merge should cascade to the mappings reference's parts.</div>
</li>
</ul>
<a name="shouldMergeCascadeReference-org.eclipse.persistence.internal.sessions.MergeManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldMergeCascadeReference</h4>
<pre>protected&nbsp;boolean&nbsp;shouldMergeCascadeReference(org.eclipse.persistence.internal.sessions.MergeManager&nbsp;mergeManager)</pre>
<div class="block">Returns true if the merge should cascade to the mappings reference.</div>
</li>
</ul>
<a name="shouldObjectModifyCascadeToParts-org.eclipse.persistence.queries.ObjectLevelModifyQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldObjectModifyCascadeToParts</h4>
<pre>protected&nbsp;boolean&nbsp;shouldObjectModifyCascadeToParts(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a>&nbsp;query)</pre>
<div class="block">Returns true if any process leading to object modification should also affect its parts
Usually used by write, insert, update and delete.</div>
</li>
</ul>
<a name="shouldUseBatchReading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldUseBatchReading</h4>
<pre>public&nbsp;boolean&nbsp;shouldUseBatchReading()</pre>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.
Batch reading will read all of the related objects in a single query when accessed from an originating read all.
This should only be used if it is know that the related objects are always required with the source object, or indirection is not used.</div>
</li>
</ul>
<a name="useBasicIndirection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useBasicIndirection</h4>
<pre>public&nbsp;void&nbsp;useBasicIndirection()</pre>
<div class="block">PUBLIC:
Indirection means that a ValueHolder will be put in-between the attribute and the real object.
This allows for the reading of the target from the database to be delayed until accessed.
This defaults to true and is strongly suggested as it give a huge performance gain.</div>
</li>
</ul>
<a name="useBatchReading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useBatchReading</h4>
<pre>public&nbsp;void&nbsp;useBatchReading()</pre>
<div class="block">PUBLIC:
Indicates whether the referenced object should always be batch read on read all queries.
Batch reading will read all of the related objects in a single query when accessed from an originating read all.
This should only be used if it is know that the related objects are always required with the source object, or indirection is not used.</div>
</li>
</ul>
<a name="useWeavedIndirection-java.lang.String-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useWeavedIndirection</h4>
<pre>public&nbsp;void&nbsp;useWeavedIndirection(<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>&nbsp;getMethodName,
<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>&nbsp;setMethodName,
boolean&nbsp;hasUsedMethodAccess)</pre>
<div class="block">INTERNAL:
Configures the mapping to used weaved indirection.
This requires that the toplink-agent be used to weave indirection into the class.
This policy is only require for method access.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>getMethodName</code> - is the name of the original (or weaved in field access case) set method for the mapping.</dd>
<dd><code>setMethodName</code> - is the name of the original (or weaved in field access case) set method for the mapping.</dd>
<dd><code>hasUsedMethodAccess</code> - indicates whether method or field access was originally used.</dd>
</dl>
</li>
</ul>
<a name="useContainerIndirection-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useContainerIndirection</h4>
<pre>public&nbsp;void&nbsp;useContainerIndirection(<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>&nbsp;containerClass)</pre>
<div class="block">PUBLIC:
Indirection means that a IndirectContainer (wrapping a ValueHolder) will be put in-between the attribute and the real object.
This allows for an application specific class to be used which wraps the value holder.
The purpose of this is that the domain objects will not require to import the ValueHolderInterface class.
Refer also to transparent indirection for a transparent solution to indirection.</div>
</li>
</ul>
<a name="usesIndirection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usesIndirection</h4>
<pre>public&nbsp;boolean&nbsp;usesIndirection()</pre>
<div class="block">PUBLIC:
Indirection means that some sort of indirection object will be put in-between the attribute and the real object.
This allows for the reading of the target from the database to be delayed until accessed.
This defaults to true and is strongly suggested as it give a huge performance gain.</div>
</li>
</ul>
<a name="updateChangeRecordForSelfMerge-org.eclipse.persistence.internal.sessions.ChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateChangeRecordForSelfMerge</h4>
<pre>public abstract&nbsp;void&nbsp;updateChangeRecordForSelfMerge(org.eclipse.persistence.internal.sessions.ChangeRecord&nbsp;changeRecord,
<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;source,
<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;target,
org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet&nbsp;parentUOWChangeSet,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl&nbsp;unitOfWork)</pre>
<div class="block">INTERNAL:
Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity. This is
used when an Entity is merged into itself and the Entity reference new or detached entities.</div>
</li>
</ul>
<a name="setJoinFetch-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJoinFetch</h4>
<pre>public&nbsp;void&nbsp;setJoinFetch(int&nbsp;joinFetch)</pre>
<div class="block">PUBLIC:
Indicates whether the referenced object(s) should always be joined on read queries.
Joining will join the two classes tables to read all of the data in a single query.
This should only be used if it is know that the related objects are always required with the source object,
or indirection is not used.
A join-fetch can either use an INNER_JOIN or OUTER_JOIN,
if the relationship may reference null or an empty collection an outer join should be used to avoid filtering the source objects from the queries.
Join fetch can also be specified on the query, and it is normally more efficient to do so as some queries may not require the related objects.
Typically batch reading is more efficient than join fetching and should be considered, especially for collection relationships.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#addJoinedAttribute-java.lang.String-"><code>ObjectLevelReadQuery.addJoinedAttribute(String)</code></a>,
<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#addBatchReadAttribute-java.lang.String-"><code>ObjectLevelReadQuery.addBatchReadAttribute(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getJoinFetch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoinFetch</h4>
<pre>public&nbsp;int&nbsp;getJoinFetch()</pre>
<div class="block">PUBLIC:
Return if this relationship should always be join fetched.</div>
</li>
</ul>
<a name="setMappedBy-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMappedBy</h4>
<pre>public&nbsp;void&nbsp;setMappedBy(<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>&nbsp;mappedBy)</pre>
<div class="block">INTERNAL: Called by JPA metadata processing to store the owning mapping
for this mapping</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mappedBy</code> - </dd>
</dl>
</li>
</ul>
<a name="isJoinFetched--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJoinFetched</h4>
<pre>public&nbsp;boolean&nbsp;isJoinFetched()</pre>
<div class="block">PUBLIC:
Return if this relationship should always be join fetched.</div>
</li>
</ul>
<a name="isInnerJoinFetched--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInnerJoinFetched</h4>
<pre>public&nbsp;boolean&nbsp;isInnerJoinFetched()</pre>
<div class="block">PUBLIC:
Return if this relationship should always be INNER join fetched.</div>
</li>
</ul>
<a name="isOuterJoinFetched--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOuterJoinFetched</h4>
<pre>public&nbsp;boolean&nbsp;isOuterJoinFetched()</pre>
<div class="block">PUBLIC:
Return if this relationship should always be OUTER join fetched.</div>
</li>
</ul>
<a name="useInnerJoinFetch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useInnerJoinFetch</h4>
<pre>public&nbsp;void&nbsp;useInnerJoinFetch()</pre>
<div class="block">PUBLIC:
Specify this relationship to always be join fetched using an INNER join.</div>
</li>
</ul>
<a name="useOuterJoinFetch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useOuterJoinFetch</h4>
<pre>public&nbsp;void&nbsp;useOuterJoinFetch()</pre>
<div class="block">PUBLIC:
Specify this relationship to always be join fetched using an OUTER join.</div>
</li>
</ul>
<a name="isCascadeOnDeleteSetOnDatabase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCascadeOnDeleteSetOnDatabase</h4>
<pre>public&nbsp;boolean&nbsp;isCascadeOnDeleteSetOnDatabase()</pre>
<div class="block">ADVANCED:
Return if delete cascading has been set on the database for the
mapping's foreign key constraint.</div>
</li>
</ul>
<a name="setIsCascadeOnDeleteSetOnDatabase-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsCascadeOnDeleteSetOnDatabase</h4>
<pre>public&nbsp;void&nbsp;setIsCascadeOnDeleteSetOnDatabase(boolean&nbsp;isCascadeOnDeleteSetOnDatabase)</pre>
<div class="block">ADVANCED:
Set if delete cascading has been set on the database for the
mapping's foreign key constraint.
The behavior is dependent on the mapping.
<p>OneToOne (target foreign key) - deletes target object (private owned)
<p>OneToMany, AggregateCollection - deletes target objects (private owned)
<p>ManyToMany - deletes from join table (only)
<p>DirectCollection - delete from direct table</div>
</li>
</ul>
<a name="setIsCacheable-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsCacheable</h4>
<pre>public&nbsp;void&nbsp;setIsCacheable(boolean&nbsp;cacheable)</pre>
<div class="block">Used to signal that this mapping references a protected/isolated entity and requires
special merge/object building behaviour.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsCacheable-boolean-">setIsCacheable</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</li>
</ul>
<a name="validateBeforeInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateBeforeInitialization</h4>
<pre>public&nbsp;void&nbsp;validateBeforeInitialization(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre>
<div class="block">INTERNAL:
To validate mappings declaration</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#validateBeforeInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-">validateBeforeInitialization</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd>
</dl>
</li>
</ul>
<a name="valueFromPKList-java.lang.Object:A-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueFromPKList</h4>
<pre>public abstract&nbsp;<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;valueFromPKList(<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;pks,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;foreignKeys,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">This method is used to load a relationship from a list of PKs. This list
may be available if the relationship has been cached.</div>
</li>
</ul>
<a name="valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-java.lang.Boolean:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueFromRow</h4>
<pre>public&nbsp;<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;valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;isTargetProtected,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>[]&nbsp;wasCacheUsed)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL: Return the value of the reference attribute or a value holder.
Check whether the mapping's attribute should be optimized through batch
and joining.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-java.lang.Boolean:A-">valueFromRow</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
</dl>
</li>
</ul>
<a name="shouldUseValueFromRowWithJoin-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldUseValueFromRowWithJoin</h4>
<pre>protected&nbsp;boolean&nbsp;shouldUseValueFromRowWithJoin(org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery)</pre>
<div class="block">INTERNAL:
Indicates whether valueFromRow should call valueFromRowInternalWithJoin (true)
or valueFromRowInternal (false)</div>
</li>
</ul>
<a name="valueFromRowInternalWithJoin-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-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>valueFromRowInternalWithJoin</h4>
<pre>protected&nbsp;<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;valueFromRowInternalWithJoin(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;parentCacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;isTargetProtected)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
If the query used joining or partial attributes, build the target object directly.
If isJoiningSupported()==true then this method must be overridden.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
</dl>
</li>
</ul>
<a name="valueFromRowInternal-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueFromRowInternal</h4>
<pre>protected&nbsp;<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;valueFromRowInternal(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
Return the value of the reference attribute or a value holder.
Check whether the mapping's attribute should be optimized through batch and joining.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
</dl>
</li>
</ul>
<a name="valueFromRowInternal-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueFromRowInternal</h4>
<pre>protected&nbsp;<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;valueFromRowInternal(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession,
boolean&nbsp;shouldUseSopObject)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
Return the value of the reference attribute or a value holder.
Check whether the mapping's attribute should be optimized through batch and joining.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shouldUseSopObject</code> - indicates whether sopObject stored in the row should be used to extract the value (and fields/values stored in the row ignored).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
</dl>
</li>
</ul>
<a name="isExtendingPessimisticLockScope-org.eclipse.persistence.queries.ObjectBuildingQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExtendingPessimisticLockScope</h4>
<pre>protected&nbsp;boolean&nbsp;isExtendingPessimisticLockScope(<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery)</pre>
<div class="block">INTERNAL:
Indicates whether the source query's pessimistic lock scope scope should be extended in the target query.</div>
</li>
</ul>
<a name="prepareHistoricalQuery-org.eclipse.persistence.queries.ReadQuery-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareHistoricalQuery</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;prepareHistoricalQuery(<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;targetQuery,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</pre>
<div class="block">INTERNAL:
Allow for the mapping to perform any historical query additions.
Return the new target query.</div>
</li>
</ul>
<a name="trimRowForJoin-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimRowForJoin</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;trimRowForJoin(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</pre>
<div class="block">INTERNAL:
Return a sub-partition of the row starting at the index for the mapping.</div>
</li>
</ul>
<a name="trimRowForJoin-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimRowForJoin</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;trimRowForJoin(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
<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;value,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</pre>
<div class="block">INTERNAL:
Return a sub-partition of the row starting at the index.</div>
</li>
</ul>
<a name="prepareNestedJoinQueryClone-org.eclipse.persistence.internal.sessions.AbstractRecord-java.util.List-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareNestedJoinQueryClone</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a>&nbsp;prepareNestedJoinQueryClone(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;dataResults,
org.eclipse.persistence.internal.queries.JoinedAttributeManager&nbsp;joinManager,
<a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a>&nbsp;sourceQuery,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</pre>
<div class="block">INTERNAL:
Prepare the clone of the nested query for joining.
The nested query clones are stored on the execution (clone) joinManager to avoid cloning per row.</div>
</li>
</ul>
<a name="getBatchFetchType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchFetchType</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations">BatchFetchType</a>&nbsp;getBatchFetchType()</pre>
<div class="block">PUBLIC:
Return the type of batch fetching to use for all queries for this class if configured.</div>
</li>
</ul>
<a name="setBatchFetchType-org.eclipse.persistence.annotations.BatchFetchType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchFetchType</h4>
<pre>public&nbsp;void&nbsp;setBatchFetchType(<a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations">BatchFetchType</a>&nbsp;batchFetchType)</pre>
<div class="block">PUBLIC:
Set the type of batch fetching to use for all queries for this class.</div>
</li>
</ul>
<a name="addTargetForeignKeyField-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.helper.DatabaseField-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTargetForeignKeyField</h4>
<pre>public&nbsp;void&nbsp;addTargetForeignKeyField(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;targetForeignKeyField,
org.eclipse.persistence.internal.helper.DatabaseField&nbsp;sourcePrimaryKeyField)</pre>
<div class="block">INTERNAL:
Allow subclass to define a foreign key in the target's table.</div>
</li>
</ul>
<a name="addForeignKeyField-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.helper.DatabaseField-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addForeignKeyField</h4>
<pre>public&nbsp;void&nbsp;addForeignKeyField(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;sourceForeignKeyField,
org.eclipse.persistence.internal.helper.DatabaseField&nbsp;targetPrimaryKeyField)</pre>
<div class="block">INTERNAL:
Allow subclass to define a foreign key in the source's table.</div>
</li>
</ul>
<a name="getOrderByNormalizedExpressions-org.eclipse.persistence.expressions.Expression-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOrderByNormalizedExpressions</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&gt;&nbsp;getOrderByNormalizedExpressions(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;base)</pre>
<div class="block">INTERNAL:
Relationships order by their target primary key fields by default.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getOrderByNormalizedExpressions-org.eclipse.persistence.expressions.Expression-">getOrderByNormalizedExpressions</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></dd>
</dl>
</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/EmbeddableMapping.html" title="interface in org.eclipse.persistence.mappings"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/mappings/ForeignReferenceMapping.html" target="_top">Frames</a></li>
<li><a href="ForeignReferenceMapping.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><a href="#nested.classes.inherited.from.class.org.eclipse.persistence.mappings.DatabaseMapping">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>