| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:28 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DataCacheStoreManager (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DataCacheStoreManager (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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/DataCacheStoreManager.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/datacache/DataCachePCDataImpl.html" title="class in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/DefaultCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/datacache/DataCacheStoreManager.html" target="_top">Frames</a></li> |
| <li><a href="DataCacheStoreManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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.datacache</div> |
| <h2 title="Class DataCacheStoreManager" class="title">Class DataCacheStoreManager</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><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">org.apache.openjpa.kernel.DelegatingStoreManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.datacache.DataCacheStoreManager</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">DataCacheStoreManager</span> |
| extends <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></pre> |
| <div class="block">StoreManager proxy that delegates to a data cache when possible.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Patrick Linskey</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.kernel.StoreManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#FORCE_LOAD_ALL">FORCE_LOAD_ALL</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#FORCE_LOAD_DFG">FORCE_LOAD_DFG</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#FORCE_LOAD_NONE">FORCE_LOAD_NONE</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#FORCE_LOAD_REFRESH">FORCE_LOAD_REFRESH</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_DIFFERENT">VERSION_DIFFERENT</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_EARLIER">VERSION_EARLIER</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_LATER">VERSION_LATER</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_SAME">VERSION_SAME</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#DataCacheStoreManager(org.apache.openjpa.kernel.StoreManager)">DataCacheStoreManager</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a> sm)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#begin()">begin</a></strong>()</code> |
| <div class="block">Begin a data store transaction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#commit()">commit</a></strong>()</code> |
| <div class="block">Commit the current data store transaction.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">exists</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <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> edata)</code> |
| <div class="block">Verify that the given instance exists in the data store; return false |
| if it does not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#flush(java.util.Collection)">flush</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="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> states)</code> |
| <div class="block">Flush the given state manager collection to the datastore, returning |
| a collection of exceptions encountered during flushing.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#initialize(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">initialize</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> state, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| <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> edata)</code> |
| <div class="block">Initialize the given state manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#isCached(java.util.List,%20java.util.BitSet)">isCached</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> edata)</code> |
| <div class="block">Verify that the given instance exists in the data store in memory; return false |
| if it does not.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)">load</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> fields, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| int lockLevel, |
| <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> edata)</code> |
| <div class="block">Load the given state manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/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/datacache/DataCacheStoreManager.html#loadAll(java.util.Collection,%20org.apache.openjpa.kernel.PCState,%20int,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">loadAll</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="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> state, |
| int load, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| <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> edata)</code> |
| <div class="block">Initialize, load, or validate the existance of all of the given |
| objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#rollback()">rollback</a></strong>()</code> |
| <div class="block">Rollback the current data store transaction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.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">Set a reference to the corresponding context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">syncVersion</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <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> edata)</code> |
| <div class="block">Update the version information in the given state manager to the |
| version stored in the data store.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.kernel.DelegatingStoreManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#assignField(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20boolean)">assignField</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#assignObjectId(org.apache.openjpa.kernel.OpenJPAStateManager,%20boolean)">assignObjectId</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#beforeStateChange(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.kernel.PCState)">beforeStateChange</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#beginOptimistic()">beginOptimistic</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#cancelAll()">cancelAll</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#close()">close</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#compareVersion(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object,%20java.lang.Object)">compareVersion</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#copyDataStoreId(java.lang.Object,%20org.apache.openjpa.meta.ClassMetaData)">copyDataStoreId</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#executeExtent(org.apache.openjpa.meta.ClassMetaData,%20boolean,%20org.apache.openjpa.kernel.FetchConfiguration)">executeExtent</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getClientConnection()">getClientConnection</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getDataStoreIdSequence(org.apache.openjpa.meta.ClassMetaData)">getDataStoreIdSequence</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getDataStoreIdType(org.apache.openjpa.meta.ClassMetaData)">getDataStoreIdType</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getDelegate()">getDelegate</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getInnermostDelegate()">getInnermostDelegate</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getManagedType(java.lang.Object)">getManagedType</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#getValueSequence(org.apache.openjpa.meta.FieldMetaData)">getValueSequence</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#newDataStoreId(java.lang.Object,%20org.apache.openjpa.meta.ClassMetaData)">newDataStoreId</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#newFetchConfiguration()">newFetchConfiguration</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#newQuery(java.lang.String)">newQuery</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#releaseConnection()">releaseConnection</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#retainConnection()">retainConnection</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#rollbackOptimistic()">rollbackOptimistic</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DataCacheStoreManager(org.apache.openjpa.kernel.StoreManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DataCacheStoreManager</h4> |
| <pre>public DataCacheStoreManager(<a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a> sm)</pre> |
| <div class="block">Constructor.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sm</code> - the store manager to delegate to</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="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/StoreManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">StoreManager</a></code></strong></div> |
| <div class="block">Set a reference to the corresponding context. This method |
| will be called before the store manager is used. The store manager |
| is responsible for pulling any necessary configuration data from the |
| context, including the transaction mode and connection retain mode.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="begin()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>begin</h4> |
| <pre>public void begin()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#begin()">StoreManager</a></code></strong></div> |
| <div class="block">Begin a data store transaction. After this method is called, |
| it is assumed that all further operations are operating in a single |
| transaction that can be committed or rolled back. If optimistic |
| transactions are in use, this method will only be called when the |
| system requires a transactionally consistent connection due to a |
| user request to flush or commit the transaction. In this case, it |
| is possible that the optimistic transaction does not have the latest |
| versions of all instances (i.e. another transaction has modified the |
| same instances and committed since the optimistic transaction started). |
| On commit, an exception must be thrown on any attempt to overwrite |
| data for an instance with an older version.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#begin()">begin</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#begin()">begin</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>public void commit()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#commit()">StoreManager</a></code></strong></div> |
| <div class="block">Commit the current data store transaction.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#commit()">commit</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#commit()">commit</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollback()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>public void rollback()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#rollback()">StoreManager</a></code></strong></div> |
| <div class="block">Rollback the current data store transaction.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#rollback()">rollback</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#rollback()">rollback</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exists(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exists</h4> |
| <pre>public boolean exists(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <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> edata)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">StoreManager</a></code></strong></div> |
| <div class="block">Verify that the given instance exists in the data store; return false |
| if it does not.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">exists</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">exists</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCached(java.util.List, java.util.BitSet)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCached</h4> |
| <pre>public boolean isCached(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> edata)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#isCached(java.util.List,%20java.util.BitSet)">StoreManager</a></code></strong></div> |
| <div class="block">Verify that the given instance exists in the data store in memory; return false |
| if it does not. When an object is found in memory the corresponding element of |
| the BitSet is set to 1.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#isCached(java.util.List,%20java.util.BitSet)">isCached</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#isCached(java.util.List,%20java.util.BitSet)">isCached</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>syncVersion</h4> |
| <pre>public boolean syncVersion(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <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> edata)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">StoreManager</a></code></strong></div> |
| <div class="block">Update the version information in the given state manager to the |
| version stored in the data store.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">syncVersion</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)">syncVersion</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>sm</code> - the instance to check</dd><dd><code>edata</code> - the current execution data, or null if not |
| given to the calling method of the context</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the instance still exists in the |
| datastore and is up-to-date, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public boolean initialize(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> state, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| <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> edata)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">StoreManager</a></code></strong></div> |
| <div class="block">Initialize the given state manager. The object id of the |
| state manager will be set, and the state manager's metadata be set to |
| the class of the instance to load, or possibly one of its superclasses. |
| Initialization involves first calling the |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#initialize(java.lang.Class,%20org.apache.openjpa.kernel.PCState)"><code>OpenJPAStateManager.initialize(java.lang.Class, org.apache.openjpa.kernel.PCState)</code></a> method with |
| a new instance of the correct type constructed with the |
| <a href="../../../../org/apache/openjpa/enhance/PCRegistry.html#newInstance(java.lang.Class,%20org.apache.openjpa.enhance.StateManager,%20boolean)"><code>PCRegistry.newInstance(Class, |
| org.apache.openjpa.enhance.StateManager, boolean)</code></a> method |
| (this will reset the state manager's metadata if the actual type was a |
| subclass). After instance initialization, load any the fields for the |
| given fetch configuration that can be efficiently retrieved. If any of |
| the configured fields are not loaded in this method, they will be |
| loaded with a subsequent call to <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)"><code>StoreManager.load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a>. If this method is |
| called during a data store transaction, the instance's database record |
| should be locked. Version information can be loaded if desired through |
| the <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setVersion(java.lang.Object)"><code>OpenJPAStateManager.setVersion(java.lang.Object)</code></a> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">initialize</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#initialize(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">initialize</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>sm</code> - the instance to initialize</dd><dd><code>state</code> - the lifecycle state to initialize the state manager with</dd><dd><code>fetch</code> - configuration for how to load the instance</dd><dd><code>edata</code> - the current execution data, or null if not |
| given to the calling method of the broker</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the matching instance exists in the data |
| store, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public boolean load(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> fields, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| int lockLevel, |
| <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> edata)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)">StoreManager</a></code></strong></div> |
| <div class="block">Load the given state manager. |
| Note that any collection or map types loaded into the state manager |
| will be proxied with the correct type; therefore the store manager |
| does not have to load the same concrete collection/map types as the |
| instance declares. However, array types must be consistent with the |
| array type stored by the persistence capable instance. If this method |
| is called during a data store transaction, the instance should be |
| locked. If the given state manager does not have its version set |
| already, version information can be loaded if desired through the |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setVersion(java.lang.Object)"><code>OpenJPAStateManager.setVersion(java.lang.Object)</code></a> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)">load</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)">load</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>sm</code> - the instance to load</dd><dd><code>fields</code> - set of fields to load; all field indexes in this |
| set must be loaded; this set is mutable</dd><dd><code>fetch</code> - the fetch configuration to use when loading |
| related objects</dd><dd><code>lockLevel</code> - attempt to load simple fields at this lock level; |
| relations should be loaded at the read lock level |
| of the fetch configuration</dd><dd><code>edata</code> - the current execution data, or null if not |
| given to the calling method of the broker</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>false if the object no longer exists in the |
| database, true otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="loadAll(java.util.Collection, org.apache.openjpa.kernel.PCState, int, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadAll</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> loadAll(<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="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> state, |
| int load, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch, |
| <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> edata)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#loadAll(java.util.Collection,%20org.apache.openjpa.kernel.PCState,%20int,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">StoreManager</a></code></strong></div> |
| <div class="block">Initialize, load, or validate the existance of all of the given |
| objects. This method is called from various broker methods that act |
| on multiple objects, such as <a href="../../../../org/apache/openjpa/kernel/StoreContext.html#retrieveAll(java.util.Collection,%20boolean,%20org.apache.openjpa.kernel.OpCallbacks)"><code>StoreContext.retrieveAll(java.util.Collection<java.lang.Object>, boolean, org.apache.openjpa.kernel.OpCallbacks)</code></a>. It gives |
| the store manager an opportunity to efficiently batch-load data for |
| several objects. Each of the given state managers will be in one of |
| three states, each requiring a different action: |
| <ul> |
| <li><code>stateManager.getO () == null</code>: An |
| uninitialized state manager. Perform the same actions as in |
| <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)"><code>StoreManager.initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a>. |
| <li><code>load != FORCE_LOAD_NONE || stateManager.getPCState () |
| == PCState.HOLLOW</code>: A hollow state manager, or one whose |
| fields must be loaded because this is a refresh or retrieve action. |
| Peform the same actions as in <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)"><code>StoreManager.load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a>, choosing the fields |
| to load based on the fetch configuration, or loading all fields |
| if <code>load == FORCE_LOAD_ALL</code>. Any required fields left |
| unloaded will cause a subsequent invocation of <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.util.BitSet,%20org.apache.openjpa.kernel.FetchConfiguration,%20int,%20java.lang.Object)"><code>StoreManager.load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a> on |
| the individual object in question.</li> |
| <li><code>load == FORCE_LOAD_NONE && |
| stateManager.getPCState () != PCState.HOLLOW</code>: A non-hollow |
| state manager. Perform the same actions as in <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager,%20java.lang.Object)"><code>StoreManager.exists(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)</code></a>, |
| and load additional state if desired. Non-hollow objects will only |
| be included outside of refresh invocations if a user calls |
| <code>findAll</code> with the <code>validate</code> |
| parameter set to <code>true</code>.</li> |
| </ul> |
| Store managers that cannot efficiently batch load can simply test |
| for these conditions and delegate to the proper methods.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#loadAll(java.util.Collection,%20org.apache.openjpa.kernel.PCState,%20int,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">loadAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#loadAll(java.util.Collection,%20org.apache.openjpa.kernel.PCState,%20int,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)">loadAll</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>sms</code> - the state manager instances to load</dd><dd><code>state</code> - the lifecycle state to initialize uninitialized |
| state managers with; may be null if no uninitialized |
| instances are included in <code>sms</code></dd><dd><code>load</code> - one of the FORCE_LOAD_* constants describing the |
| fields to force-load if this is a refresh or retrieve action</dd><dd><code>fetch</code> - the current fetch configuration to use when loading |
| related objects</dd><dd><code>edata</code> - the current execution data, or null if not |
| given to the calling method of the broker</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a collection of the state manager identities for |
| which no data store record exists</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/util/ImplHelper.html#loadAll(java.util.Collection,%20org.apache.openjpa.kernel.StoreManager,%20org.apache.openjpa.kernel.PCState,%20int,%20org.apache.openjpa.kernel.FetchConfiguration,%20java.lang.Object)"><code>ImplHelper.loadAll(java.util.Collection, org.apache.openjpa.kernel.StoreManager, org.apache.openjpa.kernel.PCState, int, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="flush(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>flush</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/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>> flush(<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="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> states)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#flush(java.util.Collection)">StoreManager</a></code></strong></div> |
| <div class="block">Flush the given state manager collection to the datastore, returning |
| a collection of exceptions encountered during flushing. |
| The given collection may include states that do not require data |
| store action, such as persistent-clean instances or persistent-dirty |
| instances that have not been modified since they were last flushed. |
| For datastore updates and inserts, the dirty, non-flushed fields of |
| each state should be flushed. New instances without an assigned object |
| id should be given one via <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setObjectId(java.lang.Object)"><code>OpenJPAStateManager.setObjectId(java.lang.Object)</code></a>. New |
| instances with value-strategy fields that have not been assigned yet |
| should have their fields set. Datastore version information should be |
| updated during flush, and the state manager's version indicator |
| updated through the <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setNextVersion(java.lang.Object)"><code>OpenJPAStateManager.setNextVersion(java.lang.Object)</code></a> method. |
| The current version will roll over to this next version upon successful |
| commit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#flush(java.util.Collection)">flush</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html#flush(java.util.Collection)">flush</a></code> in class <code><a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>org.apache.openjpa.util.ApplicationIds#assign()</code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DataCacheStoreManager.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/datacache/DataCachePCDataImpl.html" title="class in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/DefaultCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/datacache/DataCacheStoreManager.html" target="_top">Frames</a></li> |
| <li><a href="DataCacheStoreManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
