| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>DelegatingFetchConfiguration (OpenJPA Parent POM 4.1.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DelegatingFetchConfiguration (OpenJPA Parent POM 4.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DelegatingFetchConfiguration.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.openjpa.kernel</a></div> |
| <h2 title="Class DelegatingFetchConfiguration" class="title">Class DelegatingFetchConfiguration</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.kernel.DelegatingFetchConfiguration</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code>, <code><a href="LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a></code>, <code><a href="LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</a></code>, <code><a href="QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../jdbc/kernel/DelegatingJDBCFetchConfiguration.html" title="class in org.apache.openjpa.jdbc.kernel">DelegatingJDBCFetchConfiguration</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DelegatingFetchConfiguration</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></pre> |
| <div class="block">Delegating fetch configuration that can also perform exception |
| translation for use in facades.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.openjpa.kernel.DelegatingFetchConfiguration">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.FetchConfiguration"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></h3> |
| <code><a href="FetchConfiguration.html#DEFAULT">DEFAULT</a>, <a href="FetchConfiguration.html#FETCH_LOAD">FETCH_LOAD</a>, <a href="FetchConfiguration.html#FETCH_NONE">FETCH_NONE</a>, <a href="FetchConfiguration.html#FETCH_REF">FETCH_REF</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.LockLevels"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a></h3> |
| <code><a href="LockLevels.html#LOCK_NONE">LOCK_NONE</a>, <a href="LockLevels.html#LOCK_READ">LOCK_READ</a>, <a href="LockLevels.html#LOCK_WRITE">LOCK_WRITE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.LockScopes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</a></h3> |
| <code><a href="LockScopes.html#LOCKSCOPE_EXTENDED">LOCKSCOPE_EXTENDED</a>, <a href="LockScopes.html#LOCKSCOPE_NORMAL">LOCKSCOPE_NORMAL</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.QueryFlushModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></h3> |
| <code><a href="QueryFlushModes.html#FLUSH_FALSE">FLUSH_FALSE</a>, <a href="QueryFlushModes.html#FLUSH_TRUE">FLUSH_TRUE</a>, <a href="QueryFlushModes.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.openjpa.kernel.FetchConfiguration)">DelegatingFetchConfiguration</a></span>​(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor; supply delegate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.openjpa.kernel.FetchConfiguration,org.apache.openjpa.util.RuntimeExceptionTranslator)">DelegatingFetchConfiguration</a></span>​(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| <a href="../util/RuntimeExceptionTranslator.html" title="interface in org.apache.openjpa.util">RuntimeExceptionTranslator</a> trans)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor; supply delegate and exception translator.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFetchGroup(java.lang.String)">addFetchGroup</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> group)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds <code>group</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFetchGroups(java.util.Collection)">addFetchGroups</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> groups)</code></th> |
| <td class="colLast"> |
| <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="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addField(java.lang.String)">addField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</code></th> |
| <td class="colLast"> |
| <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="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFields(java.util.Collection)">addFields</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> fields)</code></th> |
| <td class="colLast"> |
| <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="i4" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearFetchGroups()">clearFetchGroups</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clears the set of fetch group names to use when loading |
| data.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearFields()">clearFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clears the set of field names to use when loading |
| data.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clone this instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.openjpa.kernel.FetchConfiguration)">copy</a></span>​(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code></th> |
| <td class="colLast"> |
| <div class="block">Copy the state from the given fetch configuration to this one.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> other)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheRetrieveMode()">getCacheRetrieveMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheStoreMode()">getCacheStoreMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the context associated with this configuration; |
| may be null if it has not been set or this object has been serialized.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDelegate()">getDelegate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the direct delegate.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtendedPathLookup()">getExtendedPathLookup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchBatchSize()">getFetchBatchSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchGroups()">getFetchGroups</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns immutable set of names of the fetch groups that this component |
| will use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFields()">getFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the set of fully-qualified field names that this component |
| will use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushBeforeQueries()">getFlushBeforeQueries</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The query automatic flush configuration.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHint(java.lang.String)">getHint</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHints()">getHints</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get an immutable view of the currently active hints and their values.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInnermostDelegate()">getInnermostDelegate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the native delegate.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockScope()">getLockScope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The lock scope for next fetch.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockTimeout()">getLockTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxFetchDepth()">getMaxFetchDepth</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the maximum depth of fetched instance graph.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryCacheEnabled()">getQueryCacheEnabled</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryTimeout()">getQueryTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <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>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadLockLevel()">getReadLockLevel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRootClasses()">getRootClasses</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Root classes for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRootInstances()">getRootInstances</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Root instances for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWriteLockLevel()">getWriteLockLevel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasFetchGroup(java.lang.String)">hasFetchGroup</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> group)</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if the given fetch group has been added.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasField(java.lang.String)">hasField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if the given fully-qualified field has been added.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDefaultPUFetchGroupConfigurationOnly()">isDefaultPUFetchGroupConfigurationOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFetchConfigurationSQLCacheAdmissible()">isFetchConfigurationSQLCacheAdmissible</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether SQL generated by the FetchConfiguration's current configuration should be cached.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isHintSet(java.lang.String)">isHintSet</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Affirm if the given hint has been set in this receiver.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lock()">lock</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Synchronize on internal lock if multithreaded is true.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="../lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">newResultList</a></span>​(<a href="../lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> rop)</code></th> |
| <td class="colLast"> |
| <div class="block">Return a new result list for the current fetch configuration.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFetchGroup(java.lang.String)">removeFetchGroup</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> group)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the given fetch group.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> groups)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeField(java.lang.String)">removeField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFields(java.util.Collection)">removeFields</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> fields)</code></th> |
| <td class="colLast"> |
| <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="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">requiresFetch</a></span>​(<a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fmd)</code></th> |
| <td class="colLast"> |
| <div class="block">Affirms if the given field requires to be fetched in the context |
| of current fetch operation.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresLoad()">requiresLoad</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return false if we know that the object being fetched with this |
| configuration does not require a load, because this configuration came |
| from a traversal of a <a href="FetchConfiguration.html#FETCH_REF"><code>FetchConfiguration.FETCH_REF</code></a> field.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetFetchGroups()">resetFetchGroups</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></span>​(<a href="DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></span>​(<a href="DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></span>​(<a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</code></th> |
| <td class="colLast"> |
| <div class="block">Called automatically by the system to associate the fetch configuration |
| with a context before use.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></span>​(boolean flag)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets extended path lookup feature.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchBatchSize(int)">setFetchBatchSize</a></span>​(int fetchBatchSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFlushBeforeQueries(int)">setFlushBeforeQueries</a></span>​(int flush)</code></th> |
| <td class="colLast"> |
| <div class="block">The query automatic flush configuration.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHint(java.lang.String,java.lang.Object)">setHint</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets an arbitrary query hint that may be utilized during execution.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHint(java.lang.String,java.lang.Object,java.lang.Object)">setHint</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> original)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets an arbitrary query hint that may be utilized during execution.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockScope(int)">setLockScope</a></span>​(int scope)</code></th> |
| <td class="colLast"> |
| <div class="block">The lock scope for next fetch.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockTimeout(int)">setLockTimeout</a></span>​(int timeout)</code></th> |
| <td class="colLast"> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxFetchDepth(int)">setMaxFetchDepth</a></span>​(int depth)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the maximum depth of the fetched instance graph.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryCacheEnabled(boolean)">setQueryCacheEnabled</a></span>​(boolean cache)</code></th> |
| <td class="colLast"> |
| <div class="block">Control whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryTimeout(int)">setQueryTimeout</a></span>​(int timeout)</code></th> |
| <td class="colLast"> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadLockLevel(int)">setReadLockLevel</a></span>​(int level)</code></th> |
| <td class="colLast"> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRootClasses(java.util.Collection)">setRootClasses</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> roots)</code></th> |
| <td class="colLast"> |
| <div class="block">Root classes for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRootInstances(java.util.Collection)">setRootInstances</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> roots)</code></th> |
| <td class="colLast"> |
| <div class="block">Root instances for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWriteLockLevel(int)">setWriteLockLevel</a></span>​(int level)</code></th> |
| <td class="colLast"> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#translate(java.lang.RuntimeException)">translate</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a> re)</code></th> |
| <td class="colLast"> |
| <div class="block">Translate the OpenJPA exception.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traverse(org.apache.openjpa.meta.FieldMetaData)">traverse</a></span>​(<a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fmd)</code></th> |
| <td class="colLast"> |
| <div class="block">Traverse the given field to generate (possibly) a new configuration |
| state.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unlock()">unlock</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Release internal lock if multithreaded is true.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DelegatingFetchConfiguration</h4> |
| <pre>public DelegatingFetchConfiguration​(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Constructor; supply delegate.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.openjpa.kernel.FetchConfiguration,org.apache.openjpa.util.RuntimeExceptionTranslator)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DelegatingFetchConfiguration</h4> |
| <pre>public DelegatingFetchConfiguration​(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| <a href="../util/RuntimeExceptionTranslator.html" title="interface in org.apache.openjpa.util">RuntimeExceptionTranslator</a> trans)</pre> |
| <div class="block">Constructor; supply delegate and exception translator.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getDelegate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelegate</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getDelegate()</pre> |
| <div class="block">Return the direct delegate.</div> |
| </li> |
| </ul> |
| <a id="getInnermostDelegate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInnermostDelegate</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getInnermostDelegate()</pre> |
| <div class="block">Return the native delegate.</div> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="translate(java.lang.RuntimeException)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>translate</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a> translate​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a> re)</pre> |
| <div class="block">Translate the OpenJPA exception.</div> |
| </li> |
| </ul> |
| <a id="getContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre class="methodSignature">public <a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getContext()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getContext()">FetchConfiguration</a></code></span></div> |
| <div class="block">Return the context associated with this configuration; |
| may be null if it has not been set or this object has been serialized.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getContext()">getContext</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setContext(org.apache.openjpa.kernel.StoreContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContext</h4> |
| <pre class="methodSignature">public void setContext​(<a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setContext(org.apache.openjpa.kernel.StoreContext)">FetchConfiguration</a></code></span></div> |
| <div class="block">Called automatically by the system to associate the fetch configuration |
| with a context before use. The fetch configuration properties should |
| be synchronized with the context's configuration object. Subclasses |
| for specific back ends cannot rely on the context's configuration |
| implementing their back end's configuration sub-interface.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFetchBatchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchBatchSize</h4> |
| <pre class="methodSignature">public int getFetchBatchSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getFetchBatchSize()">FetchConfiguration</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getFetchBatchSize()">getFetchBatchSize</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFetchBatchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchBatchSize</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setFetchBatchSize​(int fetchBatchSize)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setFetchBatchSize(int)">FetchConfiguration</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setFetchBatchSize(int)">setFetchBatchSize</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxFetchDepth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFetchDepth</h4> |
| <pre class="methodSignature">public int getMaxFetchDepth()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getMaxFetchDepth()">FetchConfiguration</a></code></span></div> |
| <div class="block">Return the maximum depth of fetched instance graph. |
| Defaults to <code>1</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getMaxFetchDepth()">getMaxFetchDepth</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxFetchDepth(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFetchDepth</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setMaxFetchDepth​(int depth)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setMaxFetchDepth(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">Set the maximum depth of the fetched instance graph.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setMaxFetchDepth(int)">setMaxFetchDepth</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>depth</code> - denotes limiting length of traversal path from a root |
| instance. <code>-1</code> implies no limit. <code>0</code> is not |
| permissible.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRootInstances()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootInstances</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a> getRootInstances()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getRootInstances()">FetchConfiguration</a></code></span></div> |
| <div class="block">Root instances for recursive operations. This set is not thread safe.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getRootInstances()">getRootInstances</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRootInstances(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootInstances</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setRootInstances​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> roots)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setRootInstances(java.util.Collection)">FetchConfiguration</a></code></span></div> |
| <div class="block">Root instances for recursive operations.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setRootInstances(java.util.Collection)">setRootInstances</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRootClasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootClasses</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a> getRootClasses()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getRootClasses()">FetchConfiguration</a></code></span></div> |
| <div class="block">Root classes for recursive operations. This set is not thread safe.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getRootClasses()">getRootClasses</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRootClasses(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootClasses</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setRootClasses​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> roots)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setRootClasses(java.util.Collection)">FetchConfiguration</a></code></span></div> |
| <div class="block">Root classes for recursive operations.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setRootClasses(java.util.Collection)">setRootClasses</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQueryCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryCacheEnabled</h4> |
| <pre class="methodSignature">public boolean getQueryCacheEnabled()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getQueryCacheEnabled()">FetchConfiguration</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getQueryCacheEnabled()">getQueryCacheEnabled</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setQueryCacheEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryCacheEnabled</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setQueryCacheEnabled​(boolean cache)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setQueryCacheEnabled(boolean)">FetchConfiguration</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setQueryCacheEnabled(boolean)">setQueryCacheEnabled</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFlushBeforeQueries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlushBeforeQueries</h4> |
| <pre class="methodSignature">public int getFlushBeforeQueries()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getFlushBeforeQueries()">FetchConfiguration</a></code></span></div> |
| <div class="block">The query automatic flush configuration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getFlushBeforeQueries()">getFlushBeforeQueries</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFlushBeforeQueries(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFlushBeforeQueries</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setFlushBeforeQueries​(int flush)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setFlushBeforeQueries(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">The query automatic flush configuration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setFlushBeforeQueries(int)">setFlushBeforeQueries</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExtendedPathLookup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedPathLookup</h4> |
| <pre class="methodSignature">public boolean getExtendedPathLookup()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getExtendedPathLookup()">FetchConfiguration</a></code></span></div> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getExtendedPathLookup()">getExtendedPathLookup</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExtendedPathLookup(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtendedPathLookup</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setExtendedPathLookup​(boolean flag)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setExtendedPathLookup(boolean)">FetchConfiguration</a></code></span></div> |
| <div class="block">Sets extended path lookup feature.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a> getFetchGroups()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getFetchGroups()">FetchConfiguration</a></code></span></div> |
| <div class="block">Returns immutable set of names of the fetch groups that this component |
| will use when loading objects. Defaults to the |
| <code>openjpa.FetchGroups</code> setting. This set is not thread safe.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getFetchGroups()">getFetchGroups</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFetchGroup</h4> |
| <pre class="methodSignature">public boolean hasFetchGroup​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> group)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#hasFetchGroup(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Return true if the given fetch group has been added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#hasFetchGroup(java.lang.String)">hasFetchGroup</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroup</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFetchGroup​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> group)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#addFetchGroup(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Adds <code>group</code> to the set of fetch group names to |
| use when loading objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#addFetchGroup(java.lang.String)">addFetchGroup</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addFetchGroups(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFetchGroups​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> groups)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#addFetchGroups(java.util.Collection)">FetchConfiguration</a></code></span></div> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#addFetchGroups(java.util.Collection)">addFetchGroups</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroup</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFetchGroup​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> group)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#removeFetchGroup(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Remove the given fetch group.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#removeFetchGroup(java.lang.String)">removeFetchGroup</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeFetchGroups(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFetchGroups​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> groups)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#removeFetchGroups(java.util.Collection)">FetchConfiguration</a></code></span></div> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFetchGroups</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> clearFetchGroups()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#clearFetchGroups()">FetchConfiguration</a></code></span></div> |
| <div class="block">Clears the set of fetch group names to use when 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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#clearFetchGroups()">clearFetchGroups</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resetFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetFetchGroups</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> resetFetchGroups()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#resetFetchGroups()">FetchConfiguration</a></code></span></div> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#resetFetchGroups()">resetFetchGroups</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a> getFields()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getFields()">FetchConfiguration</a></code></span></div> |
| <div class="block">Returns the set of fully-qualified field names that this component |
| will use when loading objects. Defaults to the empty set. This set is |
| not thread safe.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getFields()">getFields</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre class="methodSignature">public boolean hasField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#hasField(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Return true if the given fully-qualified field has been added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#hasField(java.lang.String)">hasField</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#addField(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#addField(java.lang.String)">addField</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addFields(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFields​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> fields)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#addFields(java.util.Collection)">FetchConfiguration</a></code></span></div> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#addFields(java.util.Collection)">addFields</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#removeField(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Remove the given fully-qualified field.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#removeField(java.lang.String)">removeField</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeFields(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFields​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> fields)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#removeFields(java.util.Collection)">FetchConfiguration</a></code></span></div> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#removeFields(java.util.Collection)">removeFields</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFields</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> clearFields()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#clearFields()">FetchConfiguration</a></code></span></div> |
| <div class="block">Clears the set of field names to use when 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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#clearFields()">clearFields</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLockTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockTimeout</h4> |
| <pre class="methodSignature">public int getLockTimeout()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getLockTimeout()">FetchConfiguration</a></code></span></div> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getLockTimeout()">getLockTimeout</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLockTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockTimeout</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setLockTimeout​(int timeout)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setLockTimeout(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setLockTimeout(int)">setLockTimeout</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQueryTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeout</h4> |
| <pre class="methodSignature">public int getQueryTimeout()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getQueryTimeout()">FetchConfiguration</a></code></span></div> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getQueryTimeout()">getQueryTimeout</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setQueryTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeout</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setQueryTimeout​(int timeout)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setQueryTimeout(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setQueryTimeout(int)">setQueryTimeout</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLockScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockScope</h4> |
| <pre class="methodSignature">public int getLockScope()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getLockScope()">FetchConfiguration</a></code></span></div> |
| <div class="block">The lock scope for next fetch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getLockScope()">getLockScope</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLockScope(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockScope</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setLockScope​(int scope)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setLockScope(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">The lock scope for next fetch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setLockScope(int)">setLockScope</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getReadLockLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadLockLevel</h4> |
| <pre class="methodSignature">public int getReadLockLevel()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getReadLockLevel()">FetchConfiguration</a></code></span></div> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getReadLockLevel()">getReadLockLevel</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setReadLockLevel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadLockLevel</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setReadLockLevel​(int level)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setReadLockLevel(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setReadLockLevel(int)">setReadLockLevel</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getWriteLockLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockLevel</h4> |
| <pre class="methodSignature">public int getWriteLockLevel()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getWriteLockLevel()">FetchConfiguration</a></code></span></div> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getWriteLockLevel()">getWriteLockLevel</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setWriteLockLevel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockLevel</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setWriteLockLevel​(int level)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setWriteLockLevel(int)">FetchConfiguration</a></code></span></div> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setWriteLockLevel(int)">setWriteLockLevel</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResultList</h4> |
| <pre class="methodSignature">public <a href="../lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</a> newResultList​(<a href="../lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> rop)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">FetchConfiguration</a></code></span></div> |
| <div class="block">Return a new result list for the current fetch configuration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">newResultList</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public void copy​(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#copy(org.apache.openjpa.kernel.FetchConfiguration)">FetchConfiguration</a></code></span></div> |
| <div class="block">Copy the state from the given fetch configuration to this one.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#copy(org.apache.openjpa.kernel.FetchConfiguration)">copy</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> clone()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#clone()">FetchConfiguration</a></code></span></div> |
| <div class="block">Clone this instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#clone()">clone</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHint(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre class="methodSignature">public void setHint​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setHint(java.lang.String,java.lang.Object)">FetchConfiguration</a></code></span></div> |
| <div class="block">Sets an arbitrary query hint that may be utilized during execution. |
| The hint may be specific to a particular database. A hint, if known |
| to this receiver, may have a corresponding setter method, then the hint sets the value. |
| Otherwise the hint is stored opaquely by the receiver. |
| <br> |
| This is same as calling <a href="FetchConfiguration.html#setHint(java.lang.String,java.lang.Object,java.lang.Object)">FetchConfiguration.setHint(String, Object, Object)</a> with the third |
| argument being the same as the second.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setHint(java.lang.String,java.lang.Object)">setHint</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dd><code>value</code> - the value of the hint. If the hint has a corresponding setter, then |
| the type of value must be same as the setter argument.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHint(java.lang.String,java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre class="methodSignature">public void setHint​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> original)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setHint(java.lang.String,java.lang.Object,java.lang.Object)">FetchConfiguration</a></code></span></div> |
| <div class="block">Sets an arbitrary query hint that may be utilized during execution. |
| The hint may be specific to a particular database. A hint, if known |
| to this receiver, may have a corresponding setter method, then the hint sets the value. |
| Otherwise the hint is stored opaquely by the receiver.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setHint(java.lang.String,java.lang.Object,java.lang.Object)">setHint</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the hint</dd> |
| <dd><code>value</code> - the value of the hint. If the hint has a corresponding setter, then |
| the type of value must be same as the setter argument.</dd> |
| <dd><code>original</code> - the value of the hint as specified by the user.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isHintSet(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHintSet</h4> |
| <pre class="methodSignature">public boolean isHintSet​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#isHintSet(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Affirm if the given hint has been set in this receiver.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#isHintSet(java.lang.String)">isHintSet</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isDefaultPUFetchGroupConfigurationOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultPUFetchGroupConfigurationOnly</h4> |
| <pre class="methodSignature">public boolean isDefaultPUFetchGroupConfigurationOnly()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#isDefaultPUFetchGroupConfigurationOnly()">FetchConfiguration</a></code></span></div> |
| <div class="block">Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#isDefaultPUFetchGroupConfigurationOnly()">isDefaultPUFetchGroupConfigurationOnly</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHint(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHint</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getHint​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getHint(java.lang.String)">FetchConfiguration</a></code></span></div> |
| <div class="block">Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getHint(java.lang.String)">getHint</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHints()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHints</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> getHints()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getHints()">FetchConfiguration</a></code></span></div> |
| <div class="block">Get an immutable view of the currently active hints and their values. |
| The values are as specified by the user.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getHints()">getHints</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="requiresFetch(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresFetch</h4> |
| <pre class="methodSignature">public int requiresFetch​(<a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fmd)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">FetchConfiguration</a></code></span></div> |
| <div class="block">Affirms if the given field requires to be fetched in the context |
| of current fetch operation. Returns one of <a href="FetchConfiguration.html#FETCH_NONE"><code>FetchConfiguration.FETCH_NONE</code></a>, |
| <a href="FetchConfiguration.html#FETCH_LOAD"><code>FetchConfiguration.FETCH_LOAD</code></a>, <a href="FetchConfiguration.html#FETCH_REF"><code>FetchConfiguration.FETCH_REF</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">requiresFetch</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="requiresLoad()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresLoad</h4> |
| <pre class="methodSignature">public boolean requiresLoad()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#requiresLoad()">FetchConfiguration</a></code></span></div> |
| <div class="block">Return false if we know that the object being fetched with this |
| configuration does not require a load, because this configuration came |
| from a traversal of a <a href="FetchConfiguration.html#FETCH_REF"><code>FetchConfiguration.FETCH_REF</code></a> field.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#requiresLoad()">requiresLoad</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="traverse(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>traverse</h4> |
| <pre class="methodSignature">public <a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> traverse​(<a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fmd)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#traverse(org.apache.openjpa.meta.FieldMetaData)">FetchConfiguration</a></code></span></div> |
| <div class="block">Traverse the given field to generate (possibly) a new configuration |
| state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#traverse(org.apache.openjpa.meta.FieldMetaData)">traverse</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new configuration state resulting out of traversal</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="lock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre class="methodSignature">public void lock()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#lock()">FetchConfiguration</a></code></span></div> |
| <div class="block">Synchronize on internal lock if multithreaded is true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#lock()">lock</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unlock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre class="methodSignature">public void unlock()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#unlock()">FetchConfiguration</a></code></span></div> |
| <div class="block">Release internal lock if multithreaded is true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#unlock()">unlock</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCacheRetrieveMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheRetrieveMode</h4> |
| <pre class="methodSignature">public <a href="DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> getCacheRetrieveMode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getCacheRetrieveMode()">FetchConfiguration</a></code></span></div> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getCacheRetrieveMode()">getCacheRetrieveMode</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCacheStoreMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStoreMode</h4> |
| <pre class="methodSignature">public <a href="DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> getCacheStoreMode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#getCacheStoreMode()">FetchConfiguration</a></code></span></div> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#getCacheStoreMode()">getCacheStoreMode</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheRetrieveMode</h4> |
| <pre class="methodSignature">public void setCacheRetrieveMode​(<a href="DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">FetchConfiguration</a></code></span></div> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStoreMode</h4> |
| <pre class="methodSignature">public void setCacheStoreMode​(<a href="DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">FetchConfiguration</a></code></span></div> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFetchConfigurationSQLCacheAdmissible()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isFetchConfigurationSQLCacheAdmissible</h4> |
| <pre class="methodSignature">public boolean isFetchConfigurationSQLCacheAdmissible()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FetchConfiguration.html#isFetchConfigurationSQLCacheAdmissible()">FetchConfiguration</a></code></span></div> |
| <div class="block">Whether SQL generated by the FetchConfiguration's current configuration should be cached.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FetchConfiguration.html#isFetchConfigurationSQLCacheAdmissible()">isFetchConfigurationSQLCacheAdmissible</a></code> in interface <code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DelegatingFetchConfiguration.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |