blob: b650e2f0273e385ccd013abd1df0e02371e406cc [file] [log] [blame]
<!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_15) on Thu Jul 17 13:34:41 CDT 2008 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
org.apache.openjpa.persistence (OpenJPA 1.0.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.openjpa.persistence package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="org.apache.openjpa.persistence (OpenJPA 1.0.3 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>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/openjpa/meta/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/openjpa/persistence/jdbc/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/openjpa/persistence/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.apache.openjpa.persistence
</H2>
<strong>OpenJPA JPA</strong>
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Extent.html" title="interface in org.apache.openjpa.persistence">Extent&lt;T&gt;</A></B></TD>
<TD>An extent is a logical view of all instances of a class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></B></TD>
<TD>The fetch plan allows you to dynamically alter eager fetching
configuration and other aspects of data loading.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Generator.html" title="interface in org.apache.openjpa.persistence">Generator</A></B></TD>
<TD>Represents a store sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityManager</A></B></TD>
<TD>Interface implemented by OpenJPA entity managers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityManagerFactory</A></B></TD>
<TD>Interface implemented by OpenJPA entity manager factories.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManagerFactorySPI.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityManagerFactorySPI</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManagerSPI.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityManagerSPI</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityTransaction.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityTransaction</A></B></TD>
<TD>Extension of the JPA <A HREF="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityTransaction.html" title="class or interface in javax.persistence"><CODE>EntityTransaction</CODE></A> interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</A></B></TD>
<TD>Interface implemented by OpenJPA queries.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuerySPI</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/QueryResultCache.html" title="interface in org.apache.openjpa.persistence">QueryResultCache</A></B></TD>
<TD>Query result cache.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/StoreCache.html" title="interface in org.apache.openjpa.persistence">StoreCache</A></B></TD>
<TD>Represents the L2 cache over the data store.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/AnnotationBuilder.html" title="class in org.apache.openjpa.persistence">AnnotationBuilder</A></B></TD>
<TD>Helper class to stringify annotation declarations.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.html" title="class in org.apache.openjpa.persistence">AnnotationPersistenceMetaDataParser</A></B></TD>
<TD>Persistence annotation metadata parser.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/AnnotationPersistenceMetaDataSerializer.html" title="class in org.apache.openjpa.persistence">AnnotationPersistenceMetaDataSerializer</A></B></TD>
<TD>Serializes persistence metadata as annotations.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/AnnotationPersistenceXMLMetaDataParser.html" title="class in org.apache.openjpa.persistence">AnnotationPersistenceXMLMetaDataParser</A></B></TD>
<TD>JAXB xml annotation metadata parser.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/EntityManagerFactoryImpl.html" title="class in org.apache.openjpa.persistence">EntityManagerFactoryImpl</A></B></TD>
<TD>Implementation of <A HREF="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManagerFactory.html" title="class or interface in javax.persistence"><CODE>EntityManagerFactory</CODE></A> that acts as a
facade to a <A HREF="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel"><CODE>BrokerFactory</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/EntityManagerFactoryValue.html" title="class in org.apache.openjpa.persistence">EntityManagerFactoryValue</A></B></TD>
<TD>Plugin type used to represent the <CODE>EntityManagerFactory</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/EntityManagerImpl.html" title="class in org.apache.openjpa.persistence">EntityManagerImpl</A></B></TD>
<TD>Implementation of <A HREF="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html" title="class or interface in javax.persistence"><CODE>EntityManager</CODE></A> interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ExtentImpl.html" title="class in org.apache.openjpa.persistence">ExtentImpl&lt;T&gt;</A></B></TD>
<TD>An extent is a logical view of all instances of a class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence">FetchPlanImpl</A></B></TD>
<TD>Implements FetchPlan via delegation to FetchConfiguration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/GeneratorImpl.html" title="class in org.apache.openjpa.persistence">GeneratorImpl</A></B></TD>
<TD>Represents a store sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/JPAFacadeHelper.html" title="class in org.apache.openjpa.persistence">JPAFacadeHelper</A></B></TD>
<TD>Helper class for switching between OpenJPA's JPA facade and the underlying
Broker kernel.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OpenJPAPersistence.html" title="class in org.apache.openjpa.persistence">OpenJPAPersistence</A></B></TD>
<TD>Static helper methods for JPA users.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceExceptions.html" title="class in org.apache.openjpa.persistence">PersistenceExceptions</A></B></TD>
<TD>Converts from OpenJPA to persistence exception types.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceMetaDataDefaults.html" title="class in org.apache.openjpa.persistence">PersistenceMetaDataDefaults</A></B></TD>
<TD>JPA-based metadata defaults.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceMetaDataFactory.html" title="class in org.apache.openjpa.persistence">PersistenceMetaDataFactory</A></B></TD>
<TD><A HREF="../../../../org/apache/openjpa/meta/MetaDataFactory.html" title="interface in org.apache.openjpa.meta"><CODE>MetaDataFactory</CODE></A> for JPA metadata.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceProductDerivation.html" title="class in org.apache.openjpa.persistence">PersistenceProductDerivation</A></B></TD>
<TD>Sets JPA specification defaults and parses JPA specification XML files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceProductDerivation.ConfigurationParser.html" title="class in org.apache.openjpa.persistence">PersistenceProductDerivation.ConfigurationParser</A></B></TD>
<TD>SAX handler capable of parsing an JPA persistence.xml file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceProductDerivation.ConfigurationProviderImpl.html" title="class in org.apache.openjpa.persistence">PersistenceProductDerivation.ConfigurationProviderImpl</A></B></TD>
<TD>Custom configuration provider.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceProviderImpl.html" title="class in org.apache.openjpa.persistence">PersistenceProviderImpl</A></B></TD>
<TD>Bootstrapping class that allows the creation of a stand-alone
<A HREF="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html" title="class or interface in javax.persistence"><CODE>EntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceUnitInfoImpl.html" title="class in org.apache.openjpa.persistence">PersistenceUnitInfoImpl</A></B></TD>
<TD>Implementation of the <A HREF="http://java.sun.com/javaee/5/docs/api/javax/persistence/spi/PersistenceUnitInfo.html" title="class or interface in javax.persistence.spi"><CODE>PersistenceUnitInfo</CODE></A> interface used by OpenJPA
when parsing persistence configuration information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/QueryImpl.html" title="class in org.apache.openjpa.persistence">QueryImpl</A></B></TD>
<TD>Implementation of <A HREF="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html" title="class or interface in javax.persistence"><CODE>Query</CODE></A> interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/QueryResultCacheImpl.html" title="class in org.apache.openjpa.persistence">QueryResultCacheImpl</A></B></TD>
<TD>Implements Query result cache via delegation to QueryCache.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/StoreCacheImpl.html" title="class in org.apache.openjpa.persistence">StoreCacheImpl</A></B></TD>
<TD>Implements the L2 cache over the data store via delegation to DataCache.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/XMLPersistenceMetaDataParser.html" title="class in org.apache.openjpa.persistence">XMLPersistenceMetaDataParser</A></B></TD>
<TD>Custom SAX parser used by the system to quickly parse persistence i
metadata files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/XMLPersistenceMetaDataSerializer.html" title="class in org.apache.openjpa.persistence">XMLPersistenceMetaDataSerializer</A></B></TD>
<TD>Serializes persistence metadata back to XML.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Enum Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/AutoClearType.html" title="enum in org.apache.openjpa.persistence">AutoClearType</A></B></TD>
<TD>The possible settings for the auto-clear behavior of an
<A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence"><CODE>OpenJPAEntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/AutoDetachType.html" title="enum in org.apache.openjpa.persistence">AutoDetachType</A></B></TD>
<TD>The possible settings for the auto-detach behavior of an
<A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence"><CODE>OpenJPAEntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/CallbackMode.html" title="enum in org.apache.openjpa.persistence">CallbackMode</A></B></TD>
<TD>The possible settings for the callback behavior of an
<A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence"><CODE>OpenJPAEntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ConnectionRetainMode.html" title="enum in org.apache.openjpa.persistence">ConnectionRetainMode</A></B></TD>
<TD>The possible values for use when configuring the connection retain
behavior for an <A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence"><CODE>OpenJPAEntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/DetachStateType.html" title="enum in org.apache.openjpa.persistence">DetachStateType</A></B></TD>
<TD>The possible settings for the detachment behavior of an
<A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence"><CODE>OpenJPAEntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/MetaDataTag.html" title="enum in org.apache.openjpa.persistence">MetaDataTag</A></B></TD>
<TD>Set of metadata tags used in JPA.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceStrategy.html" title="enum in org.apache.openjpa.persistence">PersistenceStrategy</A></B></TD>
<TD>Set of field persistence strategies used in JPA.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/QueryOperationType.html" title="enum in org.apache.openjpa.persistence">QueryOperationType</A></B></TD>
<TD>The possible operations that a query can perform.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/RestoreStateType.html" title="enum in org.apache.openjpa.persistence">RestoreStateType</A></B></TD>
<TD>The possible settings for the restore behavior after transaction rollback
of an <A HREF="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence"><CODE>OpenJPAEntityManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/UpdateAction.html" title="enum in org.apache.openjpa.persistence">UpdateAction</A></B></TD>
<TD>Action to take when a field's value is changed.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ArgumentException.html" title="class in org.apache.openjpa.persistence">ArgumentException</A></B></TD>
<TD>Extended <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/EntityExistsException.html" title="class in org.apache.openjpa.persistence">EntityExistsException</A></B></TD>
<TD>Conflict with existing entity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/EntityNotFoundException.html" title="class in org.apache.openjpa.persistence">EntityNotFoundException</A></B></TD>
<TD>Missing entity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/InvalidStateException.html" title="class in org.apache.openjpa.persistence">InvalidStateException</A></B></TD>
<TD>Extended <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang"><CODE>IllegalStateException</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/NonUniqueResultException.html" title="class in org.apache.openjpa.persistence">NonUniqueResultException</A></B></TD>
<TD>Unique query returned multipl results.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/NoResultException.html" title="class in org.apache.openjpa.persistence">NoResultException</A></B></TD>
<TD>Unique query returned no results.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/OptimisticLockException.html" title="class in org.apache.openjpa.persistence">OptimisticLockException</A></B></TD>
<TD>Optimistic concurrency violation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistenceException.html" title="class in org.apache.openjpa.persistence">PersistenceException</A></B></TD>
<TD>General persistence exception.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/RollbackException.html" title="class in org.apache.openjpa.persistence">RollbackException</A></B></TD>
<TD>Rollback occurred on attempt to commit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/TransactionRequiredException.html" title="class in org.apache.openjpa.persistence">TransactionRequiredException</A></B></TD>
<TD>Transaction required.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Annotation Types Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/DataCache.html" title="annotation in org.apache.openjpa.persistence">DataCache</A></B></TD>
<TD>Caching characteristics for this class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/DataStoreId.html" title="annotation in org.apache.openjpa.persistence">DataStoreId</A></B></TD>
<TD>Describes how to generate a value for a field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Dependent.html" title="annotation in org.apache.openjpa.persistence">Dependent</A></B></TD>
<TD>Dependent field marker.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/DetachedState.html" title="annotation in org.apache.openjpa.persistence">DetachedState</A></B></TD>
<TD>Detached state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ElementDependent.html" title="annotation in org.apache.openjpa.persistence">ElementDependent</A></B></TD>
<TD>Dependent array, collection, or map element marker.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ElementType.html" title="annotation in org.apache.openjpa.persistence">ElementType</A></B></TD>
<TD>Indicates the persistent element type of an array, collection, or map
field, if different than the declared element type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Externalizer.html" title="annotation in org.apache.openjpa.persistence">Externalizer</A></B></TD>
<TD>Declares a method that transforms the field value to its datastore
equivalent.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ExternalValues.html" title="annotation in org.apache.openjpa.persistence">ExternalValues</A></B></TD>
<TD>Maps field values to their datastore equivalents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Factory.html" title="annotation in org.apache.openjpa.persistence">Factory</A></B></TD>
<TD>Declares a method that transforms the datastore value to its field
equivalent.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/FetchAttribute.html" title="annotation in org.apache.openjpa.persistence">FetchAttribute</A></B></TD>
<TD>Includes a persistent attribute in a <A HREF="../../../../org/apache/openjpa/persistence/FetchGroup.html" title="annotation in org.apache.openjpa.persistence"><CODE>FetchGroup</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/FetchGroup.html" title="annotation in org.apache.openjpa.persistence">FetchGroup</A></B></TD>
<TD>Fetch group definition.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/FetchGroups.html" title="annotation in org.apache.openjpa.persistence">FetchGroups</A></B></TD>
<TD>Fetch groups holder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/InverseLogical.html" title="annotation in org.apache.openjpa.persistence">InverseLogical</A></B></TD>
<TD>Declares the logical inverse of a field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/KeyDependent.html" title="annotation in org.apache.openjpa.persistence">KeyDependent</A></B></TD>
<TD>Dependent map key marker.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/KeyType.html" title="annotation in org.apache.openjpa.persistence">KeyType</A></B></TD>
<TD>Indicates the persistent key type of a map field, if different than the
declared type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/LoadFetchGroup.html" title="annotation in org.apache.openjpa.persistence">LoadFetchGroup</A></B></TD>
<TD>Fetch group loaded when the annotated field/property is loaded.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/LRS.html" title="annotation in org.apache.openjpa.persistence">LRS</A></B></TD>
<TD>Large result set field marker.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Persistent.html" title="annotation in org.apache.openjpa.persistence">Persistent</A></B></TD>
<TD>Metadata annotation for a persistent field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistentCollection.html" title="annotation in org.apache.openjpa.persistence">PersistentCollection</A></B></TD>
<TD>Metadata annotation for a persistent collection field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/PersistentMap.html" title="annotation in org.apache.openjpa.persistence">PersistentMap</A></B></TD>
<TD>Metadata annotation for a persistent map field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/ReadOnly.html" title="annotation in org.apache.openjpa.persistence">ReadOnly</A></B></TD>
<TD>Marks a field read-only.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/openjpa/persistence/Type.html" title="annotation in org.apache.openjpa.persistence">Type</A></B></TD>
<TD>Indicates the persistent type of a field, if different than the
declared type.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<A NAME="package_description"><!-- --></A><H2>
Package org.apache.openjpa.persistence Description
</H2>
<P>
<p><strong>OpenJPA JPA</strong></p>
<p>
This package provides an JPA facade to OpenJPA. All major OpenJPA
runtime components have JPA-flavored facades in this package.
</p>
<P>
<P>
<DL>
</DL>
<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>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/openjpa/meta/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/openjpa/persistence/jdbc/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/openjpa/persistence/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2006-2008 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>