| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_201) on Wed Apr 24 20:07:03 CEST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FetchConfiguration (OpenJPA Parent POM 3.1.0 API)</title> |
| <meta name="date" content="2019-04-24"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FetchConfiguration (OpenJPA Parent POM 3.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FetchConfiguration.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/kernel/ExtentImpl.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/FetchConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="FetchConfiguration.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.kernel</div> |
| <h2 title="Interface FetchConfiguration" class="title">Interface FetchConfiguration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a>, <a href="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/DelegatingFetchConfiguration.html" title="class in org.apache.openjpa.kernel">DelegatingFetchConfiguration</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/DelegatingJDBCFetchConfiguration.html" title="class in org.apache.openjpa.jdbc.kernel">DelegatingJDBCFetchConfiguration</a>, <a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCFetchConfigurationImpl</a>, <a href="../../../../org/apache/openjpa/slice/jdbc/TargetFetchConfiguration.html" title="class in org.apache.openjpa.slice.jdbc">TargetFetchConfiguration</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FetchConfiguration</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a>, <a href="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></pre> |
| <div class="block">Allows configuration and optimization of how objects are loaded from |
| the data store.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.0</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White, Pinaki Poddar</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#DEFAULT">DEFAULT</a></span></code> |
| <div class="block">Constant to revert any setting back to its default value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_LOAD">FETCH_LOAD</a></span></code> |
| <div class="block">Constant indicating that a field requires a fetch and load of fetched |
| data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_NONE">FETCH_NONE</a></span></code> |
| <div class="block">Constant indicating that a field does not require fetching.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF">FETCH_REF</a></span></code> |
| <div class="block">Constant indicating that a reference to the field's value must be |
| fetched, but loading data is not necessary.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.LockLevels"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_NONE">LOCK_NONE</a>, <a href="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_READ">LOCK_READ</a>, <a href="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_WRITE">LOCK_WRITE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.LockScopes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/LockScopes.html#LOCKSCOPE_EXTENDED">LOCKSCOPE_EXTENDED</a>, <a href="../../../../org/apache/openjpa/kernel/LockScopes.html#LOCKSCOPE_NORMAL">LOCKSCOPE_NORMAL</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.QueryFlushModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_FALSE">FLUSH_FALSE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_TRUE">FLUSH_TRUE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroup-java.lang.String-">addFetchGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Adds <code>group</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroups-java.util.Collection-">addFetchGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</code> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addField-java.lang.String-">addField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFields-java.util.Collection-">addFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFetchGroups--">clearFetchGroups</a></span>()</code> |
| <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="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFields--">clearFields</a></span>()</code> |
| <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/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clone--">clone</a></span>()</code> |
| <div class="block">Clone this instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#copy-org.apache.openjpa.kernel.FetchConfiguration-">copy</a></span>(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code> |
| <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><a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheRetrieveMode--">getCacheRetrieveMode</a></span>()</code> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheStoreMode--">getCacheStoreMode</a></span>()</code> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getContext--">getContext</a></span>()</code> |
| <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="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getExtendedPathLookup--">getExtendedPathLookup</a></span>()</code> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchBatchSize--">getFetchBatchSize</a></span>()</code> |
| <div class="block">Return the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchGroups--">getFetchGroups</a></span>()</code> |
| <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="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFields--">getFields</a></span>()</code> |
| <div class="block">Returns the set of fully-qualified field names that this component |
| will use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFlushBeforeQueries--">getFlushBeforeQueries</a></span>()</code> |
| <div class="block">The query automatic flush configuration.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHint-java.lang.String-">getHint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHints--">getHints</a></span>()</code> |
| <div class="block">Get an immutable view of the currently active hints and their values.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockScope--">getLockScope</a></span>()</code> |
| <div class="block">The lock scope for next fetch.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockTimeout--">getLockTimeout</a></span>()</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getMaxFetchDepth--">getMaxFetchDepth</a></span>()</code> |
| <div class="block">Return the maximum depth of fetched instance graph.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryCacheEnabled--">getQueryCacheEnabled</a></span>()</code> |
| <div class="block">Return whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryTimeout--">getQueryTimeout</a></span>()</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getReadLockLevel--">getReadLockLevel</a></span>()</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootClasses--">getRootClasses</a></span>()</code> |
| <div class="block">Root classes for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootInstances--">getRootInstances</a></span>()</code> |
| <div class="block">Root instances for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getWriteLockLevel--">getWriteLockLevel</a></span>()</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasFetchGroup-java.lang.String-">hasFetchGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Return true if the given fetch group has been added.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasField-java.lang.String-">hasField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return true if the given fully-qualified field has been added.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isDefaultPUFetchGroupConfigurationOnly--">isDefaultPUFetchGroupConfigurationOnly</a></span>()</code> |
| <div class="block">Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isFetchConfigurationSQLCacheAdmissible--">isFetchConfigurationSQLCacheAdmissible</a></span>()</code> |
| <div class="block">Whether SQL generated by the FetchConfiguration's current configuration should be cached.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isHintSet-java.lang.String-">isHintSet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Affirm if the given hint has been set in this receiver.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#lock--">lock</a></span>()</code> |
| <div class="block">Synchronize on internal lock if multithreaded is true.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#newResultList-org.apache.openjpa.lib.rop.ResultObjectProvider-">newResultList</a></span>(<a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> rop)</code> |
| <div class="block">Return a new result list for the current fetch configuration.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroup-java.lang.String-">removeFetchGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Remove the given fetch group.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroups-java.util.Collection-">removeFetchGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</code> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeField-java.lang.String-">removeField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFields-java.util.Collection-">removeFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch-org.apache.openjpa.meta.FieldMetaData-">requiresFetch</a></span>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fm)</code> |
| <div class="block">Affirms if the given field requires to be fetched in the context |
| of current fetch operation.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresLoad--">requiresLoad</a></span>()</code> |
| <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="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF"><code>FETCH_REF</code></a> field.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#resetFetchGroups--">resetFetchGroups</a></span>()</code> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheRetrieveMode-org.apache.openjpa.kernel.DataCacheRetrieveMode-">setCacheRetrieveMode</a></span>(<a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</code> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheStoreMode-org.apache.openjpa.kernel.DataCacheStoreMode-">setCacheStoreMode</a></span>(<a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</code> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setContext-org.apache.openjpa.kernel.StoreContext-">setContext</a></span>(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</code> |
| <div class="block">Called automatically by the system to associate the fetch configuration |
| with a context before use.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setExtendedPathLookup-boolean-">setExtendedPathLookup</a></span>(boolean flag)</code> |
| <div class="block">Sets extended path lookup feature.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFetchBatchSize-int-">setFetchBatchSize</a></span>(int fetchBatchSize)</code> |
| <div class="block">Set the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFlushBeforeQueries-int-">setFlushBeforeQueries</a></span>(int flush)</code> |
| <div class="block">The query automatic flush configuration.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint-java.lang.String-java.lang.Object-">setHint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Sets an arbitrary query hint that may be utilized during execution.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint-java.lang.String-java.lang.Object-java.lang.Object-">setHint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original)</code> |
| <div class="block">Sets an arbitrary query hint that may be utilized during execution.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockScope-int-">setLockScope</a></span>(int scope)</code> |
| <div class="block">The lock scope for next fetch.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockTimeout-int-">setLockTimeout</a></span>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setMaxFetchDepth-int-">setMaxFetchDepth</a></span>(int max)</code> |
| <div class="block">Set the maximum depth of the fetched instance graph.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryCacheEnabled-boolean-">setQueryCacheEnabled</a></span>(boolean cache)</code> |
| <div class="block">Control whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryTimeout-int-">setQueryTimeout</a></span>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setReadLockLevel-int-">setReadLockLevel</a></span>(int level)</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootClasses-java.util.Collection-">setRootClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> classes)</code> |
| <div class="block">Root classes for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootInstances-java.util.Collection-">setRootInstances</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> roots)</code> |
| <div class="block">Root instances for recursive operations.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setWriteLockLevel-int-">setWriteLockLevel</a></span>(int level)</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#traverse-org.apache.openjpa.meta.FieldMetaData-">traverse</a></span>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fm)</code> |
| <div class="block">Traverse the given field to generate (possibly) a new configuration |
| state.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#unlock--">unlock</a></span>()</code> |
| <div class="block">Release internal lock if multithreaded is true.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT</h4> |
| <pre>static final int DEFAULT</pre> |
| <div class="block">Constant to revert any setting back to its default value.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_NONE</h4> |
| <pre>static final int FETCH_NONE</pre> |
| <div class="block">Constant indicating that a field does not require fetching.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch-org.apache.openjpa.meta.FieldMetaData-"><code>requiresFetch(org.apache.openjpa.meta.FieldMetaData)</code></a>, |
| <a href="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.FETCH_NONE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_LOAD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_LOAD</h4> |
| <pre>static final int FETCH_LOAD</pre> |
| <div class="block">Constant indicating that a field requires a fetch and load of fetched |
| data.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch-org.apache.openjpa.meta.FieldMetaData-"><code>requiresFetch(org.apache.openjpa.meta.FieldMetaData)</code></a>, |
| <a href="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.FETCH_LOAD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_REF"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FETCH_REF</h4> |
| <pre>static final int FETCH_REF</pre> |
| <div class="block">Constant indicating that a reference to the field's value must be |
| fetched, but loading data is not necessary. Used when we know the |
| data will be loaded anyway, such as when traversing the back-ptr of |
| a bidirectional relation where the other side is also being fetched.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch-org.apache.openjpa.meta.FieldMetaData-"><code>requiresFetch(org.apache.openjpa.meta.FieldMetaData)</code></a>, |
| <a href="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.FETCH_REF">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getContext()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="setContext-org.apache.openjpa.kernel.StoreContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContext</h4> |
| <pre>void setContext(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone()</pre> |
| <div class="block">Clone this instance.</div> |
| </li> |
| </ul> |
| <a name="copy-org.apache.openjpa.kernel.FetchConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>void copy(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Copy the state from the given fetch configuration to this one.</div> |
| </li> |
| </ul> |
| <a name="getFetchBatchSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchBatchSize</h4> |
| <pre>int getFetchBatchSize()</pre> |
| <div class="block">Return the fetch batch size for large result set support. |
| Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note |
| that this property will be ignored under some data stores.</div> |
| </li> |
| </ul> |
| <a name="setFetchBatchSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchBatchSize</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setFetchBatchSize(int fetchBatchSize)</pre> |
| <div class="block">Set the fetch batch size for large result set support. |
| Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note |
| that this property will be ignored under some data stores.</div> |
| </li> |
| </ul> |
| <a name="getMaxFetchDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFetchDepth</h4> |
| <pre>int getMaxFetchDepth()</pre> |
| <div class="block">Return the maximum depth of fetched instance graph. |
| Defaults to <code>1</code></div> |
| </li> |
| </ul> |
| <a name="setMaxFetchDepth-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFetchDepth</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setMaxFetchDepth(int max)</pre> |
| <div class="block">Set the maximum depth of the fetched instance graph.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>max</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 name="getQueryCacheEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryCacheEnabled</h4> |
| <pre>boolean getQueryCacheEnabled()</pre> |
| <div class="block">Return whether or not query caching is enabled. If this returns |
| <code>true</code> but the datacache plugin is not installed, caching |
| will not be enabled. If this |
| returns <code>false</code>, query caching will not be used |
| even if the datacache plugin is installed.</div> |
| </li> |
| </ul> |
| <a name="setQueryCacheEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryCacheEnabled</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setQueryCacheEnabled(boolean cache)</pre> |
| <div class="block">Control whether or not query caching is enabled. This has no effect |
| if the datacache plugin is not installed, or if the query cache size |
| is set to zero.</div> |
| </li> |
| </ul> |
| <a name="getFlushBeforeQueries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlushBeforeQueries</h4> |
| <pre>int getFlushBeforeQueries()</pre> |
| <div class="block">The query automatic flush configuration.</div> |
| </li> |
| </ul> |
| <a name="setFlushBeforeQueries-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFlushBeforeQueries</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setFlushBeforeQueries(int flush)</pre> |
| <div class="block">The query automatic flush configuration.</div> |
| </li> |
| </ul> |
| <a name="getExtendedPathLookup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedPathLookup</h4> |
| <pre>boolean getExtendedPathLookup()</pre> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExtendedPathLookup-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtendedPathLookup</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setExtendedPathLookup(boolean flag)</pre> |
| <div class="block">Sets extended path lookup feature.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFetchGroups()</pre> |
| <div class="block">Returns 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> |
| </li> |
| </ul> |
| <a name="hasFetchGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFetchGroup</h4> |
| <pre>boolean hasFetchGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block">Return true if the given fetch group has been added.</div> |
| </li> |
| </ul> |
| <a name="addFetchGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroup</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFetchGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block">Adds <code>group</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFetchGroups-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFetchGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</pre> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeFetchGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroup</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFetchGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block">Remove the given fetch group.</div> |
| </li> |
| </ul> |
| <a name="removeFetchGroups-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFetchGroups(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</pre> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="clearFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> clearFetchGroups()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="resetFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetFetchGroups</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> resetFetchGroups()</pre> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </li> |
| </ul> |
| <a name="getFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFields()</pre> |
| <div class="block">Returns the 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> |
| </li> |
| </ul> |
| <a name="hasField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>boolean hasField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Return true if the given fully-qualified field has been added.</div> |
| </li> |
| </ul> |
| <a name="addField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="addFields-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</pre> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="removeField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </li> |
| </ul> |
| <a name="removeFields-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</pre> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </li> |
| </ul> |
| <a name="clearFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFields</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> clearFields()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="getLockTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockTimeout</h4> |
| <pre>int getLockTimeout()</pre> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockTimeout</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setLockTimeout(int timeout)</pre> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLockScope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockScope</h4> |
| <pre>int getLockScope()</pre> |
| <div class="block">The lock scope for next fetch.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockScope-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockScope</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setLockScope(int scope)</pre> |
| <div class="block">The lock scope for next fetch.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeout</h4> |
| <pre>int getQueryTimeout()</pre> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeout</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setQueryTimeout(int timeout)</pre> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadLockLevel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadLockLevel</h4> |
| <pre>int getReadLockLevel()</pre> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadLockLevel-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadLockLevel</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setReadLockLevel(int level)</pre> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteLockLevel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockLevel</h4> |
| <pre>int getWriteLockLevel()</pre> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheStoreMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStoreMode</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> getCacheStoreMode()</pre> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheStoreMode-org.apache.openjpa.kernel.DataCacheStoreMode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStoreMode</h4> |
| <pre>void setCacheStoreMode(<a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</pre> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheRetrieveMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheRetrieveMode</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> getCacheRetrieveMode()</pre> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheRetrieveMode-org.apache.openjpa.kernel.DataCacheRetrieveMode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheRetrieveMode</h4> |
| <pre>void setCacheRetrieveMode(<a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</pre> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWriteLockLevel-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockLevel</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setWriteLockLevel(int level)</pre> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newResultList-org.apache.openjpa.lib.rop.ResultObjectProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResultList</h4> |
| <pre><a href="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</a><?> newResultList(<a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> rop)</pre> |
| <div class="block">Return a new result list for the current fetch configuration.</div> |
| </li> |
| </ul> |
| <a name="setHint-java.lang.String-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre>void setHint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original)</pre> |
| <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="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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHint-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre>void setHint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">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="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint-java.lang.String-java.lang.Object-java.lang.Object-">setHint(String, Object, Object)</a> with the third |
| argument being the same as the second.</div> |
| <dl> |
| <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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHint-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHint</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getHint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the hint name</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHints--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHints</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getHints()</pre> |
| <div class="block">Get an immutable view of the currently active hints and their values. |
| The values are as specified by the user.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHintSet-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHintSet</h4> |
| <pre>boolean isHintSet(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Affirm if the given hint has been set in this receiver.</div> |
| </li> |
| </ul> |
| <a name="isDefaultPUFetchGroupConfigurationOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultPUFetchGroupConfigurationOnly</h4> |
| <pre>boolean isDefaultPUFetchGroupConfigurationOnly()</pre> |
| <div class="block">Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</div> |
| </li> |
| </ul> |
| <a name="getRootClasses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootClasses</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> getRootClasses()</pre> |
| <div class="block">Root classes for recursive operations. This set is not thread safe.</div> |
| </li> |
| </ul> |
| <a name="setRootClasses-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootClasses</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setRootClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> classes)</pre> |
| <div class="block">Root classes for recursive operations.</div> |
| </li> |
| </ul> |
| <a name="getRootInstances--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootInstances</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getRootInstances()</pre> |
| <div class="block">Root instances for recursive operations. This set is not thread safe.</div> |
| </li> |
| </ul> |
| <a name="setRootInstances-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootInstances</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setRootInstances(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> roots)</pre> |
| <div class="block">Root instances for recursive operations.</div> |
| </li> |
| </ul> |
| <a name="lock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre>void lock()</pre> |
| <div class="block">Synchronize on internal lock if multithreaded is true.</div> |
| </li> |
| </ul> |
| <a name="unlock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre>void unlock()</pre> |
| <div class="block">Release internal lock if multithreaded is true.</div> |
| </li> |
| </ul> |
| <a name="requiresFetch-org.apache.openjpa.meta.FieldMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresFetch</h4> |
| <pre>int requiresFetch(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fm)</pre> |
| <div class="block">Affirms if the given field requires to be fetched in the context |
| of current fetch operation. Returns one of <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_NONE"><code>FETCH_NONE</code></a>, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_LOAD"><code>FETCH_LOAD</code></a>, <code>FETCH_REF</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="requiresLoad--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresLoad</h4> |
| <pre>boolean requiresLoad()</pre> |
| <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="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF"><code>FETCH_REF</code></a> field.</div> |
| </li> |
| </ul> |
| <a name="traverse-org.apache.openjpa.meta.FieldMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>traverse</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> traverse(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fm)</pre> |
| <div class="block">Traverse the given field to generate (possibly) a new configuration |
| state.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new configuration state resulting out of traversal</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFetchConfigurationSQLCacheAdmissible--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isFetchConfigurationSQLCacheAdmissible</h4> |
| <pre>boolean isFetchConfigurationSQLCacheAdmissible()</pre> |
| <div class="block">Whether SQL generated by the FetchConfiguration's current configuration should be cached.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FetchConfiguration.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/kernel/ExtentImpl.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/FetchConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="FetchConfiguration.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |