| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:23 CEST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractStoreManager (OpenJPA Parent POM 3.1.2 API)</title> |
| <meta name="date" content="2020-09-03"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractStoreManager (OpenJPA Parent POM 3.1.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":6,"i12":10,"i13":6,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":6,"i23":6,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractStoreManager.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/abstractstore/AbstractStoreBrokerFactory.html" title="class in org.apache.openjpa.abstractstore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/abstractstore/AbstractStoreManager.html" target="_top">Frames</a></li> |
| <li><a href="AbstractStoreManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><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.abstractstore</div> |
| <h2 title="Class AbstractStoreManager" class="title">Class AbstractStoreManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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.abstractstore.AbstractStoreManager</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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html" title="class in org.apache.openjpa.xmlstore">XMLStoreManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractStoreManager</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></pre> |
| <div class="block">Abstract store manager implementation to ease development of custom |
| OpenJPA back-ends. A concrete subclass must define implementations for the |
| following methods: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#exists-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-"><code>StoreManager.exists(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-"><code>initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-"><code>load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-"><code>flush(Collection,Collection,Collection,Collection,Collection)</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#executeExtent-org.apache.openjpa.meta.ClassMetaData-boolean-org.apache.openjpa.kernel.FetchConfiguration-"><code>executeExtent(org.apache.openjpa.meta.ClassMetaData, boolean, org.apache.openjpa.kernel.FetchConfiguration)</code></a></li> |
| </ul> Additionally, subclasses should not attempt to acquire resources |
| until <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#open--"><code>open()</code></a> has been called. Store manager instances might be |
| created to call metadata methods such as <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newConfiguration--"><code>newConfiguration()</code></a> or |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions--"><code>getUnsupportedOptions()</code></a> and never opened. These instances should |
| not consume any data store resources. |
| Notes: |
| <ul> |
| <li>The <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.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> method is responsible |
| for creating new instances of objects freshly loaded from the |
| database. The method will be invoked with a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a> |
| that the newly-loaded object should be associated with. To create the |
| new object and set up this association correctly, the implementation |
| should use the <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#initialize-java.lang.Class-org.apache.openjpa.kernel.PCState-"><code>OpenJPAStateManager.initialize(java.lang.Class, org.apache.openjpa.kernel.PCState)</code></a> method.</li> |
| <li>If your data store supports some sort of transaction or |
| unit of work, you should override the <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#begin--"><code>begin()</code></a>, <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#commit--"><code>commit()</code></a>, |
| and <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollback--"><code>rollback()</code></a> methods.</li> |
| <li>This class provides no infrastructure support for optimistic |
| transactions. To provide optimistic transaction support: |
| <ul> |
| <li>Override <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#beginOptimistic--"><code>beginOptimistic()</code></a>, <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollbackOptimistic--"><code>rollbackOptimistic()</code></a>, |
| and <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#syncVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-"><code>syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)</code></a>.</li> |
| <li>Override <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions--"><code>getUnsupportedOptions()</code></a> to not include <a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_OPTIMISTIC"><code>OpenJPAConfiguration.OPTION_OPTIMISTIC</code></a> in the list of unsupported |
| options.</li> |
| <li>Ensure that your flush implementation sets the next |
| version for each modified object via the <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setNextVersion-java.lang.Object-"><code>OpenJPAStateManager.setNextVersion(java.lang.Object)</code></a> method.</li> |
| <li>If your version object does not implement <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>, |
| override <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#compareVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-java.lang.Object-"><code>compareVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object, java.lang.Object)</code></a>, which relies on the |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang"><code>Comparable.compareTo(T)</code></a> method.</li> |
| </ul></li> |
| <li>If your data store supports a mechanism for automatically |
| generating and managing identity values (or if you want to |
| provide that facility on top of your data store), implement |
| the <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdSequence-org.apache.openjpa.meta.ClassMetaData-"><code>getDataStoreIdSequence(org.apache.openjpa.meta.ClassMetaData)</code></a> method if you want to use a |
| <code>long</code> as your datastore identity type and are |
| happy with OpenJPA's <a href="../../../../org/apache/openjpa/util/Id.html" title="class in org.apache.openjpa.util"><code>Id</code></a> class. To use another datastore identity |
| type, override <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getManagedType-java.lang.Object-"><code>getManagedType(java.lang.Object)</code></a>, |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdType-org.apache.openjpa.meta.ClassMetaData-"><code>getDataStoreIdType(org.apache.openjpa.meta.ClassMetaData)</code></a>, <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#copyDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-"><code>copyDataStoreId(java.lang.Object, org.apache.openjpa.meta.ClassMetaData)</code></a>, and |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-"><code>newDataStoreId(java.lang.Object, org.apache.openjpa.meta.ClassMetaData)</code></a> instead. In either case, override |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions--"><code>getUnsupportedOptions()</code></a> to not include |
| <a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_ID_DATASTORE"><code>OpenJPAConfiguration.OPTION_ID_DATASTORE</code></a> in the list of |
| unsupported options.</li> |
| <li>If your data store does not support queries (or if you do |
| not want to convert OpenJPA's query parse tree into a |
| datastore-specific query), you still have two options in terms |
| of query execution: |
| <ul> |
| <li><em>In-memory execution</em>: If you |
| execute a query against an extent or a class, OpenJPA will |
| automatically load the full extent of objects into memory and |
| execute the query in memory.</li> |
| <li><em>openjpa.MethodQL</em>: MethodQL allows |
| you to use the query APIs to execute a method that finds |
| data in your back-end and returns that data as a |
| <a href="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultList</code></a>. For more details on |
| MethodQL, see the OpenJPA Reference Guide.</li> |
| </ul></li> |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#ctx">ctx</a></span></code> </td> |
| </tr> |
| </table> |
| <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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#AbstractStoreManager--">AbstractStoreManager</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#assignDataStoreId-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-">assignDataStoreId</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</code> |
| <div class="block">Assign a new datastore identity to the given instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#assignField-org.apache.openjpa.kernel.OpenJPAStateManager-int-boolean-">assignField</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| int field, |
| boolean preFlush)</code> |
| <div class="block">Assign a value to the given field.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#assignObjectId-org.apache.openjpa.kernel.OpenJPAStateManager-boolean-">assignObjectId</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| boolean preFlush)</code> |
| <div class="block">Assign an object id to the given new instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#beforeStateChange-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.PCState-">beforeStateChange</a></span>(<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> fromState, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> toState)</code> |
| <div class="block">Notification that the given state manager is about to change its |
| lifecycle state.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#begin--">begin</a></span>()</code> |
| <div class="block">OpenJPA assumes that after this method is invoked, all data |
| accesses through this store manager will be part of a single |
| unit of work that can be rolled back.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#beginOptimistic--">beginOptimistic</a></span>()</code> |
| <div class="block">No-op implementation.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#cancelAll--">cancelAll</a></span>()</code> |
| <div class="block">Returns <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#close--">close</a></span>()</code> |
| <div class="block">Free any resources this store manager is using.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#commit--">commit</a></span>()</code> |
| <div class="block">This is a no-op implementation.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#compareVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-java.lang.Object-">compareVersion</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> state, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> v1, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> v2)</code> |
| <div class="block">Casts <code>v1</code> and <code>v2</code> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>, and |
| invokes <code>v1.compareTo (v2)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#copyDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-">copyDataStoreId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid, |
| <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code> |
| <div class="block">Copy the given object id value.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#executeExtent-org.apache.openjpa.meta.ClassMetaData-boolean-org.apache.openjpa.kernel.FetchConfiguration-">executeExtent</a></span>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| boolean subs, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code> |
| <div class="block">Create a <a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultObjectProvider</code></a> that can return all instances |
| of <code>type</code>, optionally including subclasses as defined |
| by <code>subclasses</code>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush-java.util.Collection-">flush</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms)</code> |
| <div class="block">Breaks down <code>states</code> based on the objects' current |
| states, and delegates to |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-"><code>flush(Collection,Collection,Collection,Collection,Collection)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-">flush</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pNew, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pNewUpdated, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pNewFlushedDeleted, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pDirty, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pDeleted)</code> |
| <div class="block">Responsible for writing modifications happened back to the data |
| store.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getClientConnection--">getClientConnection</a></span>()</code> |
| <div class="block">Returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getContext--">getContext</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel"><code>StoreContext</code></a> that this store manager is |
| associated with.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Seq.html" title="interface in org.apache.openjpa.kernel">Seq</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdSequence-org.apache.openjpa.meta.ClassMetaData-">getDataStoreIdSequence</a></span>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> forClass)</code> |
| <div class="block">Returns the system-configured sequence.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdType-org.apache.openjpa.meta.ClassMetaData-">getDataStoreIdType</a></span>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code> |
| <div class="block">Return the class used by this StoreManager for datastore identity |
| values.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getManagedType-java.lang.Object-">getManagedType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Return the persistent class for the given data store identity value.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getPlatform--">getPlatform</a></span>()</code> |
| <div class="block">Returns a string name to identify the platform of this |
| store manager.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions--">getUnsupportedOptions</a></span>()</code> |
| <div class="block">Returns a set of option names that this store manager does |
| not support.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Seq.html" title="interface in org.apache.openjpa.kernel">Seq</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getValueSequence-org.apache.openjpa.meta.FieldMetaData-">getValueSequence</a></span>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> forField)</code> |
| <div class="block">Returns null.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-">initialize</a></span>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</code> |
| <div class="block">This method is invoked when OpenJPA needs to load an object whose |
| identity is known but which has not yet been loaded from the data |
| store.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-">load</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</code> |
| <div class="block">This method is invoked when OpenJPA needs to load additional data |
| into an object that has already been at least partially loaded by |
| a previous <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-"><code>initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a> invocation.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#loadAll-java.util.Collection-org.apache.openjpa.kernel.PCState-int-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-">loadAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</code> |
| <div class="block">This implementation just delegates to the proper singular |
| method (<a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.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> or <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-"><code>StoreManager.load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a>) |
| depending on each state manager's state.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newConfiguration--">newConfiguration</a></span>()</code> |
| <div class="block">Return a new configuration instance for this runtime.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-">newDataStoreId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val, |
| <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code> |
| <div class="block">Create a new unique datastore identity for the given type from |
| the given oid value (presumably pk, stringified oid, or oid instance).</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newFetchConfiguration--">newFetchConfiguration</a></span>()</code> |
| <div class="block">Return a fetch configuration suitable for this runtime.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newQuery-java.lang.String-">newQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language)</code> |
| <div class="block">Return a query implementation suitable for this store.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#open--">open</a></span>()</code> |
| <div class="block">No-op implementation.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#releaseConnection--">releaseConnection</a></span>()</code> |
| <div class="block">Override to release previously-retained connection.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#retainConnection--">retainConnection</a></span>()</code> |
| <div class="block">Override to retain a dedicated connection.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollback--">rollback</a></span>()</code> |
| <div class="block">This is a no-op implementation.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollbackOptimistic--">rollbackOptimistic</a></span>()</code> |
| <div class="block">No-op implementation.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#setContext-org.apache.openjpa.kernel.StoreContext-">setContext</a></span>(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</code> |
| <div class="block">Set a reference to the corresponding context.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#syncVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-">syncVersion</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</code> |
| <div class="block">Since this store manager does not provide optimistic locking |
| support, this method always returns <code>true</code>.</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.kernel.StoreManager"> |
| <!-- --> |
| </a> |
| <h3>Methods 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#exists-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-">exists</a>, <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#isCached-java.util.List-java.util.BitSet-">isCached</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="ctx"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ctx</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractStoreManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractStoreManager</h4> |
| <pre>public AbstractStoreManager()</pre> |
| </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 final void setContext(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#setContext-org.apache.openjpa.kernel.StoreContext-">StoreManager</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></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> |
| </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">Returns the <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel"><code>StoreContext</code></a> that this store manager is |
| associated with.</div> |
| </li> |
| </ul> |
| <a name="open--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>protected void open()</pre> |
| <div class="block">No-op implementation. Ready this store manager for persistent operations.</div> |
| </li> |
| </ul> |
| <a name="beginOptimistic--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginOptimistic</h4> |
| <pre>public void beginOptimistic()</pre> |
| <div class="block">No-op implementation. Override this method to provide optimistic |
| locking semantics for your data store if you need notification of |
| the beginning of an optimistic transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#beginOptimistic--">beginOptimistic</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollbackOptimistic--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackOptimistic</h4> |
| <pre>public void rollbackOptimistic()</pre> |
| <div class="block">No-op implementation. Override this method to provide optimistic |
| locking semantics for your data store if you need notification of |
| a rollback of an optimistic transaction before <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#begin--"><code>begin()</code></a> is invoked.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#rollbackOptimistic--">rollbackOptimistic</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</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">OpenJPA assumes that after this method is invoked, all data |
| accesses through this store manager will be part of a single |
| unit of work that can be rolled back. |
| This is a no-op implementation. If your data store does not |
| support any concept of locking or transactions, you need not |
| override this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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> |
| </dl> |
| </li> |
| </ul> |
| <a name="commit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>public void commit()</pre> |
| <div class="block">This is a no-op implementation. If your data store does not |
| have a concept of transactions or a unit of work, you need not |
| override this method. If it does, then override this method to |
| notify the data store that the current transaction should be committed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollback--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>public void rollback()</pre> |
| <div class="block">This is a no-op implementation. If your data store does not |
| have a concept of transactions or a unit of work, you need not |
| override this method. If it does, then override this method to |
| notify the data store that the current transaction should be rolled back.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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> |
| </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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</pre> |
| <div class="block">Since this store manager does not provide optimistic locking |
| support, this method always returns <code>true</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#syncVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.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><span class="paramLabel">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="returnLabel">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 abstract 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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</pre> |
| <div class="block">This method is invoked when OpenJPA needs to load an object whose |
| identity is known but which has not yet been loaded from the data |
| store. <code>sm</code> is a partially-set-up state manager for this |
| object. The ID and least-derived type information for the instance |
| to load can be obtained by invoking |
| <code>sm.getObjectId()</code> and <code>sm.getMetaData()</code>. |
| |
| When implementing this method, load the data for this object from |
| the data store, determine the most-derived subclass of the newly-loaded |
| data, and then use the <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#initialize-java.lang.Class-org.apache.openjpa.kernel.PCState-"><code>OpenJPAStateManager.initialize(java.lang.Class, org.apache.openjpa.kernel.PCState)</code></a> method to |
| populate <code>sm</code> with a new instance of the appropriate type. |
| Once <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#initialize-java.lang.Class-org.apache.openjpa.kernel.PCState-"><code>OpenJPAStateManager.initialize(java.lang.Class, org.apache.openjpa.kernel.PCState)</code></a> has been invoked, proceed to |
| load field data into <code>sm</code> as in the <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-"><code>load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a> method, by |
| using <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#store-int-java.lang.Object-"><code>OpenJPAStateManager.store(int, java.lang.Object)</code></a> (or the appropriate |
| <code>OpenJPAStateManager.store<em>type</em></code> method) to put the |
| data into the object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.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><span class="paramLabel">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="returnLabel">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 abstract boolean load(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</pre> |
| <div class="block">This method is invoked when OpenJPA needs to load additional data |
| into an object that has already been at least partially loaded by |
| a previous <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-"><code>initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a> invocation. |
| Load data into <code>sm</code> by using <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#store-int-java.lang.Object-"><code>OpenJPAStateManager.store(int, java.lang.Object)</code></a> (or the appropriate |
| <code>OpenJPAStateManager.store<em>type</em></code> method) to put the |
| data into the object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.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><span class="paramLabel">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="returnLabel">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="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> loadAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> edata)</pre> |
| <div class="block">This implementation just delegates to the proper singular |
| method (<a href="../../../../org/apache/openjpa/kernel/StoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.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> or <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-"><code>StoreManager.load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a>) |
| depending on each state manager's state. If your data store provides |
| bulk loading APIs, overriding this method to be more clever may be |
| advantageous.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#loadAll-java.util.Collection-org.apache.openjpa.kernel.PCState-int-org.apache.openjpa.kernel.FetchConfiguration-java.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><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>a collection of the state manager identities for |
| which no data store record exists</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/util/ImplHelper.html#loadAll-java.util.Collection-org.apache.openjpa.kernel.StoreManager-org.apache.openjpa.kernel.PCState-int-org.apache.openjpa.kernel.FetchConfiguration-java.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="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>> flush(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms)</pre> |
| <div class="block">Breaks down <code>states</code> based on the objects' current |
| states, and delegates to |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-"><code>flush(Collection,Collection,Collection,Collection,Collection)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="seeLabel">See Also:</span></dt> |
| <dd><code>org.apache.openjpa.util.ApplicationIds#assign()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beforeStateChange-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.PCState-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeStateChange</h4> |
| <pre>public void beforeStateChange(<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> fromState, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> toState)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#beforeStateChange-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.PCState-">StoreManager</a></code></span></div> |
| <div class="block">Notification that the given state manager is about to change its |
| lifecycle state. The store manager is not required to do anything in |
| this method, but some back ends may need to.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#beforeStateChange-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.PCState-">beforeStateChange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assignObjectId-org.apache.openjpa.kernel.OpenJPAStateManager-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignObjectId</h4> |
| <pre>public boolean assignObjectId(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| boolean preFlush)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#assignObjectId-org.apache.openjpa.kernel.OpenJPAStateManager-boolean-">StoreManager</a></code></span></div> |
| <div class="block">Assign an object id to the given new instance. Return false if the |
| instance cannot be assigned an identity because a flush is required |
| (for example, the identity is determined by the datastore on insert). |
| For application identity instances, the assigned object id should be |
| based on field state. The implementation is responsible for using the |
| proper value strategy according to the instance metadata. This method |
| is called the first time a user requests the oid of a new instance |
| before flush.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#assignObjectId-org.apache.openjpa.kernel.OpenJPAStateManager-boolean-">assignObjectId</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dd><code>preFlush</code> - whether this assignment is being requested by the |
| system as part of pre-flush activities, and can |
| be ignored if it is more efficient to assign within <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#flush-java.util.Collection-"><code>StoreManager.flush(java.util.Collection<org.apache.openjpa.kernel.OpenJPAStateManager>)</code></a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/util/ImplHelper.html#generateFieldValue-org.apache.openjpa.kernel.StoreContext-org.apache.openjpa.meta.FieldMetaData-"><code>ImplHelper.generateFieldValue(org.apache.openjpa.kernel.StoreContext, org.apache.openjpa.meta.FieldMetaData)</code></a>, |
| <a href="../../../../org/apache/openjpa/util/ImplHelper.html#generateIdentityValue-org.apache.openjpa.kernel.StoreContext-org.apache.openjpa.meta.ClassMetaData-int-"><code>ImplHelper.generateIdentityValue(org.apache.openjpa.kernel.StoreContext, org.apache.openjpa.meta.ClassMetaData, int)</code></a>, |
| <code>org.apache.openjpa.util.ApplicationIds#assign()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assignDataStoreId-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignDataStoreId</h4> |
| <pre>protected boolean assignDataStoreId(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</pre> |
| <div class="block">Assign a new datastore identity to the given instance. This given |
| value may be null.</div> |
| </li> |
| </ul> |
| <a name="assignField-org.apache.openjpa.kernel.OpenJPAStateManager-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignField</h4> |
| <pre>public boolean assignField(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| int field, |
| boolean preFlush)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#assignField-org.apache.openjpa.kernel.OpenJPAStateManager-int-boolean-">StoreManager</a></code></span></div> |
| <div class="block">Assign a value to the given field. Return false if the value cannot |
| be assigned because a flush is required (for example, the field value |
| is determined by the datastore on insert). This method is called the |
| first time a user requests the value of a field with a value-strategy |
| on a new instance before flush.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#assignField-org.apache.openjpa.kernel.OpenJPAStateManager-int-boolean-">assignField</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| <dd><code>preFlush</code> - whether this assignment is being requested by the |
| system as part of pre-flush activities, and can |
| be ignored if it is more efficient to assign within <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#flush-java.util.Collection-"><code>StoreManager.flush(java.util.Collection<org.apache.openjpa.kernel.OpenJPAStateManager>)</code></a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/util/ImplHelper.html#generateFieldValue-org.apache.openjpa.kernel.StoreContext-org.apache.openjpa.meta.FieldMetaData-"><code>ImplHelper.generateFieldValue(org.apache.openjpa.kernel.StoreContext, org.apache.openjpa.meta.FieldMetaData)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedType-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getManagedType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getManagedType-java.lang.Object-">StoreManager</a></code></span></div> |
| <div class="block">Return the persistent class for the given data store identity value. |
| If the given value is not a datastore identity object, return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getManagedType-java.lang.Object-">getManagedType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataStoreIdType-org.apache.openjpa.meta.ClassMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreIdType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getDataStoreIdType(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getDataStoreIdType-org.apache.openjpa.meta.ClassMetaData-">StoreManager</a></code></span></div> |
| <div class="block">Return the class used by this StoreManager for datastore identity |
| values. The given metadata may be null, in which case the return |
| value should the common datastore identity class for all classes, or |
| null if this store manager does not use a common identity class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getDataStoreIdType-org.apache.openjpa.meta.ClassMetaData-">getDataStoreIdType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyDataStoreId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> copyDataStoreId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid, |
| <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#copyDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-">StoreManager</a></code></span></div> |
| <div class="block">Copy the given object id value. Use the described type of the given |
| metadata, which may be a subclass of the given oid's described type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#copyDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-">copyDataStoreId</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDataStoreId</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newDataStoreId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val, |
| <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#newDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-">StoreManager</a></code></span></div> |
| <div class="block">Create a new unique datastore identity for the given type from |
| the given oid value (presumably pk, stringified oid, or oid instance).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#newDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-">newDataStoreId</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retainConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retainConnection</h4> |
| <pre>public void retainConnection()</pre> |
| <div class="block">Override to retain a dedicated connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#retainConnection--">retainConnection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="releaseConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>releaseConnection</h4> |
| <pre>public void releaseConnection()</pre> |
| <div class="block">Override to release previously-retained connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#releaseConnection--">releaseConnection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientConnection</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getClientConnection()</pre> |
| <div class="block">Returns <code>null</code>. If your data store can provide a |
| distinct connection object, return it here.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getClientConnection--">getClientConnection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeExtent-org.apache.openjpa.meta.ClassMetaData-boolean-org.apache.openjpa.kernel.FetchConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeExtent</h4> |
| <pre>public abstract <a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> executeExtent(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| boolean subs, |
| <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Create a <a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultObjectProvider</code></a> that can return all instances |
| of <code>type</code>, optionally including subclasses as defined |
| by <code>subclasses</code>. |
| The implementation of the result provider will typically execute |
| some sort of data store query to find all the applicable objects, loop |
| through the results, extracting object IDs from the data, and invoke |
| <a href="../../../../org/apache/openjpa/kernel/StoreContext.html#find-java.lang.Object-org.apache.openjpa.kernel.FetchConfiguration-java.util.BitSet-java.lang.Object-int-"><code>StoreContext.find(Object,FetchConfiguration,BitSet,Object,int)</code></a> |
| on each OID. When invoking this method, the first argument is the OID. |
| The second is the given fetch configuration. The |
| third argument is a mask of fields to exclude from loading; it will |
| typically be null. The fourth argument is an object that will be passed |
| through to <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-"><code>initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a> or <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-"><code>load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a>, and typically will |
| contain the actual data to load. For example, for a JDBC-based store |
| manager, this might be the result set that is being iterated over. If |
| this argument is <code>null</code>, then the <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#initialize-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.kernel.PCState-org.apache.openjpa.kernel.FetchConfiguration-java.lang.Object-"><code>initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</code></a> or |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#load-org.apache.openjpa.kernel.OpenJPAStateManager-java.util.BitSet-org.apache.openjpa.kernel.FetchConfiguration-int-java.lang.Object-"><code>load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)</code></a> method will have to issue another command to the data |
| store in order to fetch the data to be loaded.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#executeExtent-org.apache.openjpa.meta.ClassMetaData-boolean-org.apache.openjpa.kernel.FetchConfiguration-">executeExtent</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> newQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#newQuery-java.lang.String-">StoreManager</a></code></span></div> |
| <div class="block">Return a query implementation suitable for this store. If the query |
| is iterated within a data store transaction, returned instances should |
| be locked. Return null if this store does not support native execution |
| of the given language. OpenJPA can execute JPQL in memory even without |
| back end support.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#newQuery-java.lang.String-">newQuery</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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>language</code> - the query language</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newFetchConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newFetchConfiguration</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> newFetchConfiguration()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#newFetchConfiguration--">StoreManager</a></code></span></div> |
| <div class="block">Return a fetch configuration suitable for this runtime. Typically |
| will be or extend <code>FetchConfigurationImpl</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#newFetchConfiguration--">newFetchConfiguration</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareVersion</h4> |
| <pre>public int compareVersion(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> state, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> v1, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> v2)</pre> |
| <div class="block">Casts <code>v1</code> and <code>v2</code> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>, and |
| invokes <code>v1.compareTo (v2)</code>. If <code>v1</code> is less |
| than <code>v2</code>, returns <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_EARLIER"><code>StoreManager.VERSION_EARLIER</code></a>. If the same, |
| returns <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_SAME"><code>StoreManager.VERSION_SAME</code></a>. Otherwise, returns <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_LATER"><code>StoreManager.VERSION_LATER</code></a>. If either <code>v1</code> or <code>v2</code> are |
| <code>null</code>, returns <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_DIFFERENT"><code>StoreManager.VERSION_DIFFERENT</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#compareVersion-org.apache.openjpa.kernel.OpenJPAStateManager-java.lang.Object-java.lang.Object-">compareVersion</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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - the state manager for the object</dd> |
| <dd><code>v1</code> - the first version object to compare</dd> |
| <dd><code>v2</code> - the second version object to compare</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><ul> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_LATER"><code>StoreManager.VERSION_LATER</code></a> if <code>v1</code> |
| is later than <code>v2</code></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_EARLIER"><code>StoreManager.VERSION_EARLIER</code></a> if <code>v1</code> |
| is earlier than <code>v2</code></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_SAME"><code>StoreManager.VERSION_SAME</code></a> if <code>v1</code> |
| is the same as <code>v2</code></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#VERSION_DIFFERENT"><code>StoreManager.VERSION_DIFFERENT</code></a> if <code>v1</code> |
| is different from <code>v2</code>, but the time |
| difference of the versions cannot be determined</li> |
| </ul></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataStoreIdSequence-org.apache.openjpa.meta.ClassMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreIdSequence</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Seq.html" title="interface in org.apache.openjpa.kernel">Seq</a> getDataStoreIdSequence(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> forClass)</pre> |
| <div class="block">Returns the system-configured sequence. To use some other sort |
| of datastore identifier (a GUID, string, or someting of that nature), |
| override <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getManagedType-java.lang.Object-"><code>getManagedType(java.lang.Object)</code></a>, |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdType-org.apache.openjpa.meta.ClassMetaData-"><code>getDataStoreIdType(org.apache.openjpa.meta.ClassMetaData)</code></a>, <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#copyDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-"><code>copyDataStoreId(java.lang.Object, org.apache.openjpa.meta.ClassMetaData)</code></a>, |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newDataStoreId-java.lang.Object-org.apache.openjpa.meta.ClassMetaData-"><code>newDataStoreId(java.lang.Object, org.apache.openjpa.meta.ClassMetaData)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getDataStoreIdSequence-org.apache.openjpa.meta.ClassMetaData-">getDataStoreIdSequence</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueSequence-org.apache.openjpa.meta.FieldMetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueSequence</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Seq.html" title="interface in org.apache.openjpa.kernel">Seq</a> getValueSequence(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> forField)</pre> |
| <div class="block">Returns null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#getValueSequence-org.apache.openjpa.meta.FieldMetaData-">getValueSequence</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelAll</h4> |
| <pre>public boolean cancelAll()</pre> |
| <div class="block">Returns <code>false</code>. If your data store supports |
| cancelling queries, this method should cancel any |
| currently-running queries and return <code>true</code> if any |
| were cancelled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#cancelAll--">cancelAll</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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if any statements cancelled, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#close--">StoreManager</a></code></span></div> |
| <div class="block">Free any resources this store manager is using.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/StoreManager.html#close--">close</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><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flush-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>> flush(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pNew, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pNewUpdated, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pNewFlushedDeleted, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pDirty, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> pDeleted)</pre> |
| <div class="block">Responsible for writing modifications happened back to the data |
| store. If you do not remove the |
| <a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_INC_FLUSH"><code>OpenJPAConfiguration.OPTION_INC_FLUSH</code></a> option in |
| <a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions--"><code>getUnsupportedOptions()</code></a>, this will be called only once at the |
| end of a transaction. Otherwise, it may be called periodically |
| throughout the course of a transaction. |
| If this store manager supports optimistic transactions, datastore |
| version information should be updated during flush, and the state |
| manager's version indicator should be updated through the |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setNextVersion-java.lang.Object-"><code>OpenJPAStateManager.setNextVersion(java.lang.Object)</code></a> method. |
| This method will only be invoked if there are meaningful changes |
| to store. This differs from the behavior of <a href="../../../../org/apache/openjpa/kernel/StoreManager.html#flush-java.util.Collection-"><code>StoreManager.flush(java.util.Collection<org.apache.openjpa.kernel.OpenJPAStateManager>)</code></a>, |
| which may be invoked with a collection of objects in states that |
| do not require any datastore action (for example, objects in the |
| transient-transactional state).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pNew</code> - Objects that should be added to the store, |
| and that have not previously been flushed.</dd> |
| <dd><code>pNewUpdated</code> - New objects that have been modified since |
| they were initially flushed. These were |
| in <code>persistentNew</code> in an earlier flush invocation.</dd> |
| <dd><code>pNewFlushedDeleted</code> - New objects that have been deleted since |
| they were initially flushed. These were |
| in <code>persistentNew</code> in an earlier flush invocation.</dd> |
| <dd><code>pDirty</code> - Objects that were loaded from the data |
| store and have since been modified.</dd> |
| <dd><code>pDeleted</code> - Objects that were loaded from the data |
| store and have since been deleted. These |
| may have been in a previous flush invocation's persistentDirty list.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a collection of exceptions encountered during flushing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newConfiguration</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a> newConfiguration()</pre> |
| <div class="block">Return a new configuration instance for this runtime. Configuration |
| data is maintained at the factory level and is available to all OpenJPA |
| components; therefore it is a good place to maintain shared resources |
| such as connection pools, etc.</div> |
| </li> |
| </ul> |
| <a name="getUnsupportedOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnsupportedOptions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getUnsupportedOptions()</pre> |
| <div class="block">Returns a set of option names that this store manager does |
| not support. By default, returns the following: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_OPTIMISTIC"><code>OpenJPAConfiguration.OPTION_OPTIMISTIC</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_ID_DATASTORE"><code>OpenJPAConfiguration.OPTION_ID_DATASTORE</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_INC_FLUSH"><code>OpenJPAConfiguration.OPTION_INC_FLUSH</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_VALUE_AUTOASSIGN"><code>OpenJPAConfiguration.OPTION_VALUE_AUTOASSIGN</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_VALUE_INCREMENT"><code>OpenJPAConfiguration.OPTION_VALUE_INCREMENT</code></a></li> |
| <li><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html#OPTION_DATASTORE_CONNECTION"><code>OpenJPAConfiguration.OPTION_DATASTORE_CONNECTION</code></a></li> |
| </ul></div> |
| </li> |
| </ul> |
| <a name="getPlatform--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPlatform</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPlatform()</pre> |
| <div class="block">Returns a string name to identify the platform of this |
| store manager. Returns the class name of this store manager by default.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractStoreManager.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/abstractstore/AbstractStoreBrokerFactory.html" title="class in org.apache.openjpa.abstractstore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/abstractstore/AbstractStoreManager.html" target="_top">Frames</a></li> |
| <li><a href="AbstractStoreManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><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–2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |