| <!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 (1.8.0_201) on Wed Apr 24 20:07:09 CEST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FetchPlan (OpenJPA Parent POM 3.1.0 API)</title> |
| <meta name="date" content="2019-04-24"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FetchPlan (OpenJPA Parent POM 3.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":38,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":38,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":38,"i49":6,"i50":6,"i51":6,"i52":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FetchPlan.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/persistence/FetchGroups.html" title="annotation in org.apache.openjpa.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/persistence/FetchPlan.html" target="_top">Frames</a></li> |
| <li><a href="FetchPlan.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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.persistence</div> |
| <h2 title="Interface FetchPlan" class="title">Interface FetchPlan</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.html" title="interface in org.apache.openjpa.persistence.jdbc">JDBCFetchPlan</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence">FetchPlanImpl</a>, <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 interface <span class="typeNameLabel">FetchPlan</span></pre> |
| <div class="block">The fetch plan allows you to dynamically alter eager fetching |
| configuration and other aspects of data loading.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4.1</dd> |
| <dt><span class="simpleTagLabel">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="memberSummary" 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>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#DEFAULT">DEFAULT</a></span></code> |
| <div class="block">Constant to revert any setting to its default value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#DEPTH_INFINITE">DEPTH_INFINITE</a></span></code> |
| <div class="block">Infinite fetch depth.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#GROUP_ALL">GROUP_ALL</a></span></code> |
| <div class="block">Fetch group representing all fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#GROUP_DEFAULT">GROUP_DEFAULT</a></span></code> |
| <div class="block">The default fetch group.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroup-java.lang.String-">addFetchGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Adds <code>group</code> to the set of fetch group to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups-java.util.Collection-">addFetchGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> 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 id="i2" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups-java.lang.String...-">addFetchGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... 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 id="i3" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField-java.lang.Class-java.lang.String-">addField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Adds <code>field</code> to the set of field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField-java.lang.String-">addField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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 id="i5" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields-java.lang.Class-java.util.Collection-">addFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields-java.lang.Class-java.lang.String...-">addFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields-java.util.Collection-">addFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> 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 id="i8" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields-java.lang.String...-">addFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... 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 id="i9" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFetchGroups--">clearFetchGroups</a></span>()</code> |
| <div class="block">Clears the set of fetch group names to use wen loading |
| data.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFields--">clearFields</a></span>()</code> |
| <div class="block">Clears the set of field names to use wen loading |
| data.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getCacheRetrieveMode--">getCacheRetrieveMode</a></span>()</code> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getCacheStoreMode--">getCacheStoreMode</a></span>()</code> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getDelegate--">getDelegate</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">cast to <a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><code>FetchPlanImpl</code></a> instead. This |
| method pierces the published-API boundary, as does the SPI cast.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getExtendedPathLookup--">getExtendedPathLookup</a></span>()</code> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFetchBatchSize--">getFetchBatchSize</a></span>()</code> |
| <div class="block">Return the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFetchGroups--">getFetchGroups</a></span>()</code> |
| <div class="block">Returns the names of the fetch groups that this component will use |
| when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getFields--">getFields</a></span>()</code> |
| <div class="block">Returns the fully qualified names of the fields that this component |
| will use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getHint-java.lang.String-">getHint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get the hint value for the given key.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getHints--">getHints</a></span>()</code> |
| <div class="block">Get the hints and their values currently set on this receiver.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>javax.persistence.PessimisticLockScope</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockScope--">getLockScope</a></span>()</code> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockTimeout--">getLockTimeout</a></span>()</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getMaxFetchDepth--">getMaxFetchDepth</a></span>()</code> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCache--">getQueryResultCache</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled--"><code>getQueryResultCacheEnabled()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled--">getQueryResultCacheEnabled</a></span>()</code> |
| <div class="block">Return whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryTimeout--">getQueryTimeout</a></span>()</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>javax.persistence.LockModeType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getReadLockMode--">getReadLockMode</a></span>()</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>javax.persistence.LockModeType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getWriteLockMode--">getWriteLockMode</a></span>()</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#hasField-java.lang.Class-java.lang.String-">hasField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return true if the given field has been added.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#hasField-java.lang.String-">hasField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return true if the given field has been added.</div> |
| </td> |
| </tr> |
| <tr id="i30" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroup-java.lang.String-">removeFetchGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Remove the given fetch group.</div> |
| </td> |
| </tr> |
| <tr id="i31" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups-java.util.Collection-">removeFetchGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> 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 id="i32" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups-java.lang.String...-">removeFetchGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... 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 id="i33" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField-java.lang.Class-java.lang.String-">removeField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Remove the given field.</div> |
| </td> |
| </tr> |
| <tr id="i34" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField-java.lang.String-">removeField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </td> |
| </tr> |
| <tr id="i35" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields-java.lang.Class-java.util.Collection-">removeFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i36" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields-java.lang.Class-java.lang.String...-">removeFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i37" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields-java.util.Collection-">removeFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> 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 id="i38" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields-java.lang.String...-">removeFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... 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 id="i39" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#resetFetchGroups--">resetFetchGroups</a></span>()</code> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </td> |
| </tr> |
| <tr id="i40" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setCacheRetrieveMode-org.apache.openjpa.kernel.DataCacheRetrieveMode-">setCacheRetrieveMode</a></span>(<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 id="i41" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setCacheStoreMode-org.apache.openjpa.kernel.DataCacheStoreMode-">setCacheStoreMode</a></span>(<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 id="i42" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setExtendedPathLookup-boolean-">setExtendedPathLookup</a></span>(boolean flag)</code> |
| <div class="block">Sets extended path lookup feature.</div> |
| </td> |
| </tr> |
| <tr id="i43" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setFetchBatchSize-int-">setFetchBatchSize</a></span>(int fetchBatchSize)</code> |
| <div class="block">Set the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setHint-java.lang.String-java.lang.Object-">setHint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Set the hint for the given key to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i45" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockScope-javax.persistence.PessimisticLockScope-">setLockScope</a></span>(javax.persistence.PessimisticLockScope scope)</code> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i46" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockTimeout-int-">setLockTimeout</a></span>(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 id="i47" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setMaxFetchDepth-int-">setMaxFetchDepth</a></span>(int depth)</code> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| </td> |
| </tr> |
| <tr id="i48" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCache-boolean-">setQueryResultCache</a></span>(boolean cache)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled-boolean-"><code>setQueryResultCacheEnabled(boolean)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i49" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled-boolean-">setQueryResultCacheEnabled</a></span>(boolean cache)</code> |
| <div class="block">Control whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i50" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryTimeout-int-">setQueryTimeout</a></span>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i51" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setReadLockMode-javax.persistence.LockModeType-">setReadLockMode</a></span>(javax.persistence.LockModeType mode)</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i52" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setWriteLockMode-javax.persistence.LockModeType-">setWriteLockMode</a></span>(javax.persistence.LockModeType mode)</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="GROUP_ALL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GROUP_ALL</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> GROUP_ALL</pre> |
| <div class="block">Fetch group representing all fields.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.GROUP_ALL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GROUP_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GROUP_DEFAULT</h4> |
| <pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> GROUP_DEFAULT</pre> |
| <div class="block">The default fetch group.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.GROUP_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEPTH_INFINITE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEPTH_INFINITE</h4> |
| <pre>static final int DEPTH_INFINITE</pre> |
| <div class="block">Infinite fetch depth.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.DEPTH_INFINITE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT</h4> |
| <pre>static final int DEFAULT</pre> |
| <div class="block">Constant to revert any setting to its default value.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMaxFetchDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFetchDepth</h4> |
| <pre>int getMaxFetchDepth()</pre> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| </li> |
| </ul> |
| <a name="setMaxFetchDepth-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFetchDepth</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setMaxFetchDepth(int depth)</pre> |
| <div class="block">The maximum fetch depth when loading an object.</div> |
| </li> |
| </ul> |
| <a name="getFetchBatchSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchBatchSize</h4> |
| <pre>int getFetchBatchSize()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="setFetchBatchSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchBatchSize</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setFetchBatchSize(int fetchBatchSize)</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="getQueryResultCacheEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryResultCacheEnabled</h4> |
| <pre>boolean getQueryResultCacheEnabled()</pre> |
| <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><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryResultCacheEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryResultCacheEnabled</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setQueryResultCacheEnabled(boolean cache)</pre> |
| <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><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryResultCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryResultCache</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| boolean getQueryResultCache()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled--"><code>getQueryResultCacheEnabled()</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="setQueryResultCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryResultCache</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setQueryResultCache(boolean cache)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled-boolean-"><code>setQueryResultCacheEnabled(boolean)</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="getFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFetchGroups()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="addFetchGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroup</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFetchGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block">Adds <code>group</code> to the set of fetch group to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFetchGroups-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFetchGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... groups)</pre> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFetchGroups-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFetchGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> groups)</pre> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeFetchGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroup</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFetchGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block">Remove the given fetch group.</div> |
| </li> |
| </ul> |
| <a name="removeFetchGroups-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFetchGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... groups)</pre> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeFetchGroups-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFetchGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> groups)</pre> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="clearFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> clearFetchGroups()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="resetFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> resetFetchGroups()</pre> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </li> |
| </ul> |
| <a name="getFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFields()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="hasField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>boolean hasField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Return true if the given field has been added.</div> |
| </li> |
| </ul> |
| <a name="hasField-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>boolean hasField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Return true if the given field has been added.</div> |
| </li> |
| </ul> |
| <a name="addField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addField-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Adds <code>field</code> to the set of field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFields-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFields-java.lang.Class-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFields-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFields-java.lang.Class-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> addFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block">Adds <code>fields</code> to the set of field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </li> |
| </ul> |
| <a name="removeField-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Remove the given field.</div> |
| </li> |
| </ul> |
| <a name="removeFields-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeFields-java.lang.Class-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... fields)</pre> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeFields-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeFields-java.lang.Class-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> removeFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> fields)</pre> |
| <div class="block">Removes <code>fields</code> from the set of field names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="clearFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> clearFields()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="getLockTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockTimeout</h4> |
| <pre>int getLockTimeout()</pre> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </li> |
| </ul> |
| <a name="setLockTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockTimeout</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setLockTimeout(int timeout)</pre> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </li> |
| </ul> |
| <a name="getLockScope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockScope</h4> |
| <pre>javax.persistence.PessimisticLockScope getLockScope()</pre> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| </li> |
| </ul> |
| <a name="setLockScope-javax.persistence.PessimisticLockScope-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockScope</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setLockScope(javax.persistence.PessimisticLockScope scope)</pre> |
| <div class="block">The lock scope to use for locking loaded objects.</div> |
| </li> |
| </ul> |
| <a name="getQueryTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeout</h4> |
| <pre>int getQueryTimeout()</pre> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </li> |
| </ul> |
| <a name="setQueryTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeout</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setQueryTimeout(int timeout)</pre> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </li> |
| </ul> |
| <a name="getReadLockMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadLockMode</h4> |
| <pre>javax.persistence.LockModeType getReadLockMode()</pre> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </li> |
| </ul> |
| <a name="setReadLockMode-javax.persistence.LockModeType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadLockMode</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setReadLockMode(javax.persistence.LockModeType mode)</pre> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </li> |
| </ul> |
| <a name="getWriteLockMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockMode</h4> |
| <pre>javax.persistence.LockModeType getWriteLockMode()</pre> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </li> |
| </ul> |
| <a name="setWriteLockMode-javax.persistence.LockModeType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockMode</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setWriteLockMode(javax.persistence.LockModeType mode)</pre> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </li> |
| </ul> |
| <a name="getDelegate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelegate</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getDelegate()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">cast to <a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><code>FetchPlanImpl</code></a> instead. This |
| method pierces the published-API boundary, as does the SPI cast.</span></div> |
| </li> |
| </ul> |
| <a name="getExtendedPathLookup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedPathLookup</h4> |
| <pre>boolean getExtendedPathLookup()</pre> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExtendedPathLookup-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtendedPathLookup</h4> |
| <pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a> setExtendedPathLookup(boolean flag)</pre> |
| <div class="block">Sets extended path lookup feature.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheStoreMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStoreMode</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> getCacheStoreMode()</pre> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheStoreMode-org.apache.openjpa.kernel.DataCacheStoreMode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStoreMode</h4> |
| <pre><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">Sets the current storage mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheRetrieveMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheRetrieveMode</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> getCacheRetrieveMode()</pre> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheRetrieveMode-org.apache.openjpa.kernel.DataCacheRetrieveMode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheRetrieveMode</h4> |
| <pre><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">Sets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHint-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre>void setHint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Set the hint for the given key to the given value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value of the hint.</dd> |
| <dd><code>name</code> - the name of the hint.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHints--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHints</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getHints()</pre> |
| <div class="block">Get the hints and their values currently set on this receiver.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>empty map if no hint has been set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHint-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHint</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getHint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Get the hint value for the given key.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null if the key has not been set.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FetchPlan.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/persistence/FetchGroups.html" title="annotation in org.apache.openjpa.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/persistence/FetchPlan.html" target="_top">Frames</a></li> |
| <li><a href="FetchPlan.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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |