| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>RelationField</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RelationField"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openejb/jee/jpa/QueryHint.html" title="class in org.apache.openejb.jee.jpa"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openejb/jee/jpa/SecondaryTable.html" title="class in org.apache.openejb.jee.jpa"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/jee/jpa/RelationField.html" target="_top">Frames</a></li> |
| <li><a href="RelationField.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openejb.jee.jpa</div> |
| <h2 title="Interface RelationField" class="title">Interface RelationField</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/openejb/jee/Keyable.html" title="interface in org.apache.openejb.jee">Keyable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openejb/jee/jpa/ManyToMany.html" title="class in org.apache.openejb.jee.jpa">ManyToMany</a>, <a href="../../../../../org/apache/openejb/jee/jpa/ManyToOne.html" title="class in org.apache.openejb.jee.jpa">ManyToOne</a>, <a href="../../../../../org/apache/openejb/jee/jpa/OneToMany.html" title="class in org.apache.openejb.jee.jpa">OneToMany</a>, <a href="../../../../../org/apache/openejb/jee/jpa/OneToOne.html" title="class in org.apache.openejb.jee.jpa">OneToOne</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RelationField</span> |
| extends <a href="../../../../../org/apache/openejb/jee/Keyable.html" title="interface in org.apache.openejb.jee">Keyable</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/jee/jpa/CascadeType.html" title="class in org.apache.openejb.jee.jpa">CascadeType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getCascade--">getCascade</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/jee/jpa/FetchType.html" title="enum in org.apache.openejb.jee.jpa">FetchType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getFetch--">getFetch</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/openejb/jee/jpa/JoinColumn.html" title="class in org.apache.openejb.jee.jpa">JoinColumn</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getJoinColumn--">getJoinColumn</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/jee/jpa/JoinTable.html" title="class in org.apache.openejb.jee.jpa">JoinTable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getJoinTable--">getJoinTable</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getMappedBy--">getMappedBy</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getName--">getName</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html" title="interface in org.apache.openejb.jee.jpa">RelationField</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getRelatedField--">getRelatedField</a></span>()</code> |
| <div class="block">This is only used for xml converters and will normally return null.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#getTargetEntity--">getTargetEntity</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#isSyntheticField--">isSyntheticField</a></span>()</code> |
| <div class="block">This is only used for xml converters and will normally return false.</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/apache/openejb/jee/jpa/RelationField.html#setCascade-org.apache.openejb.jee.jpa.CascadeType-">setCascade</a></span>(<a href="../../../../../org/apache/openejb/jee/jpa/CascadeType.html" title="class in org.apache.openejb.jee.jpa">CascadeType</a> value)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#setFetch-org.apache.openejb.jee.jpa.FetchType-">setFetch</a></span>(<a href="../../../../../org/apache/openejb/jee/jpa/FetchType.html" title="enum in org.apache.openejb.jee.jpa">FetchType</a> value)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#setJoinTable-org.apache.openejb.jee.jpa.JoinTable-">setJoinTable</a></span>(<a href="../../../../../org/apache/openejb/jee/jpa/JoinTable.html" title="class in org.apache.openejb.jee.jpa">JoinTable</a> value)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#setMappedBy-java.lang.String-">setMappedBy</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#setName-java.lang.String-">setName</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#setRelatedField-org.apache.openejb.jee.jpa.RelationField-">setRelatedField</a></span>(<a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html" title="interface in org.apache.openejb.jee.jpa">RelationField</a> value)</code> |
| <div class="block">Gets the field on the target entity for this relationship.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html#setSyntheticField-boolean-">setSyntheticField</a></span>(boolean syntheticField)</code> |
| <div class="block">This is only used for xml converters and will normally return false.</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/apache/openejb/jee/jpa/RelationField.html#setTargetEntity-java.lang.String-">setTargetEntity</a></span>(java.lang.String value)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.jee.Keyable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openejb.jee.<a href="../../../../../org/apache/openejb/jee/Keyable.html" title="interface in org.apache.openejb.jee">Keyable</a></h3> |
| <code><a href="../../../../../org/apache/openejb/jee/Keyable.html#getKey--">getKey</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getJoinColumn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJoinColumn</h4> |
| <pre>java.util.List<<a href="../../../../../org/apache/openejb/jee/jpa/JoinColumn.html" title="class in org.apache.openejb.jee.jpa">JoinColumn</a>> getJoinColumn()</pre> |
| </li> |
| </ul> |
| <a name="getJoinTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJoinTable</h4> |
| <pre><a href="../../../../../org/apache/openejb/jee/jpa/JoinTable.html" title="class in org.apache.openejb.jee.jpa">JoinTable</a> getJoinTable()</pre> |
| </li> |
| </ul> |
| <a name="setJoinTable-org.apache.openejb.jee.jpa.JoinTable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJoinTable</h4> |
| <pre>void setJoinTable(<a href="../../../../../org/apache/openejb/jee/jpa/JoinTable.html" title="class in org.apache.openejb.jee.jpa">JoinTable</a> value)</pre> |
| </li> |
| </ul> |
| <a name="getCascade--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascade</h4> |
| <pre><a href="../../../../../org/apache/openejb/jee/jpa/CascadeType.html" title="class in org.apache.openejb.jee.jpa">CascadeType</a> getCascade()</pre> |
| </li> |
| </ul> |
| <a name="setCascade-org.apache.openejb.jee.jpa.CascadeType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascade</h4> |
| <pre>void setCascade(<a href="../../../../../org/apache/openejb/jee/jpa/CascadeType.html" title="class in org.apache.openejb.jee.jpa">CascadeType</a> value)</pre> |
| </li> |
| </ul> |
| <a name="getFetch--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetch</h4> |
| <pre><a href="../../../../../org/apache/openejb/jee/jpa/FetchType.html" title="enum in org.apache.openejb.jee.jpa">FetchType</a> getFetch()</pre> |
| </li> |
| </ul> |
| <a name="setFetch-org.apache.openejb.jee.jpa.FetchType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetch</h4> |
| <pre>void setFetch(<a href="../../../../../org/apache/openejb/jee/jpa/FetchType.html" title="enum in org.apache.openejb.jee.jpa">FetchType</a> value)</pre> |
| </li> |
| </ul> |
| <a name="getMappedBy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedBy</h4> |
| <pre>java.lang.String getMappedBy()</pre> |
| </li> |
| </ul> |
| <a name="setMappedBy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMappedBy</h4> |
| <pre>void setMappedBy(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| </li> |
| </ul> |
| <a name="setName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>void setName(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getTargetEntity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTargetEntity</h4> |
| <pre>java.lang.String getTargetEntity()</pre> |
| </li> |
| </ul> |
| <a name="setTargetEntity-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTargetEntity</h4> |
| <pre>void setTargetEntity(java.lang.String value)</pre> |
| </li> |
| </ul> |
| <a name="getRelatedField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelatedField</h4> |
| <pre><a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html" title="interface in org.apache.openejb.jee.jpa">RelationField</a> getRelatedField()</pre> |
| <div class="block">This is only used for xml converters and will normally return null. |
| Gets the field on the target entity for this relationship.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the field on the target entity for this relationship.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRelatedField-org.apache.openejb.jee.jpa.RelationField-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRelatedField</h4> |
| <pre>void setRelatedField(<a href="../../../../../org/apache/openejb/jee/jpa/RelationField.html" title="interface in org.apache.openejb.jee.jpa">RelationField</a> value)</pre> |
| <div class="block">Gets the field on the target entity for this relationship.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - field on the target entity for this relationship.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSyntheticField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSyntheticField</h4> |
| <pre>boolean isSyntheticField()</pre> |
| <div class="block">This is only used for xml converters and will normally return false. |
| A true value indicates that this field was generated for CMR back references.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this field was generated for CMR back references.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSyntheticField-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSyntheticField</h4> |
| <pre>void setSyntheticField(boolean syntheticField)</pre> |
| <div class="block">This is only used for xml converters and will normally return false. |
| A true value indicates that this field was generated for CMR back references.</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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openejb/jee/jpa/QueryHint.html" title="class in org.apache.openejb.jee.jpa"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openejb/jee/jpa/SecondaryTable.html" title="class in org.apache.openejb.jee.jpa"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/jee/jpa/RelationField.html" target="_top">Frames</a></li> |
| <li><a href="RelationField.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |