| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:40 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FetchConfigurationImpl (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FetchConfigurationImpl (OpenJPA Parent POM 2.4.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FetchConfigurationImpl.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/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/FetchConfigurationImpl.html" target="_top">Frames</a></li> |
| <li><a href="FetchConfigurationImpl.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </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 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="Class FetchConfigurationImpl" class="title">Class FetchConfigurationImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.kernel.FetchConfigurationImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</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></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCFetchConfigurationImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">FetchConfigurationImpl</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre> |
| <div class="block">Allows configuration and optimization of how objects are loaded from |
| the data store.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.3.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Abe White, Pinaki Poddar</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.openjpa.kernel.FetchConfigurationImpl">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl.ConfigurationState</a></strong></code> |
| <div class="block">Configurable state shared throughout a traversal chain.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.kernel.FetchConfiguration"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#DEFAULT">DEFAULT</a>, <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_LOAD">FETCH_LOAD</a>, <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_NONE">FETCH_NONE</a>, <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF">FETCH_REF</a></code></li> |
| </ul> |
| <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> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#FetchConfigurationImpl()">FetchConfigurationImpl</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#FetchConfigurationImpl(org.apache.openjpa.kernel.FetchConfigurationImpl.ConfigurationState)">FetchConfigurationImpl</a></strong>(<a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl.ConfigurationState</a> state)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#addFetchGroup(java.lang.String)">addFetchGroup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Adds <code>group</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#addFetchGroups(java.util.Collection)">addFetchGroups</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</code> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#addField(java.lang.String)">addField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#addFields(java.util.Collection)">addFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</code> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#clearFetchGroups()">clearFetchGroups</a></strong>()</code> |
| <div class="block">Clears the set of fetch group names to use when loading |
| data.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#clearFields()">clearFields</a></strong>()</code> |
| <div class="block">Clears the set of field names to use when loading |
| data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#clone()">clone</a></strong>()</code> |
| <div class="block">Clone this instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#copy(org.apache.openjpa.kernel.FetchConfiguration)">copy</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getCacheRetrieveMode()">getCacheRetrieveMode</a></strong>()</code> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getCacheStoreMode()">getCacheStoreMode</a></strong>()</code> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getContext()">getContext</a></strong>()</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 class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getExtendedPathLookup()">getExtendedPathLookup</a></strong>()</code> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getFetchBatchSize()">getFetchBatchSize</a></strong>()</code> |
| <div class="block">Return the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getFetchGroups()">getFetchGroups</a></strong>()</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 class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getFields()">getFields</a></strong>()</code> |
| <div class="block">Returns the set of fully-qualified field names that this component |
| will use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getFlushBeforeQueries()">getFlushBeforeQueries</a></strong>()</code> |
| <div class="block">The query automatic flush configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getHint(java.lang.String)">getHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getHints()">getHints</a></strong>()</code> |
| <div class="block">Gets the current hints set on this receiver.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getLockScope()">getLockScope</a></strong>()</code> |
| <div class="block">The lock scope for next fetch.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getLockTimeout()">getLockTimeout</a></strong>()</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getMaxFetchDepth()">getMaxFetchDepth</a></strong>()</code> |
| <div class="block">Return the maximum depth of fetched instance graph.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getQueryCacheEnabled()">getQueryCacheEnabled</a></strong>()</code> |
| <div class="block">Return whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getQueryTimeout()">getQueryTimeout</a></strong>()</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getReadLockLevel()">getReadLockLevel</a></strong>()</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getRootClasses()">getRootClasses</a></strong>()</code> |
| <div class="block">Root classes for recursive operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getRootInstances()">getRootInstances</a></strong>()</code> |
| <div class="block">Root instances for recursive operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getSupportedHints()">getSupportedHints</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#getWriteLockLevel()">getWriteLockLevel</a></strong>()</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#hasFetchGroup(java.lang.String)">hasFetchGroup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Return true if the given fetch group has been added.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#hasFetchGroupAll()">hasFetchGroupAll</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#hasFetchGroupDefault()">hasFetchGroupDefault</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#hasField(java.lang.String)">hasField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return true if the given fully-qualified field has been added.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#isDefaultPUFetchGroupConfigurationOnly()">isDefaultPUFetchGroupConfigurationOnly</a></strong>()</code> |
| <div class="block">Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#isFetchConfigurationSQLCacheAdmissible()">isFetchConfigurationSQLCacheAdmissible</a></strong>()</code> |
| <div class="block">Whether SQL generated by the FetchConfiguration's current configuration should be cached.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#isHintSet(java.lang.String)">isHintSet</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Affirms if the given key is set as a hint.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#lock()">lock</a></strong>()</code> |
| <div class="block">Synchronize on internal lock if multithreaded is true.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#newInstance(org.apache.openjpa.kernel.FetchConfigurationImpl.ConfigurationState)">newInstance</a></strong>(<a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl.ConfigurationState</a> state)</code> |
| <div class="block">Return a new hollow instance.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">newResultList</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#populateHintSetter(java.lang.Class,%20java.lang.String,%20java.lang.Class,%20java.lang.String...)">populateHintSetter</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> target, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hint, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... prefixes)</code> |
| <div class="block">Populate static registry of hints.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#populateHintSetter(java.lang.Class,%20java.lang.String,%20java.lang.String,%20java.lang.Class,%20java.lang.String...)">populateHintSetter</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> target, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> method, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hint, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... prefixes)</code> |
| <div class="block">Populate static registry of hints.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#removeFetchGroup(java.lang.String)">removeFetchGroup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</code> |
| <div class="block">Remove the given fetch group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</code> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#removeField(java.lang.String)">removeField</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Remove the given fully-qualified field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#removeFields(java.util.Collection)">removeFields</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</code> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#removeHint(java.lang.String...)">removeHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... keys)</code> |
| <div class="block">Removes the given keys and their hint value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#removeHint(java.lang.String)">removeHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">requiresFetch</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#requiresLoad()">requiresLoad</a></strong>()</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>FetchConfiguration.FETCH_REF</code></a> field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#resetFetchGroups()">resetFetchGroups</a></strong>()</code> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></strong>(<a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</code> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></strong>(<a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</code> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></strong>(boolean flag)</code> |
| <div class="block">Sets extended path lookup feature.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setFetchBatchSize(int)">setFetchBatchSize</a></strong>(int fetchBatchSize)</code> |
| <div class="block">Set the fetch batch size for large result set support.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setFlushBeforeQueries(int)">setFlushBeforeQueries</a></strong>(int flush)</code> |
| <div class="block">The query automatic flush configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setHint(java.lang.String,%20java.lang.Object)">setHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Same as <code>setHint(key, value, value)</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setHint(java.lang.String,%20java.lang.Object,%20java.lang.Object)">setHint</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original)</code> |
| <div class="block">Sets the hint to the given value.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setLockScope(int)">setLockScope</a></strong>(int scope)</code> |
| <div class="block">The lock scope for next fetch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setLockTimeout(int)">setLockTimeout</a></strong>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="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><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setMaxFetchDepth(int)">setMaxFetchDepth</a></strong>(int depth)</code> |
| <div class="block">Set the maximum depth of the fetched instance graph.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setQueryCacheEnabled(boolean)">setQueryCacheEnabled</a></strong>(boolean cache)</code> |
| <div class="block">Control whether or not query caching is enabled.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setQueryTimeout(int)">setQueryTimeout</a></strong>(int timeout)</code> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setReadLockLevel(int)">setReadLockLevel</a></strong>(int level)</code> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setRootClasses(java.util.Collection)">setRootClasses</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> classes)</code> |
| <div class="block">Root classes for recursive operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setRootInstances(java.util.Collection)">setRootInstances</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> instances)</code> |
| <div class="block">Root instances for recursive operations.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setWriteLockLevel(int)">setWriteLockLevel</a></strong>(int level)</code> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#toString()">toString</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#toString(java.lang.Object)">toString</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#traverse(org.apache.openjpa.meta.FieldMetaData)">traverse</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#unlock()">unlock</a></strong>()</code> |
| <div class="block">Release internal lock if multithreaded is true.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FetchConfigurationImpl()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FetchConfigurationImpl</h4> |
| <pre>public FetchConfigurationImpl()</pre> |
| </li> |
| </ul> |
| <a name="FetchConfigurationImpl(org.apache.openjpa.kernel.FetchConfigurationImpl.ConfigurationState)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FetchConfigurationImpl</h4> |
| <pre>protected FetchConfigurationImpl(<a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl.ConfigurationState</a> state)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="populateHintSetter(java.lang.Class, java.lang.String, java.lang.Class, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>populateHintSetter</h4> |
| <pre>protected static void populateHintSetter(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> target, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hint, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... prefixes)</pre> |
| <div class="block">Populate static registry of hints.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The name of the target class that will receive this hint.</dd><dd><code>hint</code> - the simple name of the hint without a prefix.</dd><dd><code>type</code> - the value argument type of the target setter method.</dd><dd><code>prefixes</code> - the prefixes will be added to the simple hint name.</dd></dl> |
| </li> |
| </ul> |
| <a name="populateHintSetter(java.lang.Class, java.lang.String, java.lang.String, java.lang.Class, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>populateHintSetter</h4> |
| <pre>protected static void populateHintSetter(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> target, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> method, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hint, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... prefixes)</pre> |
| <div class="block">Populate static registry of hints.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The name of the target class that will receive this hint.</dd><dd><code>method</code> - The name of the method in the target class that will receive this hint.</dd><dd><code>hint</code> - the simple name of the hint without a prefix.</dd><dd><code>type</code> - the value argument type of the target setter method.</dd><dd><code>prefixes</code> - the prefixes will be added to the simple hint name.</dd></dl> |
| </li> |
| </ul> |
| <a name="getContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getContext()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getContext()">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getContext()">getContext</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContext(org.apache.openjpa.kernel.StoreContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContext</h4> |
| <pre>public void setContext(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setContext(org.apache.openjpa.kernel.StoreContext)">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone()</pre> |
| <div class="block">Clone this instance.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clone()">clone</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstance(org.apache.openjpa.kernel.FetchConfigurationImpl.ConfigurationState)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl</a> newInstance(<a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl.ConfigurationState</a> state)</pre> |
| <div class="block">Return a new hollow instance.</div> |
| </li> |
| </ul> |
| <a name="copy(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public void copy(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#copy(org.apache.openjpa.kernel.FetchConfiguration)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Copy the state from the given fetch configuration to this one.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#copy(org.apache.openjpa.kernel.FetchConfiguration)">copy</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchBatchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchBatchSize</h4> |
| <pre>public int getFetchBatchSize()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchBatchSize()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Return the fetch batch size for large result set support. |
| Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note |
| that this property will be ignored under some data stores.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchBatchSize()">getFetchBatchSize</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFetchBatchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchBatchSize</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setFetchBatchSize(int fetchBatchSize)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFetchBatchSize(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Set the fetch batch size for large result set support. |
| Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note |
| that this property will be ignored under some data stores.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFetchBatchSize(int)">setFetchBatchSize</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxFetchDepth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFetchDepth</h4> |
| <pre>public int getMaxFetchDepth()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getMaxFetchDepth()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Return the maximum depth of fetched instance graph. |
| Defaults to <code>1</code></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getMaxFetchDepth()">getMaxFetchDepth</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxFetchDepth(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFetchDepth</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setMaxFetchDepth(int depth)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setMaxFetchDepth(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Set the maximum depth of the fetched instance graph.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setMaxFetchDepth(int)">setMaxFetchDepth</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="strong">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 name="getQueryCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryCacheEnabled</h4> |
| <pre>public boolean getQueryCacheEnabled()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryCacheEnabled()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Return whether or not query caching is enabled. If this returns |
| <code>true</code> but the datacache plugin is not installed, caching |
| will not be enabled. If this |
| returns <code>false</code>, query caching will not be used |
| even if the datacache plugin is installed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryCacheEnabled()">getQueryCacheEnabled</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryCacheEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryCacheEnabled</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setQueryCacheEnabled(boolean cache)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryCacheEnabled(boolean)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Control whether or not query caching is enabled. This has no effect |
| if the datacache plugin is not installed, or if the query cache size |
| is set to zero.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryCacheEnabled(boolean)">setQueryCacheEnabled</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlushBeforeQueries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlushBeforeQueries</h4> |
| <pre>public int getFlushBeforeQueries()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFlushBeforeQueries()">FetchConfiguration</a></code></strong></div> |
| <div class="block">The query automatic flush configuration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFlushBeforeQueries()">getFlushBeforeQueries</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExtendedPathLookup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedPathLookup</h4> |
| <pre>public boolean getExtendedPathLookup()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getExtendedPathLookup()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Affirms if extended path lookup feature is active.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getExtendedPathLookup()">getExtendedPathLookup</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExtendedPathLookup(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtendedPathLookup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setExtendedPathLookup(boolean flag)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setExtendedPathLookup(boolean)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Sets extended path lookup feature.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFlushBeforeQueries(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFlushBeforeQueries</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setFlushBeforeQueries(int flush)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFlushBeforeQueries(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">The query automatic flush configuration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFlushBeforeQueries(int)">setFlushBeforeQueries</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFetchGroups()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchGroups()">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchGroups()">getFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFetchGroup</h4> |
| <pre>public boolean hasFetchGroup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasFetchGroup(java.lang.String)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Return true if the given fetch group has been added.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasFetchGroup(java.lang.String)">hasFetchGroup</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasFetchGroupDefault()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFetchGroupDefault</h4> |
| <pre>public boolean hasFetchGroupDefault()</pre> |
| </li> |
| </ul> |
| <a name="hasFetchGroupAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFetchGroupAll</h4> |
| <pre>public boolean hasFetchGroupAll()</pre> |
| </li> |
| </ul> |
| <a name="addFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFetchGroup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroup(java.lang.String)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Adds <code>group</code> to the set of fetch group names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroup(java.lang.String)">addFetchGroup</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFetchGroups(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFetchGroups(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroups(java.util.Collection)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Adds <code>groups</code> to the set of fetch group names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroups(java.util.Collection)">addFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFetchGroup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroup(java.lang.String)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Remove the given fetch group.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroup(java.lang.String)">removeFetchGroup</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFetchGroups(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFetchGroups(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> groups)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroups(java.util.Collection)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Removes <code>groups</code> from the set of fetch group names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> clearFetchGroups()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFetchGroups()">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFetchGroups()">clearFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> resetFetchGroups()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#resetFetchGroups()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Resets the set of fetch groups to the list in the global configuration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#resetFetchGroups()">resetFetchGroups</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDefaultPUFetchGroupConfigurationOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultPUFetchGroupConfigurationOnly</h4> |
| <pre>public boolean isDefaultPUFetchGroupConfigurationOnly()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isDefaultPUFetchGroupConfigurationOnly()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isDefaultPUFetchGroupConfigurationOnly()">isDefaultPUFetchGroupConfigurationOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFetchConfigurationSQLCacheAdmissible()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFetchConfigurationSQLCacheAdmissible</h4> |
| <pre>public boolean isFetchConfigurationSQLCacheAdmissible()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isFetchConfigurationSQLCacheAdmissible()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Whether SQL generated by the FetchConfiguration's current configuration should be cached.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isFetchConfigurationSQLCacheAdmissible()">isFetchConfigurationSQLCacheAdmissible</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFields()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFields()">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFields()">getFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>public boolean hasField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasField(java.lang.String)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Return true if the given fully-qualified field has been added.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasField(java.lang.String)">hasField</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addField(java.lang.String)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Adds <code>field</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addField(java.lang.String)">addField</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFields(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> addFields(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFields(java.util.Collection)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Adds <code>fields</code> to the set of fully-qualified field names to |
| use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFields(java.util.Collection)">addFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeField(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeField(java.lang.String)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Remove the given fully-qualified field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeField(java.lang.String)">removeField</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFields(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> removeFields(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFields(java.util.Collection)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Removes <code>fields</code> from the set of fully-qualified field names |
| to use when loading objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFields(java.util.Collection)">removeFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> clearFields()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFields()">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFields()">clearFields</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheRetrieveMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheRetrieveMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> getCacheRetrieveMode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheRetrieveMode()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Gets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheRetrieveMode()">getCacheRetrieveMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheStoreMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStoreMode</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> getCacheStoreMode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheStoreMode()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Gets the current storage mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheStoreMode()">getCacheStoreMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheRetrieveMode</h4> |
| <pre>public void setCacheRetrieveMode(<a href="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a> mode)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Sets the current retrieve mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStoreMode</h4> |
| <pre>public void setCacheStoreMode(<a href="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a> mode)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Sets the current storage mode for data cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLockTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockTimeout</h4> |
| <pre>public int getLockTimeout()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockTimeout()">FetchConfiguration</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockTimeout()">getLockTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockTimeout</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setLockTimeout(int timeout)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockTimeout(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for an object lock, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockTimeout(int)">setLockTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeout</h4> |
| <pre>public int getQueryTimeout()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryTimeout()">FetchConfiguration</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryTimeout()">getQueryTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeout</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setQueryTimeout(int timeout)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryTimeout(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">The number of milliseconds to wait for a query, or -1 for no |
| limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryTimeout(int)">setQueryTimeout</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLockScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockScope</h4> |
| <pre>public int getLockScope()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockScope()">FetchConfiguration</a></code></strong></div> |
| <div class="block">The lock scope for next fetch.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockScope()">getLockScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockScope(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockScope</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setLockScope(int scope)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockScope(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">The lock scope for next fetch.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockScope(int)">setLockScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadLockLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadLockLevel</h4> |
| <pre>public int getReadLockLevel()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getReadLockLevel()">FetchConfiguration</a></code></strong></div> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getReadLockLevel()">getReadLockLevel</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadLockLevel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadLockLevel</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setReadLockLevel(int level)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setReadLockLevel(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">The lock level to use for locking loaded objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setReadLockLevel(int)">setReadLockLevel</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteLockLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockLevel</h4> |
| <pre>public int getWriteLockLevel()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getWriteLockLevel()">FetchConfiguration</a></code></strong></div> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getWriteLockLevel()">getWriteLockLevel</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWriteLockLevel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockLevel</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setWriteLockLevel(int level)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setWriteLockLevel(int)">FetchConfiguration</a></code></strong></div> |
| <div class="block">The lock level to use for locking dirtied objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setWriteLockLevel(int)">setWriteLockLevel</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResultList</h4> |
| <pre>public <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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Return a new result list for the current fetch configuration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">newResultList</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHints()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHints</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getHints()</pre> |
| <div class="block">Gets the current hints set on this receiver. |
| The values designate the actual value specified by the caller and not the values |
| that may have been actually set on the state variables of this receiver.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHints()">getHints</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHintSet(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHintSet</h4> |
| <pre>public boolean isHintSet(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Affirms if the given key is set as a hint.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isHintSet(java.lang.String)">isHintSet</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeHint(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeHint</h4> |
| <pre>public void removeHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... keys)</pre> |
| <div class="block">Removes the given keys and their hint value.</div> |
| </li> |
| </ul> |
| <a name="getSupportedHints()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSupportedHints</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getSupportedHints()</pre> |
| </li> |
| </ul> |
| <a name="setHint(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHint</h4> |
| <pre>public void setHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Same as <code>setHint(key, value, value)</code>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint(java.lang.String,%20java.lang.Object)">setHint</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html#setHint(java.lang.String,%20java.lang.Object,%20java.lang.Object)"><code>setHint(String, Object, Object)</code></a></dd></dl> |
| </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>public void setHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original)</pre> |
| <div class="block">Sets the hint to the given value. |
| If the key corresponds to a known key, then that value is set via the setter method. |
| Otherwise it is put into opaque hints map. |
| <br> |
| In either case, the original value is put in the hints map. |
| So essential difference between setting a value directly by a setter and via a hint is the memory |
| of this original value. |
| <br> |
| The other important difference is setting lock levels. Setting of lock level via setter method needs |
| active transaction. But setting via hint does not.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint(java.lang.String,%20java.lang.Object,%20java.lang.Object)">setHint</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - a hint key. If it is one of the statically registered hint key then the setter is called.</dd><dd><code>value</code> - to be set. The given value type must match the argument type of the setter, if one exists.</dd><dd><code>original</code> - value as specified by the caller. This value is put in the hints map.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the given value is not acceptable by the setter method, if one |
| exists corresponds the given hint key.</dd></dl> |
| </li> |
| </ul> |
| <a name="getHint(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHint</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHint(java.lang.String)">FetchConfiguration</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHint(java.lang.String)">getHint</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeHint(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeHint</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> removeHint(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </li> |
| </ul> |
| <a name="getRootClasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootClasses</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> getRootClasses()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootClasses()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Root classes for recursive operations. This set is not thread safe.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootClasses()">getRootClasses</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRootClasses(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootClasses</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setRootClasses(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> classes)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootClasses(java.util.Collection)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Root classes for recursive operations.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootClasses(java.util.Collection)">setRootClasses</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRootInstances()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootInstances</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getRootInstances()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootInstances()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Root instances for recursive operations. This set is not thread safe.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootInstances()">getRootInstances</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRootInstances(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootInstances</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> setRootInstances(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> instances)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootInstances(java.util.Collection)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Root instances for recursive operations.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootInstances(java.util.Collection)">setRootInstances</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre>public void lock()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#lock()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Synchronize on internal lock if multithreaded is true.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#lock()">lock</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unlock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre>public void unlock()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#unlock()">FetchConfiguration</a></code></strong></div> |
| <div class="block">Release internal lock if multithreaded is true.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#unlock()">unlock</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="requiresFetch(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresFetch</h4> |
| <pre>public int requiresFetch(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fm)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">FetchConfiguration</a></code></strong></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="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_NONE"><code>FetchConfiguration.FETCH_NONE</code></a>, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_LOAD"><code>FetchConfiguration.FETCH_LOAD</code></a>, <code>FETCH_REF</code>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">requiresFetch</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="requiresLoad()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresLoad</h4> |
| <pre>public boolean requiresLoad()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresLoad()">FetchConfiguration</a></code></strong></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="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF"><code>FetchConfiguration.FETCH_REF</code></a> field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresLoad()">requiresLoad</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="traverse(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>traverse</h4> |
| <pre>public <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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#traverse(org.apache.openjpa.meta.FieldMetaData)">FetchConfiguration</a></code></strong></div> |
| <div class="block">Traverse the given field to generate (possibly) a new configuration |
| state.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#traverse(org.apache.openjpa.meta.FieldMetaData)">traverse</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new configuration state resulting out of traversal</dd></dl> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FetchConfigurationImpl.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/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.ConfigurationState.html" title="class in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/FetchConfigurationImpl.html" target="_top">Frames</a></li> |
| <li><a href="FetchConfigurationImpl.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </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 name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
