Google Git
Sign in
apache / db-jdo-site / 1997987cf851540e6ade8c7dd2a9450c44e16054 / . / src / main / resources / javadoc / api321 / apidocs / javax / jdo / FetchPlan.html
blob: 6c378e344bbd568106fb1285d074292efa9160cb [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>FetchPlan (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="FetchPlan (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/FetchPlan.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/FetchGroup.html" title="interface in javax.jdo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/jdo/InstanceCallbacks.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/FetchPlan.html" target="_top">Frames</a></li>
<li><a href="FetchPlan.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 FetchPlan" class="title">Interface FetchPlan</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FetchPlan</span></pre>
<div class="block">Fetch groups are activated using methods on this interface. An
instance of this interface can be obtained from <a href="../../javax/jdo/PersistenceManager.html#getFetchPlan--"><code>PersistenceManager.getFetchPlan()</code></a>, <a href="../../javax/jdo/Extent.html#getFetchPlan--"><code>Extent.getFetchPlan()</code></a>, and
<a href="../../javax/jdo/Query.html#getFetchPlan--"><code>Query.getFetchPlan()</code></a>. When a <code>Query</code> or
<code>Extent</code> is retrieved from a
<code>PersistenceManager</code>, its <code>FetchPlan</code> is
initialized to the same settings as that of the
<code>PersistenceManager</code>. Subsequent modifications of the
<code>Query</code> or <code>Extent</code>'s <code>FetchPlan</code>
are not reflected in the <code>FetchPlan</code> of the
<code>PersistenceManager</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.0</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/FetchPlan.html#ALL">ALL</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchPlan.html#addGroup-java.lang.String-"><code>addGroup(java.lang.String)</code></a>, <a href="../../javax/jdo/FetchPlan.html#removeGroup-java.lang.String-"><code>removeGroup(java.lang.String)</code></a>, and the
various <a href="../../javax/jdo/FetchPlan.html#setGroups-java.util.Collection-"><code>setGroups(java.util.Collection)</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/FetchPlan.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchPlan.html#addGroup-java.lang.String-"><code>addGroup(java.lang.String)</code></a>, <a href="../../javax/jdo/FetchPlan.html#removeGroup-java.lang.String-"><code>removeGroup(java.lang.String)</code></a>, and the
various <a href="../../javax/jdo/FetchPlan.html#setGroups-java.util.Collection-"><code>setGroups(java.util.Collection)</code></a> calls.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#DETACH_LOAD_FIELDS">DETACH_LOAD_FIELDS</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/PersistenceManager.html#detachCopy-T-"><code>PersistenceManager.detachCopy(T)</code></a> and
<a href="../../javax/jdo/FetchPlan.html#setDetachmentOptions-int-"><code>setDetachmentOptions(int)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#DETACH_UNLOAD_FIELDS">DETACH_UNLOAD_FIELDS</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/PersistenceManager.html#detachCopy-T-"><code>PersistenceManager.detachCopy(T)</code></a> and
<a href="../../javax/jdo/FetchPlan.html#setDetachmentOptions-int-"><code>setDetachmentOptions(int)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_GREEDY">FETCH_SIZE_GREEDY</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchPlan.html#setFetchSize-int-"><code>setFetchSize(int)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_OPTIMAL">FETCH_SIZE_OPTIMAL</a></span></code>
<div class="block">For use with <a href="../../javax/jdo/FetchPlan.html#setFetchSize-int-"><code>setFetchSize(int)</code></a>.</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/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#addGroup-java.lang.String-">addGroup</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;fetchGroupName)</code>
<div class="block">Add the fetch group to the set of active fetch groups.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#clearGroups--">clearGroups</a></span>()</code>
<div class="block">Remove all active groups leaving no active fetch group.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#getDetachmentOptions--">getDetachmentOptions</a></span>()</code>
<div class="block">Get options used during detachment.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#getDetachmentRootClasses--">getDetachmentRootClasses</a></span>()</code>
<div class="block">Get the root classes for DetachAllOnCommit.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#getDetachmentRoots--">getDetachmentRoots</a></span>()</code>
<div class="block">Get the roots for DetachAllOnCommit.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#getFetchSize--">getFetchSize</a></span>()</code>
<div class="block">Return the fetch size, or <a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_OPTIMAL"><code>FETCH_SIZE_OPTIMAL</code></a> if not set,
or <a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_GREEDY"><code>FETCH_SIZE_GREEDY</code></a> to fetch all.</div>
</td>
</tr>
<tr id="i6" 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/FetchPlan.html#getGroups--">getGroups</a></span>()</code>
<div class="block">Return an immutable Set containing the names
of all active fetch groups.</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/FetchPlan.html#getMaxFetchDepth--">getMaxFetchDepth</a></span>()</code>
<div class="block">Return the maximum fetch depth used when fetching instances.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#removeGroup-java.lang.String-">removeGroup</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;fetchGroupName)</code>
<div class="block">Remove the fetch group from the set active fetch groups.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setDetachmentOptions-int-">setDetachmentOptions</a></span>(int&nbsp;options)</code>
<div class="block">Set options to be used during detachment.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setDetachmentRootClasses-java.lang.Class...-">setDetachmentRootClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>...&nbsp;rootClasses)</code>
<div class="block">Set the root classes for DetachAllOnCommit.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setDetachmentRoots-java.util.Collection-">setDetachmentRoots</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;roots)</code>
<div class="block">Set the roots for DetachAllOnCommit.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setFetchSize-int-">setFetchSize</a></span>(int&nbsp;fetchSize)</code>
<div class="block">Set the fetch size for large result set support.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setGroup-java.lang.String-">setGroup</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;fetchGroupName)</code>
<div class="block">Set the active fetch groups to the single named fetch group.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setGroups-java.util.Collection-">setGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;fetchGroupNames)</code>
<div class="block">Set a collection of groups.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setGroups-java.lang.String...-">setGroups</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;fetchGroupNames)</code>
<div class="block">Set a collection of groups.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/FetchPlan.html#setMaxFetchDepth-int-">setMaxFetchDepth</a></span>(int&nbsp;fetchDepth)</code>
<div class="block">Set the maximum fetch depth when fetching.</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/FetchPlan.html#addGroup-java.lang.String-"><code>addGroup(java.lang.String)</code></a>, <a href="../../javax/jdo/FetchPlan.html#removeGroup-java.lang.String-"><code>removeGroup(java.lang.String)</code></a>, and the
various <a href="../../javax/jdo/FetchPlan.html#setGroups-java.util.Collection-"><code>setGroups(java.util.Collection)</code></a> calls. Value: <code>default</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchPlan.DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ALL">
<!-- -->
</a>
<ul class="blockList">
<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/FetchPlan.html#addGroup-java.lang.String-"><code>addGroup(java.lang.String)</code></a>, <a href="../../javax/jdo/FetchPlan.html#removeGroup-java.lang.String-"><code>removeGroup(java.lang.String)</code></a>, and the
various <a href="../../javax/jdo/FetchPlan.html#setGroups-java.util.Collection-"><code>setGroups(java.util.Collection)</code></a> calls. Value: <code>all</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchPlan.ALL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DETACH_UNLOAD_FIELDS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DETACH_UNLOAD_FIELDS</h4>
<pre>static final&nbsp;int DETACH_UNLOAD_FIELDS</pre>
<div class="block">For use with <a href="../../javax/jdo/PersistenceManager.html#detachCopy-T-"><code>PersistenceManager.detachCopy(T)</code></a> and
<a href="../../javax/jdo/FetchPlan.html#setDetachmentOptions-int-"><code>setDetachmentOptions(int)</code></a>. Specifies that
fields that are loaded but not in the current fetch plan should
be unloaded prior to detachment.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchPlan.DETACH_UNLOAD_FIELDS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DETACH_LOAD_FIELDS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DETACH_LOAD_FIELDS</h4>
<pre>static final&nbsp;int DETACH_LOAD_FIELDS</pre>
<div class="block">For use with <a href="../../javax/jdo/PersistenceManager.html#detachCopy-T-"><code>PersistenceManager.detachCopy(T)</code></a> and
<a href="../../javax/jdo/FetchPlan.html#setDetachmentOptions-int-"><code>setDetachmentOptions(int)</code></a>. Specifies that
fields that are not loaded but are in the current fetch plan should
be loaded prior to detachment.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchPlan.DETACH_LOAD_FIELDS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FETCH_SIZE_GREEDY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FETCH_SIZE_GREEDY</h4>
<pre>static final&nbsp;int FETCH_SIZE_GREEDY</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchPlan.html#setFetchSize-int-"><code>setFetchSize(int)</code></a>. Value: -1.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchPlan.FETCH_SIZE_GREEDY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FETCH_SIZE_OPTIMAL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FETCH_SIZE_OPTIMAL</h4>
<pre>static final&nbsp;int FETCH_SIZE_OPTIMAL</pre>
<div class="block">For use with <a href="../../javax/jdo/FetchPlan.html#setFetchSize-int-"><code>setFetchSize(int)</code></a>. Value: 0.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.FetchPlan.FETCH_SIZE_OPTIMAL">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="addGroup-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGroup</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;addGroup(<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;fetchGroupName)</pre>
<div class="block">Add the fetch group to the set of active fetch groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchGroupName</code> - Name of the FetchGroup to add</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="removeGroup-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeGroup</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;removeGroup(<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;fetchGroupName)</pre>
<div class="block">Remove the fetch group from the set active fetch groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchGroupName</code> - Name of the FetchGroup to remove</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="clearGroups--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearGroups</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;clearGroups()</pre>
<div class="block">Remove all active groups leaving no active fetch group.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getGroups--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</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;getGroups()</pre>
<div class="block">Return an immutable Set containing the names
of all active fetch groups. The Set is a copy of
the currently active groups and will not change
based on subsequent changes to the groups.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable Set containing the names
of all currently active fetch groups</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setGroups-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGroups</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;fetchGroupNames)</pre>
<div class="block">Set a collection of groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchGroupNames</code> - a collection of names of fetch groups</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setGroups-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGroups</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setGroups(<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;fetchGroupNames)</pre>
<div class="block">Set a collection of groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchGroupNames</code> - a String array of names of fetch groups</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setGroup-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGroup</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setGroup(<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;fetchGroupName)</pre>
<div class="block">Set the active fetch groups to the single named fetch group.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchGroupName</code> - the single fetch group</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setMaxFetchDepth-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxFetchDepth</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setMaxFetchDepth(int&nbsp;fetchDepth)</pre>
<div class="block">Set the maximum fetch depth when fetching.
A value of 0 has no meaning and will throw a JDOUserException.
A value of -1 means that no limit is placed on fetching.
A positive integer will result in that number of references from the
initial object to be fetched.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchDepth</code> - the depth</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getMaxFetchDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxFetchDepth</h4>
<pre>int&nbsp;getMaxFetchDepth()</pre>
<div class="block">Return the maximum fetch depth used when fetching instances.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum fetch depth</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setDetachmentRoots-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDetachmentRoots</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setDetachmentRoots(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;roots)</pre>
<div class="block">Set the roots for DetachAllOnCommit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roots</code> - Collection of the detachment roots.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getDetachmentRoots--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDetachmentRoots</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getDetachmentRoots()</pre>
<div class="block">Get the roots for DetachAllOnCommit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Collection of detachment roots.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setDetachmentRootClasses-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDetachmentRootClasses</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setDetachmentRootClasses(<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;rootClasses)</pre>
<div class="block">Set the root classes for DetachAllOnCommit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rootClasses</code> - The root classes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getDetachmentRootClasses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDetachmentRootClasses</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;getDetachmentRootClasses()</pre>
<div class="block">Get the root classes for DetachAllOnCommit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The detachment root classes</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setFetchSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchSize</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setFetchSize(int&nbsp;fetchSize)</pre>
<div class="block">Set the fetch size for large result set support. Use
<a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_OPTIMAL"><code>FETCH_SIZE_OPTIMAL</code></a> to unset, and <a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_GREEDY"><code>FETCH_SIZE_GREEDY</code></a>
to force loading of everything.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fetchSize</code> - the fetch size</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the FetchPlan</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getFetchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchSize</h4>
<pre>int&nbsp;getFetchSize()</pre>
<div class="block">Return the fetch size, or <a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_OPTIMAL"><code>FETCH_SIZE_OPTIMAL</code></a> if not set,
or <a href="../../javax/jdo/FetchPlan.html#FETCH_SIZE_GREEDY"><code>FETCH_SIZE_GREEDY</code></a> to fetch all.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the fetch size</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setDetachmentOptions-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDetachmentOptions</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;setDetachmentOptions(int&nbsp;options)</pre>
<div class="block">Set options to be used during detachment. Options are <a href="../../javax/jdo/FetchPlan.html#DETACH_LOAD_FIELDS"><code>DETACH_LOAD_FIELDS</code></a> and <a href="../../javax/jdo/FetchPlan.html#DETACH_UNLOAD_FIELDS"><code>DETACH_UNLOAD_FIELDS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - Options for use during detachment.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This FetchPlan</dd>
</dl>
</li>
</ul>
<a name="getDetachmentOptions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDetachmentOptions</h4>
<pre>int&nbsp;getDetachmentOptions()</pre>
<div class="block">Get options used during detachment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Options to use during detachment.</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/FetchPlan.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/FetchGroup.html" title="interface in javax.jdo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/jdo/InstanceCallbacks.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/FetchPlan.html" target="_top">Frames</a></li>
<li><a href="FetchPlan.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>