Package org.apache.openjpa.persistence

OpenJPA JPA

This package provides an JPA facade to OpenJPA. All major OpenJPA runtime components have JPA-flavored facades in this package.

Interface Summary

Interface	Description
Extent<T>	An extent is a logical view of all instances of a class.
FetchPlan	The fetch plan allows you to dynamically alter eager fetching configuration and other aspects of data loading.
Generator	Represents a store sequence.
HintValueConverter	Converts a given user-specified value to a target type consumable by the kernel.
OpenJPAEntityManager	Interface implemented by OpenJPA entity managers.
OpenJPAEntityManagerFactory	Interface implemented by OpenJPA entity manager factories.
OpenJPAEntityManagerFactorySPI
OpenJPAEntityManagerSPI
OpenJPAEntityTransaction	Extension of the JPA EntityTransaction interface.
OpenJPAEnum<E extends java.lang.Enum<?>>	An interface to define conversion of a facade based enum to a kernel integer constant.
OpenJPAQuery<X>	Interface implemented by OpenJPA queries.
OpenJPAQuerySPI<X>
QueryResultCache	Query result cache.
StoreCache	Represents the L2 cache over the data store.

Class Summary

Class	Description
AbstractQuery<X>	An abstract implementation of the Query interface.
AnnotationBuilder	Helper class to stringify annotation declarations.
AnnotationPersistenceMetaDataParser	Persistence annotation metadata parser.
AnnotationPersistenceMetaDataSerializer	Serializes persistence metadata as annotations.
AnnotationPersistenceXMLMetaDataParser	JAXB xml annotation metadata parser.
EntityManagerFactoryImpl	Implementation of EntityManagerFactory that acts as a facade to a BrokerFactory.
EntityManagerFactoryValue	Plugin type used to represent the EntityManagerFactory.
EntityManagerImpl	Implementation of EntityManager interface.
ExtentImpl<T>	An extent is a logical view of all instances of a class.
FetchPlanImpl	Implements FetchPlan via delegation to FetchConfiguration.
GeneratorImpl	Represents a store sequence.
HintHandler	Manages query hint keys and handles their values on behalf of a owning QueryImpl.
HintValueConverter.EnumToInteger	Convert the enum value to an enumerated set of constants.
HintValueConverter.OpenJPAEnumToInteger	Converts an OpenJPA specific enum to an equivalent kernel constant.
HintValueConverter.StringToBoolean
HintValueConverter.StringToInteger	Converts a String to an integer.
JPAFacadeHelper	Helper class for switching between OpenJPA's JPA facade and the underlying Broker kernel.
JPAProperties	Enumerates configuration property keys defined in JPA 2.0 Specification.
LockScopesHelper	Helper methods translate between JPA-defined pessimistic lock scope and OpenJPA internal lock scope levels.
MixedLockLevelsHelper	Helper methods translate between JPA-defined lock mode and OpenJPA internal lock levels.
OpenJPAPersistence	Static helper methods for JPA users.
OpenJPAPersistenceUtil
ParameterImpl<T>	A user-defined parameter of a query.
PersistenceExceptions	Converts from OpenJPA to persistence exception types.
PersistenceMetaDataDefaults	JPA-based metadata defaults.
PersistenceMetaDataFactory	MetaDataFactory for JPA metadata.
PersistenceProductDerivation	Sets JPA specification defaults and parses JPA specification XML files.
PersistenceProductDerivation.ConfigurationParser	SAX handler capable of parsing an JPA persistence.xml file.
PersistenceProductDerivation.ConfigurationProviderImpl	Custom configuration provider.
PersistenceProviderImpl	Bootstrapping class that allows the creation of a stand-alone EntityManager.
PersistenceUnitInfoImpl	Implementation of the PersistenceUnitInfo interface used by OpenJPA when parsing persistence configuration information.
PersistenceUnitInfoImpl.ClassResolverImpl	Simple class resolver built around the persistence unit loader.
QueryImpl<X>	Implementation of Query interface.
QueryResultCacheImpl	Implements Query result cache via delegation to QueryCache.
StoreCacheImpl	Implements the L2 cache over the data store via delegation to DataCache.
StoredProcedureQueryImpl	Implements Store Procedure based query for JPA facade.
TupleFactory	A factory for tuples such that all instances created by a factory instance share the same TupleElements to save memory consumption.
TupleImpl	Tuple holds a set of values corresponding to a set of TupleElement.
XMLPersistenceMetaDataParser	Custom SAX parser used by the system to quickly parse persistence metadata files.
XMLPersistenceMetaDataSerializer	Serializes persistence metadata back to XML.

Enum Summary

Enum	Description
AutoClearType	The possible settings for the auto-clear behavior of an OpenJPAEntityManager.
AutoDetachType	The possible settings for the auto-detach behavior of an OpenJPAEntityManager.
CallbackMode	The possible settings for the callback behavior of an OpenJPAEntityManager.
ConnectionRetainMode	The possible values for use when configuring the connection retain behavior for an OpenJPAEntityManager.
DetachStateType	The possible settings for the detachment behavior of an OpenJPAEntityManager.
MetaDataTag	Set of metadata tags used in JPA.
PersistenceStrategy	Set of field persistence strategies used in JPA.
QueryOperationType	The possible operations that a query can perform.
RestoreStateType	The possible settings for the restore behavior after transaction rollback of an OpenJPAEntityManager.
UpdateAction	Action to take when a field's value is changed.
XMLPersistenceMetaDataParser.localDBIdentifiers

Exception Summary

Exception	Description
ArgumentException	Extended IllegalArgumentException.
EntityExistsException	Conflict with existing entity.
EntityNotFoundException	Missing entity.
InvalidStateException	Extended IllegalStateException.
LockTimeoutException	Pessimistic lock timeout violation.
NonUniqueResultException	Unique query returned multipl results.
NoResultException	Unique query returned no results.
OptimisticLockException	Optimistic concurrency violation.
PersistenceException	General persistence exception.
PessimisticLockException	Pessimistic concurrency violation.
QueryTimeoutException	Query timeout violation.
RollbackException	Rollback occurred on attempt to commit.
TransactionRequiredException	Transaction required.

Annotation Types Summary

Annotation Type	Description
DataCache	Caching characteristics for this class.
DataStoreId	Describes how to generate a value for a field.
Dependent	Dependent field marker.
DetachedState	Detached state.
ElementDependent	Dependent array, collection, or map element marker.
ElementType	Indicates the persistent element type of an array, collection, or map field, if different than the declared element type.
Externalizer	Declares a method that transforms the field value to its datastore equivalent.
ExternalValues	Maps field values to their datastore equivalents.
Factory	Declares a method that transforms the datastore value to its field equivalent.
FetchAttribute	Includes a persistent attribute in a FetchGroup.
FetchGroup	Fetch group definition.
FetchGroups	Fetch groups holder.
InverseLogical	Declares the logical inverse of a field.
KeyDependent	Dependent map key marker.
KeyType	Indicates the persistent key type of a map field, if different than the declared type.
LoadFetchGroup	Fetch group loaded when the annotated field/property is loaded.
LRS	Large result set field marker.
ManagedInterface	The annotated interface should be treated as a managed interface by OpenJPA.
Persistent	Metadata annotation for a persistent field.
PersistentCollection	Metadata annotation for a persistent collection field.
PersistentMap	Metadata annotation for a persistent map field.
ReadOnly	Marks a field read-only.
Type	Indicates the persistent type of a field, if different than the declared type.