| <!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:10 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ForeignReferenceQueryKey (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="ForeignReferenceQueryKey (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/querykeys/DirectQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ManyToManyQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html" target="_top">Frames</a></li> |
| <li><a href="ForeignReferenceQueryKey.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.querykeys</div> |
| <h2 title="Class ForeignReferenceQueryKey" class="title">Class ForeignReferenceQueryKey</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/mappings/querykeys/QueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">org.eclipse.persistence.mappings.querykeys.QueryKey</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.mappings.querykeys.ForeignReferenceQueryKey</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/querykeys/DirectCollectionQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">DirectCollectionQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/ManyToManyQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">ManyToManyQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/OneToManyQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">OneToManyQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/OneToOneQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">OneToOneQueryKey</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ForeignReferenceQueryKey</span> |
| extends <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">QueryKey</a></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: Define an alias to a foreign object. |
| <p> |
| <b> Responsibilities</b>: |
| <ul> |
| <li> Define the reference class of the foreign object. |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.mappings.querykeys.ForeignReferenceQueryKey">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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"> </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/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/querykeys/ForeignReferenceQueryKey.html#joinCriteria">joinCriteria</a></span></code> </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/querykeys/ForeignReferenceQueryKey.html#referenceClass">referenceClass</a></span></code> </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/querykeys/ForeignReferenceQueryKey.html#referenceClassName">referenceClassName</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.mappings.querykeys.QueryKey"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.persistence.mappings.querykeys.<a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">QueryKey</a></h3> |
| <code><a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#descriptor">descriptor</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#name">name</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"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html#ForeignReferenceQueryKey--">ForeignReferenceQueryKey</a></span>()</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.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> classLoader)</code> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this project to actual class-based |
| settings</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/querykeys/ForeignReferenceQueryKey.html#getJoinCriteria--">getJoinCriteria</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the join expression for the relationship defined by the query key.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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/querykeys/ForeignReferenceQueryKey.html#getReferenceClass--">getReferenceClass</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the reference class of the relationship.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/querykeys/ForeignReferenceQueryKey.html#getReferenceClassName--">getReferenceClassName</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the reference class name of the relationship.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseTable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html#getReferenceTable-org.eclipse.persistence.descriptors.ClassDescriptor-">getReferenceTable</a></span>(<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> desc)</code> |
| <div class="block">PUBLIC: |
| Returns the reference table.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseTable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html#getRelationTable-org.eclipse.persistence.descriptors.ClassDescriptor-">getRelationTable</a></span>(<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> referenceDescriptor)</code> |
| <div class="block">PUBLIC: |
| Returns the relation table.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseTable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html#getSourceTable--">getSourceTable</a></span>()</code> |
| <div class="block">PUBLIC: |
| Returns the source table.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html#isForeignReferenceQueryKey--">isForeignReferenceQueryKey</a></span>()</code> |
| <div class="block">INTERNAL: |
| override the isForeignReferenceQueryKey() method in the superclass to return true.</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/querykeys/ForeignReferenceQueryKey.html#setJoinCriteria-org.eclipse.persistence.expressions.Expression-">setJoinCriteria</a></span>(<a href="../../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> joinCriteria)</code> |
| <div class="block">PUBLIC: |
| Set the join expression for the relationship defined by the query key.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.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> referenceClass)</code> |
| <div class="block">PUBLIC: |
| Set the reference class of the relationship.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.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> referenceClassName)</code> |
| <div class="block">PUBLIC: |
| Set the reference class name for this relationship |
| This is used when projects are built without using classes</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.mappings.querykeys.QueryKey"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.persistence.mappings.querykeys.<a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">QueryKey</a></h3> |
| <code><a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#clone--">clone</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#getDescriptor--">getDescriptor</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#getName--">getName</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#initialize-org.eclipse.persistence.descriptors.ClassDescriptor-">initialize</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isAbstractQueryKey--">isAbstractQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isCollectionQueryKey--">isCollectionQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isDirectCollectionQueryKey--">isDirectCollectionQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isDirectQueryKey--">isDirectQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isManyToManyQueryKey--">isManyToManyQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isOneToManyQueryKey--">isOneToManyQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isOneToOneQueryKey--">isOneToOneQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isQueryKey--">isQueryKey</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#toString--">toString</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 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="referenceClass"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referenceClass</h4> |
| <pre>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> referenceClass</pre> |
| </li> |
| </ul> |
| <a name="referenceClassName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referenceClassName</h4> |
| <pre>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> referenceClassName</pre> |
| </li> |
| </ul> |
| <a name="joinCriteria"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>joinCriteria</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> joinCriteria</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ForeignReferenceQueryKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ForeignReferenceQueryKey</h4> |
| <pre>public ForeignReferenceQueryKey()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="convertClassNamesToClasses-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertClassNamesToClasses</h4> |
| <pre>public void 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> classLoader)</pre> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this project to actual class-based |
| settings</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></code> in class <code><a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">QueryKey</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoader</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJoinCriteria--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJoinCriteria</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> getJoinCriteria()</pre> |
| <div class="block">PUBLIC: |
| Return the join expression for the relationship defined by the query key.</div> |
| </li> |
| </ul> |
| <a name="getReferenceClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceClass</h4> |
| <pre>public <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> getReferenceClass()</pre> |
| <div class="block">PUBLIC: |
| Return the reference class of the relationship.</div> |
| </li> |
| </ul> |
| <a name="getReferenceClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceClassName</h4> |
| <pre>public <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> getReferenceClassName()</pre> |
| <div class="block">PUBLIC: |
| Return the reference class name of the relationship.</div> |
| </li> |
| </ul> |
| <a name="isForeignReferenceQueryKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isForeignReferenceQueryKey</h4> |
| <pre>public boolean isForeignReferenceQueryKey()</pre> |
| <div class="block">INTERNAL: |
| override the isForeignReferenceQueryKey() method in the superclass to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html#isForeignReferenceQueryKey--">isForeignReferenceQueryKey</a></code> in class <code><a href="../../../../../org/eclipse/persistence/mappings/querykeys/QueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys">QueryKey</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setJoinCriteria-org.eclipse.persistence.expressions.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJoinCriteria</h4> |
| <pre>public void setJoinCriteria(<a href="../../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> joinCriteria)</pre> |
| <div class="block">PUBLIC: |
| Set the join expression for the relationship defined by the query key. |
| <p>Example: |
| <blockquote><pre> |
| builder.getField("ADDRESS.ADDRESS_ID").equal(builder.getParameter("EMPLOYEE.ADDR_ID"); |
| </pre></blockquote></div> |
| </li> |
| </ul> |
| <a name="setReferenceClass-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReferenceClass</h4> |
| <pre>public void 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> referenceClass)</pre> |
| <div class="block">PUBLIC: |
| Set the reference class of the relationship. |
| This is not required for direct collection query keys.</div> |
| </li> |
| </ul> |
| <a name="setReferenceClassName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReferenceClassName</h4> |
| <pre>public void 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> referenceClassName)</pre> |
| <div class="block">PUBLIC: |
| Set the reference class name for this relationship |
| This is used when projects are built without using classes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>referenceClassName</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSourceTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceTable</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseTable getSourceTable()</pre> |
| <div class="block">PUBLIC: |
| Returns the source table.</div> |
| </li> |
| </ul> |
| <a name="getReferenceTable-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceTable</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseTable getReferenceTable(<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> desc)</pre> |
| <div class="block">PUBLIC: |
| Returns the reference table.</div> |
| </li> |
| </ul> |
| <a name="getRelationTable-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRelationTable</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseTable getRelationTable(<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> referenceDescriptor)</pre> |
| <div class="block">PUBLIC: |
| Returns the relation table. |
| Currently only ManyToMany and OneToOne may have relation table. |
| The method is overridden to return null for other subclasses. |
| The returned relationTable still could be null.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/querykeys/DirectQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/querykeys/ManyToManyQueryKey.html" title="class in org.eclipse.persistence.mappings.querykeys"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/mappings/querykeys/ForeignReferenceQueryKey.html" target="_top">Frames</a></li> |
| <li><a href="ForeignReferenceQueryKey.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |