| <!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_79) on Mon Mar 21 21:59:46 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FetchPlanImpl (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <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="FetchPlanImpl (OpenJPA Parent POM 2.4.1 API)"; |
| } |
| //--> |
| </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/FetchPlanImpl.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/persistence/Generator.html" title="interface in org.apache.openjpa.persistence"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/persistence/FetchPlanImpl.html" target="_top">Frames</a></li> |
| <li><a href="FetchPlanImpl.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.persistence</div> |
| <h2 title="Class FetchPlanImpl" class="title">Class FetchPlanImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.persistence.FetchPlanImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/persistence/jdbc/JDBCFetchPlanImpl.html" title="class in org.apache.openjpa.persistence.jdbc">JDBCFetchPlanImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">FetchPlanImpl</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></pre> |
| <div class="block">Implements FetchPlan via delegation to FetchConfiguration.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.4.1</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Abe White, Pinaki Poddar</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </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>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/openjpa/persistence/HintValueConverter.html" title="interface in org.apache.openjpa.persistence">HintValueConverter</a>[]></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#_hints">_hints</a></strong></code> |
| <div class="block">Structure holds one or more converters for a user-specified hint value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/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="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#_precedence">_precedence</a></strong></code> |
| <div class="block">Structure holds ranking of equivalent hint keys.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.persistence.FetchPlan"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.persistence.<a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></h3> |
| <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#DEFAULT">DEFAULT</a>, <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#DEPTH_INFINITE">DEPTH_INFINITE</a>, <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#GROUP_ALL">GROUP_ALL</a>, <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#GROUP_DEFAULT">GROUP_DEFAULT</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#FetchPlanImpl(org.apache.openjpa.kernel.FetchConfiguration)">FetchPlanImpl</a></strong>(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code> |
| <div class="block">Constructor; supply delegate.</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="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="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFetchGroup(java.lang.String)">addFetchGroup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Adds <code>group</code> to the set of fetch group to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFetchGroups(java.util.Collection)">addFetchGroups</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> groups)</code> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFetchGroups(java.lang.String...)">addFetchGroups</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... groups)</code> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addField(java.lang.Class,%20java.lang.String)">addField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Adds <code>field</code> to the set of field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addField(java.lang.String)">addField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFields(java.lang.Class,%20java.util.Collection)">addFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFields(java.lang.Class,%20java.lang.String...)">addFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFields(java.util.Collection)">addFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#addFields(java.lang.String...)">addFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#clearFetchGroups()">clearFetchGroups</a></strong>()</code> |
| <div class="block">Clears the set of fetch group names to use wen loading |
| data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#clearFields()">clearFields</a></strong>()</code> |
| <div class="block">Clears the set of field names to use wen loading |
| data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getCacheRetrieveMode()">getCacheRetrieveMode</a></strong>()</code> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getCacheStoreMode()">getCacheStoreMode</a></strong>()</code> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getDelegate()">getDelegate</a></strong>()</code> |
| <div class="block">Delegate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getExtendedPathLookup()">getExtendedPathLookup</a></strong>()</code> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getFetchBatchSize()">getFetchBatchSize</a></strong>()</code> |
| <div class="block">Return the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/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="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getFetchGroups()">getFetchGroups</a></strong>()</code> |
| <div class="block">Returns the names of the fetch groups that this component will use |
| when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/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="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getFields()">getFields</a></strong>()</code> |
| <div class="block">Returns the fully qualified names of the fields that this component |
| will use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getHint(java.lang.String)">getHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get the hint value for the given key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getHints()">getHints</a></strong>()</code> |
| <div class="block">Get the hints and their values currently set on this receiver.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javaee/6/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getLockScope()">getLockScope</a></strong>()</code> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getLockTimeout()">getLockTimeout</a></strong>()</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getMaxFetchDepth()">getMaxFetchDepth</a></strong>()</code> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getQueryResultCache()">getQueryResultCache</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getQueryResultCacheEnabled()">getQueryResultCacheEnabled</a></strong>()</code> |
| <div class="block">Return whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getQueryTimeout()">getQueryTimeout</a></strong>()</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getReadLockMode()">getReadLockMode</a></strong>()</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#getWriteLockMode()">getWriteLockMode</a></strong>()</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#hasField(java.lang.Class,%20java.lang.String)">hasField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return true if the given field has been added.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#hasField(java.lang.String)">hasField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return true if the given field has been added.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#hashCode()">hashCode</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/DelegatingFetchConfiguration.html" title="class in org.apache.openjpa.kernel">DelegatingFetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#newDelegatingFetchConfiguration(org.apache.openjpa.kernel.FetchConfiguration)">newDelegatingFetchConfiguration</a></strong>(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code> |
| <div class="block">Create a new exception-translating delegating fetch configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#registerHint(java.lang.String[],%20org.apache.openjpa.persistence.HintValueConverter...)">registerHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] keys, |
| <a href="../../../../org/apache/openjpa/persistence/HintValueConverter.html" title="interface in org.apache.openjpa.persistence">HintValueConverter</a>... converters)</code> |
| <div class="block">Registers a hint key with its value converters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFetchGroup(java.lang.String)">removeFetchGroup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Remove the given fetch group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> groups)</code> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFetchGroups(java.lang.String...)">removeFetchGroups</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... groups)</code> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeField(java.lang.Class,%20java.lang.String)">removeField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Remove the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeField(java.lang.String)">removeField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFields(java.lang.Class,%20java.util.Collection)">removeFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFields(java.lang.Class,%20java.lang.String...)">removeFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFields(java.util.Collection)">removeFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#removeFields(java.lang.String...)">removeFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#resetFetchGroups()">resetFetchGroups</a></strong>()</code> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></strong>(<a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</code> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></strong>(<a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</code> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></strong>(boolean flag)</code> |
| <div class="block">Sets extended path lookup feature.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setFetchBatchSize(int)">setFetchBatchSize</a></strong>(int fetchBatchSize)</code> |
| <div class="block">Set the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setHint(java.lang.String,%20java.lang.Object)">setHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Sets the hint after converting the value appropriately.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setHints(java.util.Map)">setHints</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> hints)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setLockScope(javax.persistence.PessimisticLockScope)">setLockScope</a></strong>(<a href="http://download.oracle.com/javaee/6/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</a> scope)</code> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setLockTimeout(int)">setLockTimeout</a></strong>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setMaxFetchDepth(int)">setMaxFetchDepth</a></strong>(int depth)</code> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setQueryResultCache(boolean)">setQueryResultCache</a></strong>(boolean cache)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setQueryResultCacheEnabled(boolean)">setQueryResultCacheEnabled</a></strong>(boolean cache)</code> |
| <div class="block">Control whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setQueryTimeout(int)">setQueryTimeout</a></strong>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setReadLockMode(javax.persistence.LockModeType)">setReadLockMode</a></strong>(<a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a> mode)</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html#setWriteLockMode(javax.persistence.LockModeType)">setWriteLockMode</a></strong>(<a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a> mode)</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="_precedence"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_precedence</h4> |
| <pre>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> _precedence</pre> |
| <div class="block">Structure holds ranking of equivalent hint keys. Each entry value is a list of other keys that are higher rank |
| than the entry key.</div> |
| </li> |
| </ul> |
| <a name="_hints"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>_hints</h4> |
| <pre>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/openjpa/persistence/HintValueConverter.html" title="interface in org.apache.openjpa.persistence">HintValueConverter</a>[]> _hints</pre> |
| <div class="block">Structure holds one or more converters for a user-specified hint value.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FetchPlanImpl(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FetchPlanImpl</h4> |
| <pre>public FetchPlanImpl(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Constructor; supply delegate.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="registerHint(java.lang.String[], org.apache.openjpa.persistence.HintValueConverter...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerHint</h4> |
| <pre>protected static void registerHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] keys, |
| <a href="../../../../org/apache/openjpa/persistence/HintValueConverter.html" title="interface in org.apache.openjpa.persistence">HintValueConverter</a>... converters)</pre> |
| <div class="block">Registers a hint key with its value converters.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - a set of keys in increasing order of ranking. Can not be null or empty.</dd><dd><code>converters</code> - array of converters that are attempts in order to convert a user-specified hint value |
| to a value that is consumable by the kernel.</dd></dl> |
| </li> |
| </ul> |
| <a name="newDelegatingFetchConfiguration(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDelegatingFetchConfiguration</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/kernel/DelegatingFetchConfiguration.html" title="class in org.apache.openjpa.kernel">DelegatingFetchConfiguration</a> newDelegatingFetchConfiguration(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Create a new exception-translating delegating fetch configuration.</div> |
| </li> |
| </ul> |
| <a name="getDelegate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelegate</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getDelegate()</pre> |
| <div class="block">Delegate.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getDelegate()">getDelegate</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxFetchDepth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFetchDepth</h4> |
| <pre>public int getMaxFetchDepth()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getMaxFetchDepth()">FetchPlan</a></code></strong></div> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getMaxFetchDepth()">getMaxFetchDepth</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxFetchDepth(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFetchDepth</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setMaxFetchDepth(int depth)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setMaxFetchDepth(int)">FetchPlan</a></code></strong></div> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setMaxFetchDepth(int)">setMaxFetchDepth</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchBatchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchBatchSize</h4> |
| <pre>public int getFetchBatchSize()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFetchBatchSize()">FetchPlan</a></code></strong></div> |
| <div class="block">Return the fetch batch size for large result set support. |
| Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note |
| that this property will be ignored under some data stores.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFetchBatchSize()">getFetchBatchSize</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFetchBatchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchBatchSize</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setFetchBatchSize(int fetchBatchSize)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setFetchBatchSize(int)">FetchPlan</a></code></strong></div> |
| <div class="block">Set the fetch batch size for large result set support. |
| Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note |
| that this property will be ignored under some data stores.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setFetchBatchSize(int)">setFetchBatchSize</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryResultCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryResultCacheEnabled</h4> |
| <pre>public boolean getQueryResultCacheEnabled()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled()">FetchPlan</a></code></strong></div> |
| <div class="block">Return whether or not query caching is enabled. If this returns |
| <code>true</code> but the datacache plugin is not installed, caching |
| will not be enabled. If this |
| returns <code>false</code>, query caching will not be used |
| even if the datacache plugin is installed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled()">getQueryResultCacheEnabled</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryResultCacheEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryResultCacheEnabled</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setQueryResultCacheEnabled(boolean cache)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled(boolean)">FetchPlan</a></code></strong></div> |
| <div class="block">Control whether or not query caching is enabled. This has no effect |
| if the datacache plugin is not installed, or if the query cache size |
| is set to zero.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled(boolean)">setQueryResultCacheEnabled</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryResultCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryResultCache</h4> |
| <pre>public boolean getQueryResultCache()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCache()">getQueryResultCache</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryResultCache(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryResultCache</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setQueryResultCache(boolean cache)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCache(boolean)">setQueryResultCache</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFetchGroups()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFetchGroups()">FetchPlan</a></code></strong></div> |
| <div class="block">Returns the names of the fetch groups that this component will use |
| when loading objects. Defaults to the |
| <code>openjpa.FetchGroups</code> setting.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFetchGroups()">getFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFetchGroup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroup(java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>group</code> to the set of fetch group to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroup(java.lang.String)">addFetchGroup</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFetchGroups(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFetchGroups(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... groups)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups(java.lang.String...)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups(java.lang.String...)">addFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFetchGroups(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFetchGroups(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> groups)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups(java.util.Collection)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups(java.util.Collection)">addFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFetchGroup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroup(java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Remove the given fetch group.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroup(java.lang.String)">removeFetchGroup</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFetchGroups(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFetchGroups(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... groups)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups(java.lang.String...)">FetchPlan</a></code></strong></div> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups(java.lang.String...)">removeFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFetchGroups(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFetchGroups(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> groups)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups(java.util.Collection)">FetchPlan</a></code></strong></div> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> clearFetchGroups()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFetchGroups()">FetchPlan</a></code></strong></div> |
| <div class="block">Clears the set of fetch group names to use wen loading |
| data. After this operation is invoked, only those fields in |
| the default fetch group (and any requested field) will be |
| loaded when loading an object.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFetchGroups()">clearFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> resetFetchGroups()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#resetFetchGroups()">FetchPlan</a></code></strong></div> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#resetFetchGroups()">resetFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFields()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFields()">FetchPlan</a></code></strong></div> |
| <div class="block">Returns the fully qualified names of the fields that this component |
| will use when loading objects. Defaults to the empty set.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFields()">getFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>public boolean hasField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#hasField(java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Return true if the given field has been added.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#hasField(java.lang.String)">hasField</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasField(java.lang.Class, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>public boolean hasField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#hasField(java.lang.Class,%20java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Return true if the given field has been added.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#hasField(java.lang.Class,%20java.lang.String)">hasField</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField(java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField(java.lang.String)">addField</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addField(java.lang.Class, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField(java.lang.Class,%20java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>field</code> to the set of field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField(java.lang.Class,%20java.lang.String)">addField</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFields(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.String...)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.String...)">addFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFields(java.lang.Class, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.Class,%20java.lang.String...)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.Class,%20java.lang.String...)">addFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFields(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.util.Collection)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.util.Collection)">addFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFields(java.lang.Class, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.Class,%20java.util.Collection)">FetchPlan</a></code></strong></div> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.Class,%20java.util.Collection)">addFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField(java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Remove the given fully-qualified field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField(java.lang.String)">removeField</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeField(java.lang.Class, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField(java.lang.Class,%20java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Remove the given field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField(java.lang.Class,%20java.lang.String)">removeField</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFields(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.String...)">FetchPlan</a></code></strong></div> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.String...)">removeFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFields(java.lang.Class, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.Class,%20java.lang.String...)">FetchPlan</a></code></strong></div> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.Class,%20java.lang.String...)">removeFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFields(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.util.Collection)">FetchPlan</a></code></strong></div> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.util.Collection)">removeFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFields(java.lang.Class, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.Class,%20java.util.Collection)">FetchPlan</a></code></strong></div> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.Class,%20java.util.Collection)">removeFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> clearFields()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFields()">FetchPlan</a></code></strong></div> |
| <div class="block">Clears the set of field names to use wen loading |
| data. After this operation is invoked, only those fields in |
| the configured fetch groups will be loaded when loading an object.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFields()">clearFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLockTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockTimeout</h4> |
| <pre>public int getLockTimeout()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockTimeout()">FetchPlan</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockTimeout()">getLockTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockTimeout</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setLockTimeout(int timeout)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockTimeout(int)">FetchPlan</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockTimeout(int)">setLockTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLockScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockScope</h4> |
| <pre>public <a href="http://download.oracle.com/javaee/6/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</a> getLockScope()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockScope()">FetchPlan</a></code></strong></div> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockScope()">getLockScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockScope(javax.persistence.PessimisticLockScope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockScope</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setLockScope(<a href="http://download.oracle.com/javaee/6/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</a> scope)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockScope(javax.persistence.PessimisticLockScope)">FetchPlan</a></code></strong></div> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockScope(javax.persistence.PessimisticLockScope)">setLockScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeout</h4> |
| <pre>public int getQueryTimeout()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryTimeout()">FetchPlan</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryTimeout()">getQueryTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeout</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setQueryTimeout(int timeout)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryTimeout(int)">FetchPlan</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryTimeout(int)">setQueryTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadLockMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadLockMode</h4> |
| <pre>public <a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a> getReadLockMode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getReadLockMode()">FetchPlan</a></code></strong></div> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getReadLockMode()">getReadLockMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadLockMode(javax.persistence.LockModeType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadLockMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setReadLockMode(<a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a> mode)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setReadLockMode(javax.persistence.LockModeType)">FetchPlan</a></code></strong></div> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setReadLockMode(javax.persistence.LockModeType)">setReadLockMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteLockMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockMode</h4> |
| <pre>public <a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a> getWriteLockMode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getWriteLockMode()">FetchPlan</a></code></strong></div> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getWriteLockMode()">getWriteLockMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWriteLockMode(javax.persistence.LockModeType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setWriteLockMode(<a href="http://download.oracle.com/javaee/6/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</a> mode)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setWriteLockMode(javax.persistence.LockModeType)">FetchPlan</a></code></strong></div> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setWriteLockMode(javax.persistence.LockModeType)">setWriteLockMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExtendedPathLookup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedPathLookup</h4> |
| <pre>public boolean getExtendedPathLookup()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getExtendedPathLookup()">FetchPlan</a></code></strong></div> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getExtendedPathLookup()">getExtendedPathLookup</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExtendedPathLookup(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtendedPathLookup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setExtendedPathLookup(boolean flag)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setExtendedPathLookup(boolean)">FetchPlan</a></code></strong></div> |
| <div class="block">Sets extended path lookup feature.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHint(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHint</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getHint(java.lang.String)">FetchPlan</a></code></strong></div> |
| <div class="block">Get the hint value for the given key.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getHint(java.lang.String)">getHint</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>null if the key has not been set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setHint(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre>public void setHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Sets the hint after converting the value appropriately. |
| If a higher ranking equivalent hint is already set, then bypasses this hint.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setHint(java.lang.String,%20java.lang.Object)">setHint</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| <dd><code>value</code> - the value of the hint.</dd></dl> |
| </li> |
| </ul> |
| <a name="setHints(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHints</h4> |
| <pre>public void setHints(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> hints)</pre> |
| </li> |
| </ul> |
| <a name="getHints()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHints</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getHints()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getHints()">FetchPlan</a></code></strong></div> |
| <div class="block">Get the hints and their values currently set on this receiver.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getHints()">getHints</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>empty map if no hint has been set.</dd></dl> |
| </li> |
| </ul> |
| <a name="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheRetrieveMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheRetrieveMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> getCacheRetrieveMode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getCacheRetrieveMode()">FetchPlan</a></code></strong></div> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getCacheRetrieveMode()">getCacheRetrieveMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheStoreMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStoreMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> getCacheStoreMode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getCacheStoreMode()">FetchPlan</a></code></strong></div> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getCacheStoreMode()">getCacheStoreMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStoreMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setCacheStoreMode(<a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">FetchPlan</a></code></strong></div> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setCacheRetrieveMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setCacheRetrieveMode(<a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">FetchPlan</a></code></strong></div> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><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/FetchPlanImpl.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/persistence/Generator.html" title="interface in org.apache.openjpa.persistence"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/persistence/FetchPlanImpl.html" target="_top">Frames</a></li> |
| <li><a href="FetchPlanImpl.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
