| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_11) on Tue Feb 12 17:38:40 PST 2008 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| XMLStoreManager (OpenJPA 1.0.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.xmlstore.XMLStoreManager class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="XMLStoreManager (OpenJPA 1.0.2 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLStoreManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/xmlstore/XMLStore.html" title="class in org.apache.openjpa.xmlstore"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/xmlstore/XMLStoreManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="XMLStoreManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.openjpa.abstractstore.AbstractStoreManager">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.xmlstore</FONT> |
| <BR> |
| Class XMLStoreManager</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">org.apache.openjpa.abstractstore.AbstractStoreManager</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.xmlstore.XMLStoreManager</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</A>, <A HREF="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>XMLStoreManager</B><DT>extends <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></DL> |
| </PRE> |
| |
| <P> |
| Store manager to a back-end consisting of XML files. This |
| implementation accesses data through the <A HREF="../../../../org/apache/openjpa/xmlstore/XMLStore.html" title="class in org.apache.openjpa.xmlstore"><CODE>XMLStore</CODE></A> associated with |
| its <A HREF="../../../../org/apache/openjpa/xmlstore/XMLConfiguration.html" title="class in org.apache.openjpa.xmlstore"><CODE>XMLConfiguration</CODE></A>. Configuration instances are shared by all |
| store managers owned by all brokers created with the same factory. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore"><CODE>AbstractStoreManager</CODE></A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.abstractstore.AbstractStoreManager"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.openjpa.abstractstore.<A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#ctx">ctx</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.StoreManager"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#XMLStoreManager()">XMLStoreManager</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#begin()">begin</A></B>()</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#commit()">commit</A></B>()</CODE> |
| |
| <BR> |
| This is a no-op implementation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#executeExtent(org.apache.openjpa.meta.ClassMetaData, boolean, org.apache.openjpa.kernel.FetchConfiguration)">executeExtent</A></B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> meta, |
| boolean subclasses, |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)">exists</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| Verify that the given instance exists in the data store; return false |
| if it does not.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#flush(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)">flush</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pNew, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pNewUpdated, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pNewFlushedDeleted, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pDirty, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pDeleted)</CODE> |
| |
| <BR> |
| Responsible for writing modifications happened back to the data |
| store.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#getUnsupportedOptions()">getUnsupportedOptions</A></B>()</CODE> |
| |
| <BR> |
| Returns a set of option names that this store manager does |
| not support.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)">initialize</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</A> state, |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)">load</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/BitSet.html" title="class or interface in java.util">BitSet</A> fields, |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch, |
| int lockLevel, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| 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>AbstractStoreManager.initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)</CODE></A> invocation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#newConfiguration()">newConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Return a new configuration instance for this runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#open()">open</A></B>()</CODE> |
| |
| <BR> |
| No-op implementation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#rollback()">rollback</A></B>()</CODE> |
| |
| <BR> |
| This is a no-op implementation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/xmlstore/XMLStoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)">syncVersion</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| Since this store manager does not provide optimistic locking |
| support, this method always returns <code>true</code>.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.abstractstore.AbstractStoreManager"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.abstractstore.<A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#assignDataStoreId(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)">assignDataStoreId</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#assignField(org.apache.openjpa.kernel.OpenJPAStateManager, int, boolean)">assignField</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#assignObjectId(org.apache.openjpa.kernel.OpenJPAStateManager, boolean)">assignObjectId</A>, <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>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#beginOptimistic()">beginOptimistic</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#cancelAll()">cancelAll</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#close()">close</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#compareVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object, java.lang.Object)">compareVersion</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#copyDataStoreId(java.lang.Object, org.apache.openjpa.meta.ClassMetaData)">copyDataStoreId</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush(java.util.Collection)">flush</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getClientConnection()">getClientConnection</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getContext()">getContext</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdSequence(org.apache.openjpa.meta.ClassMetaData)">getDataStoreIdSequence</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getDataStoreIdType(org.apache.openjpa.meta.ClassMetaData)">getDataStoreIdType</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getManagedType(java.lang.Object)">getManagedType</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getPlatform()">getPlatform</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getValueSequence(org.apache.openjpa.meta.FieldMetaData)">getValueSequence</A>, <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>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newDataStoreId(java.lang.Object, org.apache.openjpa.meta.ClassMetaData)">newDataStoreId</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newFetchConfiguration()">newFetchConfiguration</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newQuery(java.lang.String)">newQuery</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#releaseConnection()">releaseConnection</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#retainConnection()">retainConnection</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollbackOptimistic()">rollbackOptimistic</A>, <A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="XMLStoreManager()"><!-- --></A><H3> |
| XMLStoreManager</H3> |
| <PRE> |
| public <B>XMLStoreManager</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getUnsupportedOptions()"><!-- --></A><H3> |
| getUnsupportedOptions</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> <B>getUnsupportedOptions</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions()">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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> |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#getUnsupportedOptions()">getUnsupportedOptions</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newConfiguration()"><!-- --></A><H3> |
| newConfiguration</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</A> <B>newConfiguration</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newConfiguration()">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#newConfiguration()">newConfiguration</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="open()"><!-- --></A><H3> |
| open</H3> |
| <PRE> |
| protected void <B>open</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#open()">AbstractStoreManager</A></CODE></B></DD> |
| <DD>No-op implementation. Ready this store manager for persistent operations. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#open()">open</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="exists(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)"><!-- --></A><H3> |
| exists</H3> |
| <PRE> |
| public boolean <B>exists</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/kernel/StoreManager.html#exists(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)">StoreManager</A></CODE></B></DD> |
| <DD>Verify that the given instance exists in the data store; return false |
| if it does not. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initialize(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.kernel.PCState, org.apache.openjpa.kernel.FetchConfiguration, java.lang.Object)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| public boolean <B>initialize</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</A> state, |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><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)">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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>AbstractStoreManager.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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Specified by:</B><DD><CODE><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></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sm</CODE> - the instance to initialize<DD><CODE>state</CODE> - the lifecycle state to initialize the state manager with<DD><CODE>fetch</CODE> - configuration for how to load the instance<DD><CODE>context</CODE> - the current execution data, or null if not |
| given to the calling method of the broker |
| <DT><B>Returns:</B><DD>true if the matching instance exists in the data |
| store, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="load(org.apache.openjpa.kernel.OpenJPAStateManager, java.util.BitSet, org.apache.openjpa.kernel.FetchConfiguration, int, java.lang.Object)"><!-- --></A><H3> |
| load</H3> |
| <PRE> |
| public boolean <B>load</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/BitSet.html" title="class or interface in java.util">BitSet</A> fields, |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch, |
| int lockLevel, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><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)">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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>AbstractStoreManager.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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Specified by:</B><DD><CODE><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></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sm</CODE> - the instance to load<DD><CODE>fields</CODE> - set of fields to load; all field indexes in this |
| set must be loaded; this set is mutable<DD><CODE>fetch</CODE> - the fetch configuration to use when loading |
| related objects<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><CODE>context</CODE> - the current execution data, or null if not |
| given to the calling method of the broker |
| <DT><B>Returns:</B><DD>false if the object no longer exists in the |
| database, true otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)"><!-- --></A><H3> |
| syncVersion</H3> |
| <PRE> |
| public boolean <B>syncVersion</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)">AbstractStoreManager</A></CODE></B></DD> |
| <DD>Since this store manager does not provide optimistic locking |
| support, this method always returns <code>true</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#syncVersion(org.apache.openjpa.kernel.OpenJPAStateManager, java.lang.Object)">syncVersion</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sm</CODE> - the instance to check<DD><CODE>context</CODE> - the current execution data, or null if not |
| given to the calling method of the context |
| <DT><B>Returns:</B><DD>true if the instance still exists in the |
| datastore and is up-to-date, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="begin()"><!-- --></A><H3> |
| begin</H3> |
| <PRE> |
| public void <B>begin</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#begin()">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#begin()">begin</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="commit()"><!-- --></A><H3> |
| commit</H3> |
| <PRE> |
| public void <B>commit</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#commit()">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="rollback()"><!-- --></A><H3> |
| rollback</H3> |
| <PRE> |
| public void <B>rollback</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollback()">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#rollback()">rollback</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="flush(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><!-- --></A><H3> |
| flush</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> <B>flush</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pNew, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pNewUpdated, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pNewFlushedDeleted, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pDirty, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pDeleted)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#flush(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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>AbstractStoreManager.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)</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). |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><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></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pNew</CODE> - Objects that should be added to the store, |
| and that have not previously been flushed.<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><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><CODE>pDirty</CODE> - Objects that were loaded from the data |
| store and have since been modified.<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. |
| <DT><B>Returns:</B><DD>a collection of exceptions encountered during flushing.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="executeExtent(org.apache.openjpa.meta.ClassMetaData, boolean, org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><H3> |
| executeExtent</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</A> <B>executeExtent</B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> meta, |
| boolean subclasses, |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#executeExtent(org.apache.openjpa.meta.ClassMetaData, boolean, org.apache.openjpa.kernel.FetchConfiguration)">AbstractStoreManager</A></CODE></B></DD> |
| <DD>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>AbstractStoreManager.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>AbstractStoreManager.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>AbstractStoreManager.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>AbstractStoreManager.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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html#executeExtent(org.apache.openjpa.meta.ClassMetaData, boolean, org.apache.openjpa.kernel.FetchConfiguration)">executeExtent</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/abstractstore/AbstractStoreManager.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreManager</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLStoreManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/xmlstore/XMLStore.html" title="class in org.apache.openjpa.xmlstore"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/xmlstore/XMLStoreManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="XMLStoreManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.openjpa.abstractstore.AbstractStoreManager">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2008 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |