| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_75) on Wed Mar 11 20:01:52 CET 2015 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>FetchPlanMetadata (JDO API ${pom.currentVersion})</title> |
| <meta name="date" content="2015-03-11"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FetchPlanMetadata (JDO API ${pom.currentVersion})"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/FetchPlanMetadata.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/metadata/FetchGroupMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/jdo/metadata/FieldMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/jdo/metadata/FetchPlanMetadata.html" target="_top">Frames</a></li> |
| <li><a href="FetchPlanMetadata.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.jdo.metadata</div> |
| <h2 title="Interface FetchPlanMetadata" class="title">Interface FetchPlanMetadata</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">FetchPlanMetadata</span> |
| extends <a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></pre> |
| <div class="block">Represents a fetch plan for a class.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/FetchGroupMetadata.html" title="interface in javax.jdo.metadata">FetchGroupMetadata</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#getFetchGroups()">getFetchGroups</a></strong>()</code> |
| <div class="block">Accessor for all fetch groups defined for this fetch plan.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#getFetchSize()">getFetchSize</a></strong>()</code> |
| <div class="block">Accessor for the max fetch depth.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#getMaxFetchDepth()">getMaxFetchDepth</a></strong>()</code> |
| <div class="block">Accessor for the max fetch depth.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#getName()">getName</a></strong>()</code> |
| <div class="block">Accessor for the fetch plan name (set on construction).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#getNumberOfFetchGroups()">getNumberOfFetchGroups</a></strong>()</code> |
| <div class="block">Accessor for the number of fetch groups defined for this fetch plan.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/FetchGroupMetadata.html" title="interface in javax.jdo.metadata">FetchGroupMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#newFetchGroupMetadata(java.lang.String)">newFetchGroupMetadata</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Add a new fetch group for this fetch plan.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html" title="interface in javax.jdo.metadata">FetchPlanMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#setFetchSize(int)">setFetchSize</a></strong>(int size)</code> |
| <div class="block">Method to set the fetch size.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html" title="interface in javax.jdo.metadata">FetchPlanMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html#setMaxFetchDepth(int)">setMaxFetchDepth</a></strong>(int depth)</code> |
| <div class="block">Method to set the max fetch depth for this plan.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_javax.jdo.metadata.Metadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.jdo.metadata.<a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></h3> |
| <code><a href="../../../javax/jdo/metadata/Metadata.html#getExtensions()">getExtensions</a>, <a href="../../../javax/jdo/metadata/Metadata.html#getNumberOfExtensions()">getNumberOfExtensions</a>, <a href="../../../javax/jdo/metadata/Metadata.html#getParent()">getParent</a>, <a href="../../../javax/jdo/metadata/Metadata.html#newExtensionMetadata(java.lang.String,%20java.lang.String,%20java.lang.String)">newExtensionMetadata</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block">Accessor for the fetch plan name (set on construction).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The fetch plan name</dd></dl> |
| </li> |
| </ul> |
| <a name="setMaxFetchDepth(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFetchDepth</h4> |
| <pre><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html" title="interface in javax.jdo.metadata">FetchPlanMetadata</a> setMaxFetchDepth(int depth)</pre> |
| <div class="block">Method to set the max fetch depth for this plan.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>depth</code> - The max fetch depth</dd></dl> |
| </li> |
| </ul> |
| <a name="getMaxFetchDepth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFetchDepth</h4> |
| <pre>int getMaxFetchDepth()</pre> |
| <div class="block">Accessor for the max fetch depth.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The max fetch depth</dd></dl> |
| </li> |
| </ul> |
| <a name="setFetchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchSize</h4> |
| <pre><a href="../../../javax/jdo/metadata/FetchPlanMetadata.html" title="interface in javax.jdo.metadata">FetchPlanMetadata</a> setFetchSize(int size)</pre> |
| <div class="block">Method to set the fetch size.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - The fetch size</dd></dl> |
| </li> |
| </ul> |
| <a name="getFetchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchSize</h4> |
| <pre>int getFetchSize()</pre> |
| <div class="block">Accessor for the max fetch depth.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The max fetch depth</dd></dl> |
| </li> |
| </ul> |
| <a name="getFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre><a href="../../../javax/jdo/metadata/FetchGroupMetadata.html" title="interface in javax.jdo.metadata">FetchGroupMetadata</a>[] getFetchGroups()</pre> |
| <div class="block">Accessor for all fetch groups defined for this fetch plan.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The fetch groups</dd></dl> |
| </li> |
| </ul> |
| <a name="newFetchGroupMetadata(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newFetchGroupMetadata</h4> |
| <pre><a href="../../../javax/jdo/metadata/FetchGroupMetadata.html" title="interface in javax.jdo.metadata">FetchGroupMetadata</a> newFetchGroupMetadata(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Add a new fetch group for this fetch plan.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of fetch group.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The FetchGroupMetadata</dd></dl> |
| </li> |
| </ul> |
| <a name="getNumberOfFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNumberOfFetchGroups</h4> |
| <pre>int getNumberOfFetchGroups()</pre> |
| <div class="block">Accessor for the number of fetch groups defined for this fetch plan.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The number of fetch groups</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/FetchPlanMetadata.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/metadata/FetchGroupMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/jdo/metadata/FieldMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/jdo/metadata/FetchPlanMetadata.html" target="_top">Frames</a></li> |
| <li><a href="FetchPlanMetadata.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2005–2015 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
