blob: 47297da1a2bf03760f166984a5f1e03ade5fbae1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:06 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FetchGroup (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="FetchGroup (OpenJPA Parent POM 3.0.0 API)";
}
}
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,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":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="class-use/FetchGroup.html">Use</a></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/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/FetchGroup.html" target="_top">Frames</a></li>
<li><a href="FetchGroup.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.meta</div>
<h2 title="Class FetchGroup" class="title">Class FetchGroup</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://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>org.apache.openjpa.meta.FetchGroup</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FetchGroup</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Captures fetch group meta-data.
Fetch Group is identified and referred by its immutable name.
Fetch Group can nest other groups. The nested group reference is the name of the nested group.
Defines two <em>standard</em> fetch group named <tt>default</tt> and <tt>all</tt>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.openjpa.meta.FetchGroup">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">&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>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#DEPTH_INFINITE">DEPTH_INFINITE</a></span></code>
<div class="block">Infinite depth.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://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/apache/openjpa/meta/FetchGroup.html#NAME_ALL">NAME_ALL</a></span></code>
<div class="block">Name of the "all" fetch group.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://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/apache/openjpa/meta/FetchGroup.html#NAME_DEFAULT">NAME_DEFAULT</a></span></code>
<div class="block">Name of the default fetch group.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#RECURSION_DEPTH_DEFAULT">RECURSION_DEPTH_DEFAULT</a></span></code>
<div class="block">Default field recursion depth.</div>
</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="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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#addContainedBy-org.apache.openjpa.meta.FetchGroup-">addContainedBy</a></span>(<a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>&nbsp;parent)</code>
<div class="block">Adds this receiver as one of the included fetch groups of the given
parent.</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/apache/openjpa/meta/FetchGroup.html#addDeclaredInclude-java.lang.String-">addDeclaredInclude</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fgName)</code>
<div class="block">Includes given fetch group within this receiver.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;other)</code>
<div class="block">Affirms equality if the other has the same name and declaring type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#getContainedBy--">getContainedBy</a></span>()</code>
<div class="block">Gets the name of the fetch groups in which this receiver has been
included.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://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/apache/openjpa/meta/FetchGroup.html#getDeclaredIncludes--">getDeclaredIncludes</a></span>()</code>
<div class="block">Return the fetch group names declared included by this group.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#getDeclaredRecursionDepth-org.apache.openjpa.meta.FieldMetaData-">getDeclaredRecursionDepth</a></span>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fm)</code>
<div class="block">Return the recursion depth declared for the given field, or
0 if none.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#getDeclaredRecursionDepthFields--">getDeclaredRecursionDepthFields</a></span>()</code>
<div class="block">Return the fields with declared recursion depths in this group.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://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/apache/openjpa/meta/FetchGroup.html#getName--">getName</a></span>()</code>
<div class="block">Fetch group name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#getRecursionDepth-org.apache.openjpa.meta.FieldMetaData-">getRecursionDepth</a></span>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fm)</code>
<div class="block">Recursion depth for the given field.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#includes-java.lang.String-boolean-">includes</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fgName,
boolean&nbsp;recurse)</code>
<div class="block">Affirms if given fetch group is included by this receiver.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#isPostLoad--">isPostLoad</a></span>()</code>
<div class="block">Whether loading this fetch group causes a post-load callback on the
loaded instance.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#isPostLoadExplicit--">isPostLoadExplicit</a></span>()</code>
<div class="block">Whether the post-load value is declared for this group.</div>
</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/openjpa/meta/FetchGroup.html#resolve--">resolve</a></span>()</code>
<div class="block">Resolve and validate fetch group meta-data.</div>
</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/openjpa/meta/FetchGroup.html#setPostLoad-boolean-">setPostLoad</a></span>(boolean&nbsp;flag)</code>
<div class="block">Whether loading this fetch group causes a post-load callback on the
loaded instance.</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/openjpa/meta/FetchGroup.html#setRecursionDepth-org.apache.openjpa.meta.FieldMetaData-int-">setRecursionDepth</a></span>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fm,
int&nbsp;depth)</code>
<div class="block">Recursion depth for the given field.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="http://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/apache/openjpa/meta/FetchGroup.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<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="http://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="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://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="http://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="http://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="http://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="http://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="http://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="http://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="NAME_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NAME_DEFAULT</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NAME_DEFAULT</pre>
<div class="block">Name of the default fetch group.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FetchGroup.NAME_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NAME_ALL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NAME_ALL</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NAME_ALL</pre>
<div class="block">Name of the "all" fetch group.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FetchGroup.NAME_ALL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RECURSION_DEPTH_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECURSION_DEPTH_DEFAULT</h4>
<pre>public static final&nbsp;int RECURSION_DEPTH_DEFAULT</pre>
<div class="block">Default field recursion depth.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FetchGroup.RECURSION_DEPTH_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEPTH_INFINITE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEPTH_INFINITE</h4>
<pre>public static final&nbsp;int DEPTH_INFINITE</pre>
<div class="block">Infinite depth.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FetchGroup.DEPTH_INFINITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Fetch group name.</div>
</li>
</ul>
<a name="addDeclaredInclude-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDeclaredInclude</h4>
<pre>public&nbsp;void&nbsp;addDeclaredInclude(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fgName)</pre>
<div class="block">Includes given fetch group within this receiver.</div>
</li>
</ul>
<a name="includes-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includes</h4>
<pre>public&nbsp;boolean&nbsp;includes(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fgName,
boolean&nbsp;recurse)</pre>
<div class="block">Affirms if given fetch group is included by this receiver. Includes
superclass definition of fetch group and optionally other included
groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recurse</code> - if true then recursively checks within the included
fecth groups</dd>
</dl>
</li>
</ul>
<a name="addContainedBy-org.apache.openjpa.meta.FetchGroup-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContainedBy</h4>
<pre>public&nbsp;boolean&nbsp;addContainedBy(<a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>&nbsp;parent)</pre>
<div class="block">Adds this receiver as one of the included fetch groups of the given
parent.
The parent fetch group will include this receiver as a side-effect of
this call.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if given parent is a new addition. false othrwise.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#includes-java.lang.String-boolean-"><code>includes(String, boolean)</code></a>,
<a href="../../../../org/apache/openjpa/meta/FetchGroup.html#addDeclaredInclude-java.lang.String-"><code>addDeclaredInclude(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getContainedBy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainedBy</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getContainedBy()</pre>
<div class="block">Gets the name of the fetch groups in which this receiver has been
included.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/openjpa/meta/FetchGroup.html#addContainedBy-org.apache.openjpa.meta.FetchGroup-"><code>addContainedBy(FetchGroup)</code></a></dd>
</dl>
</li>
</ul>
<a name="getDeclaredIncludes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredIncludes</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getDeclaredIncludes()</pre>
<div class="block">Return the fetch group names declared included by this group.</div>
</li>
</ul>
<a name="setRecursionDepth-org.apache.openjpa.meta.FieldMetaData-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecursionDepth</h4>
<pre>public&nbsp;void&nbsp;setRecursionDepth(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fm,
int&nbsp;depth)</pre>
<div class="block">Recursion depth for the given field. This is the depth of relations of
the same class as this one we can fetch through the given field.</div>
</li>
</ul>
<a name="getRecursionDepth-org.apache.openjpa.meta.FieldMetaData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecursionDepth</h4>
<pre>public&nbsp;int&nbsp;getRecursionDepth(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fm)</pre>
<div class="block">Recursion depth for the given field. This is the depth of relations of
the same class as this one we can fetch through the given field.</div>
</li>
</ul>
<a name="getDeclaredRecursionDepth-org.apache.openjpa.meta.FieldMetaData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredRecursionDepth</h4>
<pre>public&nbsp;int&nbsp;getDeclaredRecursionDepth(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fm)</pre>
<div class="block">Return the recursion depth declared for the given field, or
0 if none.</div>
</li>
</ul>
<a name="getDeclaredRecursionDepthFields--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredRecursionDepthFields</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]&nbsp;getDeclaredRecursionDepthFields()</pre>
<div class="block">Return the fields with declared recursion depths in this group.</div>
</li>
</ul>
<a name="setPostLoad-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPostLoad</h4>
<pre>public&nbsp;void&nbsp;setPostLoad(boolean&nbsp;flag)</pre>
<div class="block">Whether loading this fetch group causes a post-load callback on the
loaded instance.</div>
</li>
</ul>
<a name="isPostLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPostLoad</h4>
<pre>public&nbsp;boolean&nbsp;isPostLoad()</pre>
<div class="block">Whether loading this fetch group causes a post-load callback on the
loaded instance.</div>
</li>
</ul>
<a name="isPostLoadExplicit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPostLoadExplicit</h4>
<pre>public&nbsp;boolean&nbsp;isPostLoadExplicit()</pre>
<div class="block">Whether the post-load value is declared for this group.</div>
</li>
</ul>
<a name="resolve--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolve</h4>
<pre>public&nbsp;void&nbsp;resolve()</pre>
<div class="block">Resolve and validate fetch group meta-data.</div>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;other)</pre>
<div class="block">Affirms equality if the other has the same name and declaring type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://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></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</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="class-use/FetchGroup.html">Use</a></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/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/FetchGroup.html" target="_top">Frames</a></li>
<li><a href="FetchGroup.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>