Google Git
Sign in
apache / db-jdo-site / refs/heads/publish / . / content / api321 / apidocs / javax / jdo / FetchGroup.html
blob: 19fccd998857b98046908a311497ea9d0a35c231 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FetchGroup (JDO API 3.2.1)</title>
<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 (JDO API 3.2.1)";
}
}
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="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="../../javax/jdo/Extent.html" title="interface in javax.jdo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/jdo/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">javax.jdo</div>
<h2 title="Interface FetchGroup" class="title">Interface FetchGroup</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FetchGroup</span></pre>
<div class="block">FetchGroup represents a named fetch group for a specific class or
interface. A fetch group instance identifies the name of the class or
interface, the list of members (fields or properties) to be fetched when
the fetch group is active, and the recursion depth for each member.
<p>
Fetch groups are updated using methods on this interface. An instance of
a class implementing this interface can be obtained from
<a href="../../javax/jdo/PersistenceManager.html#getFetchGroup-java.lang.Class-java.lang.String-"><code>PersistenceManager.getFetchGroup(java.lang.Class, java.lang.String)</code></a> or
<a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroup-java.lang.Class-java.lang.String-"><code>PersistenceManagerFactory.getFetchGroup(java.lang.Class, java.lang.String)</code></a>.
<p>
A FetchGroup can be unscoped or can be in one of two scopes (the
<a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo"><code>PersistenceManager</code></a> or the <a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><code>PersistenceManagerFactory</code></a> scope).
Unscoped FetchGroups do not affect any behavior.
A FetchGroup in PersistenceManager scope hides the corresponding
FetchGroup in the PersistenceManagerFactory scope.
<ul><li>When a FetchGroup is obtained via
<a href="../../javax/jdo/PersistenceManager.html#getFetchGroup-java.lang.Class-java.lang.String-"><code>PersistenceManager.getFetchGroup(java.lang.Class, java.lang.String)</code></a>,
it is immediately in scope of its <code>PersistenceManager</code>.
Subsequent modifications of the FetchGroup
immediately affect <code>FetchPlan</code>s that contain the
<code>FetchGroup</code>.
</li><li>When a FetchGroup is obtained via
<a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroup-java.lang.Class-java.lang.String-"><code>PersistenceManagerFactory.getFetchGroup(java.lang.Class, java.lang.String)</code></a>, it is unscoped.
</li><li>When a FetchGroup is added to the set of active FetchGroups via
<a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>PersistenceManagerFactory.addFetchGroups(javax.jdo.FetchGroup...)</code></a>, it is put in scope of the
<code>PersistenceManagerFactory</code>.
</li><li>When a FetchGroup is removed from the set of active FetchGroups via
<a href="../../javax/jdo/PersistenceManagerFactory.html#removeFetchGroups-javax.jdo.FetchGroup...-"><code>PersistenceManagerFactory.removeFetchGroups(javax.jdo.FetchGroup...)</code></a>,
<a href="../../javax/jdo/PersistenceManagerFactory.html#removeAllFetchGroups--"><code>PersistenceManagerFactory.removeAllFetchGroups()</code></a>, or replaced via
<a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>PersistenceManagerFactory.addFetchGroups(javax.jdo.FetchGroup...)</code></a>, it is unscoped.
</li></ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.2</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 <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="../../javax/jdo/FetchGroup.html#ALL">ALL</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.</div>
</td>
</tr>
<tr class="rowColor">
<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="../../javax/jdo/FetchGroup.html#BASIC">BASIC</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.</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="../../javax/jdo/FetchGroup.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.</div>
</td>
</tr>
<tr class="rowColor">
<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="../../javax/jdo/FetchGroup.html#MULTIVALUED">MULTIVALUED</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.</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="../../javax/jdo/FetchGroup.html#RELATIONSHIP">RELATIONSHIP</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-">addCategory</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;categoryName)</code>
<div class="block">Add the members (fields or properties) of the named category
to the set of members in this FetchGroup.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#addMember-java.lang.String-">addMember</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;memberName)</code>
<div class="block">Add the member (field or property) to the set of members in this
FetchGroup.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#addMembers-java.lang.String...-">addMembers</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;memberNames)</code>
<div class="block">Add the member (field or property) to the set of members in this
FetchGroup.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#equals-java.lang.Object-">equals</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;other)</code>
<div class="block">Return whether this instance is equal to the other.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#getMembers--">getMembers</a></span>()</code>
<div class="block">Return an immutable Set of String containing the names of all members.</div>
</td>
</tr>
<tr id="i5" 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="../../javax/jdo/FetchGroup.html#getName--">getName</a></span>()</code>
<div class="block">Get the name of this FetchGroup.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#getPostLoad--">getPostLoad</a></span>()</code>
<div class="block">Get the post-load property of this FetchGroup.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#getRecursionDepth-java.lang.String-">getRecursionDepth</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;memberName)</code>
<div class="block">Get the recursion-depth for this member.</div>
</td>
</tr>
<tr id="i8" 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="../../javax/jdo/FetchGroup.html#getType--">getType</a></span>()</code>
<div class="block">Get the persistent type (class or interface) of this FetchGroup.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Return the hashCode for this instance.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#isUnmodifiable--">isUnmodifiable</a></span>()</code>
<div class="block">Return whether this FetchGroup is unmodifiable.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-">removeCategory</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;categoryName)</code>
<div class="block">Remove the members (fields or properties) of the named category
from the set of members in this FetchGroup.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#removeMember-java.lang.String-">removeMember</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;memberName)</code>
<div class="block">Remove the member (field or property) from the set of members in this FetchGroup.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#removeMembers-java.lang.String...-">removeMembers</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;memberNames)</code>
<div class="block">Remove the member (field or property) from the set of members in this
FetchGroup.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#setPostLoad-boolean-">setPostLoad</a></span>(boolean&nbsp;postLoad)</code>
<div class="block">Set the post-load property of this FetchGroup.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#setRecursionDepth-java.lang.String-int-">setRecursionDepth</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;memberName,
int&nbsp;recursionDepth)</code>
<div class="block">Set the recursion-depth for this member.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchGroup.html#setUnmodifiable--">setUnmodifiable</a></span>()</code>
<div class="block">Make this FetchGroup unmodifiable.</div>
</td>
</tr>
</table>
</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="DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>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> DEFAULT</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.
This category includes members defined in the default fetch group
in xml or annotations. Redefining the default fetch group via the API
does not affect the members defined by this category.
<p>
Using this category also sets the fetch-depth for the members in the
default fetch group.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchGroup.DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RELATIONSHIP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RELATIONSHIP</h4>
<pre>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> RELATIONSHIP</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.
This category includes members of all relationship types.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchGroup.RELATIONSHIP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MULTIVALUED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MULTIVALUED</h4>
<pre>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> MULTIVALUED</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.
This category includes members of all multi-valued types, including
Collection, array, and Map types of basic and relationship types.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchGroup.MULTIVALUED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BASIC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BASIC</h4>
<pre>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> BASIC</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.
This category includes members of all primitive and immutable
object class types as defined in section 6.4 of the specification,
including String, Locale, Currency, BigDecimal, and BigInteger;
as well as Date and its jdbc subtypes and Enum types.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchGroup.BASIC">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ALL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ALL</h4>
<pre>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> ALL</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a> and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a> calls.
This category includes all members in the persistent type.
<p>
Using this category also sets the fetch-depth for the members in the
default fetch group.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchGroup.ALL">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="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int&nbsp;hashCode()</pre>
<div class="block">Return the hashCode for this instance. The hash code should combine both
the class and fetch group name. The hash codes for two equal instances
must be identical.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hash code</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>boolean&nbsp;equals(<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;other)</pre>
<div class="block">Return whether this instance is equal to the other. The equals method
must compare the class for identity and the fetch group name for
equality.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><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></code>&nbsp;in class&nbsp;<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></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this instance is equal to the other</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><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;getName()</pre>
<div class="block">Get the name of this FetchGroup. The name is set only in the
factory method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><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;getType()</pre>
<div class="block">Get the persistent type (class or interface) of this FetchGroup.
The persistent type is set only in the factory method(s).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the persistent type</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getPostLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPostLoad</h4>
<pre>boolean&nbsp;getPostLoad()</pre>
<div class="block">Get the post-load property of this FetchGroup.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the post-load property</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="setPostLoad-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPostLoad</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;setPostLoad(boolean&nbsp;postLoad)</pre>
<div class="block">Set the post-load property of this FetchGroup.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>postLoad</code> - Whether to post load this fetch group</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="addMember-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMember</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;addMember(<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;memberName)</pre>
<div class="block">Add the member (field or property) to the set of members in this
FetchGroup.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberName</code> - the name of a member to add to the FetchGroup</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the parameter is not a member of the
persistent type</dd>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="addMembers-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMembers</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;addMembers(<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;memberNames)</pre>
<div class="block">Add the member (field or property) to the set of members in this
FetchGroup. Duplicates are ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberNames</code> - the names of members to add to the FetchGroup</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if any parameter is not a member of the
persistent type</dd>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="removeMember-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMember</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;removeMember(<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;memberName)</pre>
<div class="block">Remove the member (field or property) from the set of members in this FetchGroup.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberName</code> - Name of the member of the class to remove from the FetchGroup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the parameter is not a member of the persistent type</dd>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="removeMembers-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMembers</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;removeMembers(<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;memberNames)</pre>
<div class="block">Remove the member (field or property) from the set of members in this
FetchGroup. Duplicates in the parameter list are eliminated before
removing them from the membership.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberNames</code> - Member names of the class to remove from this FetchGroup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if any parameter is not a member of the persistent type</dd>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="addCategory-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCategory</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;addCategory(<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;categoryName)</pre>
<div class="block">Add the members (fields or properties) of the named category
to the set of members in this FetchGroup. This method first
resolves the category name to a set of members and then adds
the members as if <a href="../../javax/jdo/FetchGroup.html#addMembers-java.lang.String...-"><code>addMembers(java.lang.String...)</code></a> was called. After this
method executes, the category is not remembered.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>categoryName</code> - Category to add to this FetchGroup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="removeCategory-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeCategory</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;removeCategory(<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;categoryName)</pre>
<div class="block">Remove the members (fields or properties) of the named category
from the set of members in this FetchGroup. This method first
resolves the category name to a set of members and then removes
the members as if <a href="../../javax/jdo/FetchGroup.html#removeMembers-java.lang.String...-"><code>removeMembers(java.lang.String...)</code></a> was called. After this
method executes, the category is not remembered.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>categoryName</code> - Category to remove from this FetchGroup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="setRecursionDepth-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecursionDepth</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;setRecursionDepth(<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;memberName,
int&nbsp;recursionDepth)</pre>
<div class="block">Set the recursion-depth for this member. The default is 1. A value of 0
means don't fetch the member (as if the member were omitted entirely).
A value of -1 means fetch all instances reachable via this member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberName</code> - the name of the field or property</dd>
<dd><code>recursionDepth</code> - the value for the recursion-depth property</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the member does not exist</dd>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getRecursionDepth-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecursionDepth</h4>
<pre>int&nbsp;getRecursionDepth(<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;memberName)</pre>
<div class="block">Get the recursion-depth for this member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberName</code> - the name of the field or property</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the recursion-depth for this member</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the member is not in the FetchGroup</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getMembers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMembers</h4>
<pre><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>&nbsp;getMembers()</pre>
<div class="block">Return an immutable Set of String containing the names of all members.
The Set is a copy of the currently defined members and will not change
based on subsequent changes to the membership in the FetchGroup.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable Set containing the names of all members
in the FetchGroup</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="setUnmodifiable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnmodifiable</h4>
<pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>&nbsp;setUnmodifiable()</pre>
<div class="block">Make this FetchGroup unmodifiable. If already unmodifiable, this method
has no effect.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchGroup</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="isUnmodifiable--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isUnmodifiable</h4>
<pre>boolean&nbsp;isUnmodifiable()</pre>
<div class="block">Return whether this FetchGroup is unmodifiable. If so, methods
<a href="../../javax/jdo/FetchGroup.html#setPostLoad-boolean-"><code>setPostLoad(boolean)</code></a>, <a href="../../javax/jdo/FetchGroup.html#addMember-java.lang.String-"><code>addMember(java.lang.String)</code></a>, <a href="../../javax/jdo/FetchGroup.html#removeMember-java.lang.String-"><code>removeMember(java.lang.String)</code></a>,
<a href="../../javax/jdo/FetchGroup.html#addMembers-java.lang.String...-"><code>addMembers(java.lang.String...)</code></a>, <a href="../../javax/jdo/FetchGroup.html#removeMembers-java.lang.String...-"><code>removeMembers(java.lang.String...)</code></a>,
<a href="../../javax/jdo/FetchGroup.html#addCategory-java.lang.String-"><code>addCategory(java.lang.String)</code></a>, and <a href="../../javax/jdo/FetchGroup.html#removeCategory-java.lang.String-"><code>removeCategory(java.lang.String)</code></a>
will throw <a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo"><code>JDOUserException</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the FetchGroup is unmodifiable</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</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="../../javax/jdo/Extent.html" title="interface in javax.jdo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/jdo/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; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>