All Classes and Interfaces
Class
Description
The
AbstractQuery
interface defines functionality that is common
to both top-level queries and subqueries.Used to specify an access type to be applied to an entity class,
mapped superclass, or embeddable class, or to a specific attribute
of such a class.
Used with the
Access
annotation to specify an access
type to be applied to an entity class, mapped superclass, or
embeddable class, or to a specific attribute of such a class.Used to override a mapping for an entity relationship.
Used to override mappings of multiple relationship properties or fields.
Represents an attribute of a Java type.
A class that implements this interface can be used to convert
entity attribute state into database column representation
and back again.
Represents an attribute node of an entity graph.
Used to override the mapping of a
Basic
(whether
explicit or default) property or field or Id
property or
field.Used to override mappings of multiple properties or fields.
The simplest type of mapping to a database column.
Instances of the type
BasicType
represent basic types (including
temporal and enumerated types).Instances of the type
Bindable
represent object or attribute types
that can be bound into a Path
.Interface used to interact with the second-level cache.
Specifies whether an entity should be cached if caching is enabled
when the value of the
persistence.xml
caching element
is ENABLE_SELECTIVE
or DISABLE_SELECTIVE
.Used as the value of the
javax.persistence.cache.retrieveMode
property to
specify the behavior when data is retrieved by the
find
methods and by queries.Used as the value of the
javax.persistence.cache.storeMode
property to specify
the behavior when data is read from the database and when data is
committed into the database.Defines the set of cascadable operations that are propagated
to the associated entity.
A persistence provider supplies an instance of this
interface to the
PersistenceUnitInfo.addTransformer
method.Instances of the type
CollectionAttribute
represent persistent
java.util.Collection
-valued attributes.The
CollectionJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Collection
.Specifies the table that is used for the mapping of
collections of basic or embeddable types.
Specifies the mapped column for a persistent property or field.
Used in conjunction with the
SqlResultSetMapping
annotation or
ConstructorResult
annotation to map a column of the SELECT
list of a SQL query.The
CommonAbstractCriteria
interface defines functionality
that is common to both top-level criteria queries and subqueries as
well as to update and delete criteria operations.The
CompoundSelection
interface defines a compound selection item
(tuple, array, or result of constructor).Used to control the application of a constraint.
Used in conjunction with the
SqlResultSetMapping
annotation to map the SELECT
clause of a SQL query to a constructor.Specifies the conversion of a Basic field or property.
Specifies that the annotated class is a converter and defines its
scope.
Used to group
Convert
annotations.Used to construct criteria queries, compound selections,
expressions, predicates, orderings.
Interface used to build general case expressions.
Interface used to build coalesce expressions.
Interface used to build in predicates.
Interface used to build simple case expressions.
Used to specify how strings are trimmed.
The
CriteriaDelete
interface defines functionality for performing
bulk delete operations using the Criteria APIThe
CriteriaQuery
interface defines functionality that is specific
to top-level queries.The
CriteriaUpdate
interface defines functionality for performing
bulk update operations using the Criteria API.Defines supported types of the discriminator column.
Specifies the value of the discriminator column for
entities of the given type.
Specifies a collection of instances of a basic type or embeddable
class.
Specifies a class whose instances are stored as an intrinsic
part of an owning entity and share the identity of the entity.
Instances of the type
EmbeddableType
represent embeddable types.Specifies a persistent field or property of an entity whose
value is an instance of an embeddable class.
Applied to a persistent field or property of an entity
class or mapped superclass to denote a composite primary
key that is an embeddable class.
Specifies that the class is an entity.
Thrown by the persistence provider when
EntityManager.persist(Object)
is called and the entity already exists.This type represents the root of an entity graph that will be used
as a template to define the attribute nodes and boundaries of a
graph of entities and entity relationships.
Specifies the callback listener classes to be used for an
entity or mapped superclass.
Interface used to interact with the persistence context.
Interface used to interact with the entity manager factory
for the persistence unit.
Thrown by the persistence provider when an entity reference obtained by
EntityManager.getReference
is accessed but the entity does not exist.Used in conjunction with the
SqlResultSetMapping
annotation to map the SELECT
clause of a SQL query to an entity result.Interface used to control transactions on resource-local entity
managers.
Instances of the type
EntityType
represent entity types.Specifies that a persistent property or field should be persisted
as a enumerated type.
Defines mapping for enumerated types.
Specifies that the invocation of default listeners is
to be excluded for the entity class (or mapped superclass)
and its subclasses.
Specifies that the invocation of superclass listeners is
to be excluded for the entity class (or mapped superclass)
and its subclasses.
Type for query expressions.
Represents a join-fetched association or attribute.
Represents an element of the from clause which may
function as the parent of Fetches.
Defines strategies for fetching data from the database.
Used in conjunction with the
EntityResult
annotation to map columns specified
in the SELECT list of a SQL query to the properties or fields of an entity class.Flush mode setting.
Used to specify the handling of foreign key constraints when schema
generation is in effect.
Represents a bound type, usually an entity that appears in
the from clause, but may also be an embeddable belonging to
an entity in the from clause.
Provides for the specification of generation strategies for the
values of primary keys.
Defines the types of primary key generation strategies.
Specifies the primary key of an entity.
Specifies a composite primary key class that is mapped to
multiple fields or properties of the entity.
Instances of the type
IdentifiableType
represent entity or
mapped superclass types.Used in schema generation to specify creation of an index.
Specifies the inheritance strategy to be used for an entity class
hierarchy.
Defines inheritance strategy options.
A join to an entity, embeddable, or basic type.
Specifies a column for joining an entity association or element
collection.
Specifies the mapping for composite foreign keys.
Specifies the mapping of associations.
Defines the three types of joins.
Instances of the type
ListAttribute
represent persistent
javax.util.List
-valued attributes.The
ListJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.List
.Load states returned by the
ProviderUtil
SPI methods.Specifies that a persistent property or field should be persisted
as a large object to a database-supported large object type.
Lock modes can be specified by means of passing a
LockModeType
argument to one of the EntityManager
methods that take locks
(lock
, find
, or refresh
) or
to the Query.setLockMode()
or
TypedQuery.setLockMode()
method.Thrown by the persistence provider when an pessimistic locking
conflict occurs that does not result in transaction rollback.
Instances of the type
ManagedType
represent entity, mapped
superclass, and embeddable types.Specifies a many-valued association with many-to-many multiplicity.
Specifies a single-valued association to another entity class that
has many-to-one multiplicity.
Instances of the type
MapAttribute
represent
persistent java.util.Map
-valued attributes.The
MapJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Map
.Specifies the map key for associations of type
java.util.Map
when the map key is itself the primary
key or a persistent field or property of the entity that is
the value of the map.Specifies the type of the map key for associations of type
java.util.Map
.Specifies the mapping for the key column of a map whose
map key is a basic type.
Specifies the enum type for a map key whose basic type is an enumerated type.
Specifies a mapping to an entity that is a map key.
Supports composite map keys that reference entities.
Designates a class whose mapping information is applied
to the entities that inherit from it.
Instances of the type
MappedSuperclassType
represent mapped
superclass types.Designates a
ManyToOne
or
OneToOne
relationship attribute that provides the
mapping for an EmbeddedId
primary key, an attribute within
an EmbeddedId
primary key, or a simple primary key of
the parent entity.Provides access to the metamodel of persistent
entities in the persistence unit.
A
NamedAttributeNode
is a member element of a
NamedEntityGraph
.Used to specify the path and boundaries for a find operation or query.
Used to group
NamedEntityGraph
annotations.Specifies multiple native SQL named queries.
Specifies a named native SQL query.
Specifies multiple named Jakarta Persistence query language queries.
Specifies a static, named query in the Jakarta Persistence query language.
Specifies multiple named stored procedure queries.
Specifies and names a stored procedure, its parameters, and its result type.
A
NamedSubgraph
is a member element of a
NamedEntityGraph
.Thrown by the persistence provider when
Query.getSingleResult()
or TypedQuery.getSingleResult()
is executed on a
query and there is more than one result from the query.Thrown by the persistence provider when
Query.getSingleResult()
or TypedQuery.getSingleResult()
is executed on a query
and there is no result to return.Specifies a many-valued association with one-to-many multiplicity.
Specifies a single-valued association to another entity that has
one-to-one multiplicity.
Thrown by the persistence provider when an optimistic locking conflict
occurs.
An object that defines an ordering over the query results.
Specifies the ordering of the elements of a collection valued
association or element collection at the point when the association
or collection is retrieved.
Specifies a column that is used to maintain the persistent order of
a list.
Type for query parameter objects.
Type of criteria query parameter expressions.
Specifies the mode of a parameter of a stored procedure query.
Represents a simple or compound attribute path from a
bound type or collection, and is a "primitive" expression.
Bootstrap class that is used to obtain an
EntityManagerFactory
in Java SE environments.Implementation of PersistenceUtil interface
Expresses a dependency on a container-managed
EntityManager
and its
associated persistence context.Declares one or more
PersistenceContext
annotations.Specifies whether a transaction-scoped or extended
persistence context is to be used in
PersistenceContext
.Thrown by the persistence provider when a problem occurs.
Describes a single container or persistence provider property.
Interface implemented by the persistence provider.
Determine the list of persistence providers available in the
runtime environment.
Holds the global
PersistenceProviderResolver
instance.Default provider resolver class to use when none is explicitly set.
The common interface to get a CacheKey implemented by
LoaderReference and PersistenceProviderReference.
Expresses a dependency on an
EntityManagerFactory
and its
associated persistence unit.Interface implemented by the container and used by the
persistence provider when creating an
EntityManagerFactory
.Declares one or more
PersistenceUnit
annotations.Specifies whether entity managers created by the
EntityManagerFactory
will be JTA or
resource-local entity managers.Utility interface between the application and the persistence
provider managing the persistence unit.
Utility interface between the application and the persistence
provider(s).
Thrown by the persistence provider when an pessimistic locking conflict
occurs.
Defines the values of the
javax.persistence.lock.scope
property for pessimistic locking.Instances of the type
PluralAttribute
represent
persistent collection-valued attributes.The
PluralJoin
interface defines functionality
that is common to joins to all collection types.Specifies a callback method for the corresponding
lifecycle event.
Specifies a callback method for the corresponding
lifecycle event.
Specifies a callback method for the corresponding
lifecycle event.
Specifies a callback method for the corresponding
lifecycle event.
The type of a simple or compound predicate: a conjunction or
disjunction of restrictions.
Specifies a callback method for the corresponding
lifecycle event.
Specifies a callback method for the corresponding
lifecycle event.
Specifies a callback method for the corresponding
lifecycle event.
Specifies a primary key column that is used as a foreign key to
join to another table.
Groups
PrimaryKeyJoinColumn
annotations.Utility interface implemented by the persistence provider.
Interface used to control query execution.
Used to supply a query property or hint to the
NamedQuery
or NamedNativeQuery
annotation.Thrown by the persistence provider when a query times out
and only the statement is rolled back.
Thrown by the persistence provider when
EntityTransaction.commit()
fails.A root type in the from clause.
Specifies a secondary table for the annotated entity
class.
Specifies multiple secondary tables for an entity.
The
Selection
interface defines an item that is to be
returned in a query result.Defines a primary key generator that may be referenced by name when
a generator element is specified for the
GeneratedValue
annotation.Used to group
SequenceGenerator
annotations.Instances of the type
SetAttribute
represent
persistent java.util.Set
-valued attributes.The
SetJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Set
.Specifies how the provider must use a second-level cache for the
persistence unit.
Instances of the type
SingularAttribute
represents persistent
single-valued properties or fields.Specifies the mapping of the result of a native SQL query or stored
procedure.
Is used to define one or more
SqlResultSetMapping
annotations.The
StaticMetamodel
annotation specifies that the class
is a metamodel class that represents the entity, mapped
superclass, or embeddable class designated by the value
element.Specifies a parameter of a named stored procedure query.
Interface used to control stored procedure query execution.
This type represents a subgraph for an attribute node that
corresponds to a Managed Type.
The
Subquery
interface defines functionality that is
specific to subqueries.Specifies whether the persistence context is always automatically
synchronized with the current transaction or whether the persistence context
must be explicitly joined to the current transaction by means of the
EntityManager.joinTransaction()
method.Specifies the primary table for the annotated entity.
Defines a primary key generator that may be
referenced by name when a generator element is specified for
the
GeneratedValue
annotation.Used to group
TableGenerator
annotations.This annotation must be specified for persistent fields
or properties of type
java.util.Date
and
java.util.Calendar
.Type used to indicate a specific mapping of
java.util.Date
or java.util.Calendar
.Thrown by the persistence provider when a transaction is required but is not
active.
Specifies that the property or field is not persistent.
Interface for extracting the elements of a query result tuple.
The
TupleElement
interface defines an element that is returned in
a query result tuple.Instances of the type
Type
represent persistent object
or attribute types.Interface used to control the execution of typed queries.
Specifies that a unique constraint is to be included in
the generated DDL for a primary or secondary table.
The validation mode to be used by the provider for the persistence
unit.
Specifies the version field or property of an entity class that
serves as its optimistic lock value.