javax.persistence (Java EE 6 ) (original) (raw)

Annotation Types Summary

Access

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.

AssociationOverride

Used to override a mapping for an entity relationship.

AssociationOverrides

Used to override mappings of multiple relationship properties or fields.

AttributeOverride

Used to override the mapping of a Basic (whether explicit or default) property or field or Id property or field.

AttributeOverrides

Used to override mappings of multiple properties or fields.

Basic

The simplest type of mapping to a database column.

Cacheable

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.

CollectionTable

Specifies the table that is used for the mapping of collections of basic or embeddable types.

Column

Is used to specify the mapped column for a persistent property or field.

ColumnResult

References name of a column in the SELECT clause of a SQL query - i.e., column alias, if applicable.

DiscriminatorColumn

Specifies the discriminator column for the SINGLE_TABLE and JOINED Inheritance mapping strategies.

DiscriminatorValue

Specifies the value of the discriminator column for entities of the given type.

ElementCollection

Defines a collection of instances of a basic type or embeddable class.

Embeddable

Defines a class whose instances are stored as an intrinsic part of an owning entity and share the identity of the entity.

Embedded

Specifies a persistent field or property of an entity whose value is an instance of an embeddable class.

EmbeddedId

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.

Entity

Specifies that the class is an entity.

EntityListeners

Specifies the callback listener classes to be used for an entity or mapped superclass.

EntityResult

Used to map the SELECT clause of a SQL query to an entity result.

Enumerated

Specifies that a persistent property or field should be persisted as a enumerated type.

ExcludeDefaultListeners

Specifies that the invocation of default listeners is to be excluded for the entity class (or mapped superclass) and its subclasses.

ExcludeSuperclassListeners

Specifies that the invocation of superclass listeners is to be excluded for the entity class (or mapped superclass) and its subclasses.

FieldResult

Is used to map the columns specified in the SELECT list of the query to the properties or fields of the entity class.

GeneratedValue

Provides for the specification of generation strategies for the values of primary keys.

Id

Specifies the primary key of an entity.

IdClass

Specifies a composite primary key class that is mapped to multiple fields or properties of the entity.

Inheritance

Defines the inheritance strategy to be used for an entity class hierarchy.

JoinColumn

Specifies a column for joining an entity association or element collection.

JoinColumns

Defines mapping for composite foreign keys.

JoinTable

Used in the mapping of associations.

Lob

Specifies that a persistent property or field should be persisted as a large object to a database-supported large object type.

ManyToMany

Defines a many-valued association with many-to-many multiplicity.

ManyToOne

Defines a single-valued association to another entity class that has many-to-one multiplicity.

MapKey

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.

MapKeyClass

Specifies the type of the map key for associations of typejava.util.Map.

MapKeyColumn

Specifies the mapping for the key column of a map whose map key is a basic type.

MapKeyEnumerated

Specifies the enum type for a map key whose basic type is an enumerated type.

MapKeyJoinColumn

Specifies a mapping to an entity that is a map key.

MapKeyJoinColumns

Supports composite map keys that reference entities.

MapKeyTemporal

This annotation must be specified for persistent map keys of type Date and Calendar.

MappedSuperclass

Designates a class whose mapping information is applied to the entities that inherit from it.

MapsId

Designates a ManyToOne orOneToOne 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.

NamedNativeQueries

Used to specify multiple native SQL named queries.

NamedNativeQuery

Specifies a named native SQL query.

NamedQueries

Specifies multiple named Java Persistence query language queries.

NamedQuery

Specifies a static, named query in the Java Persistence query language.

OneToMany

Defines a many-valued association with one-to-many multiplicity.

OneToOne

Defines a single-valued association to another entity that has one-to-one multiplicity.

OrderBy

Specifies the ordering of the elements of a collection valued association or element collection at the point when the association or collection is retrieved.

OrderColumn

Specifies a column that is used to maintain the persistent order of a list.

PersistenceContext

Expresses a dependency on a container-managed EntityManager and its associated persistence context.

PersistenceContexts

Declares one or more PersistenceContext annotations.

PersistenceProperty

Describes a single container or persistence provider property.

PersistenceUnit

Expresses a dependency on an EntityManagerFactory and its associated persistence unit.

PersistenceUnits

Declares one or more PersistenceUnit annotations.

PostLoad

Is used to specify callback methods for the corresponding lifecycle event.

PostPersist

Is used to specify callback methods for the corresponding lifecycle event.

PostRemove

Is used to specify callback methods for the corresponding lifecycle event.

PostUpdate

Is used to specify callback methods for the corresponding lifecycle event.

PrePersist

Is used to specify callback methods for the corresponding lifecycle event.

PreRemove

Is used to specify callback methods for the corresponding lifecycle event.

PreUpdate

Is used to specify callback methods for the corresponding lifecycle event.

PrimaryKeyJoinColumn

Specifies a primary key column that is used as a foreign key to join to another table.

PrimaryKeyJoinColumns

Groups PrimaryKeyJoinColumn annotations.

QueryHint

Used to supply a query property or hint to the NamedQuery or NamedNativeQuery annotation.

SecondaryTable

Specifies a secondary table for the annotated entity class.

SecondaryTables

Specifies multiple secondary tables for an entity.

SequenceGenerator

Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation.

SqlResultSetMapping

Specifies the mapping of the result of a native SQL query.

SqlResultSetMappings

Is used to define one or more SqlResultSetMapping annotations.

Table

Specifies the primary table for the annotated entity.

TableGenerator

Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation.

Temporal

This annotation must be specified for persistent fields or properties of type java.util.Date and java.util.Calendar.

Transient

Specifies that the property or field is not persistent.

UniqueConstraint

Specifies that a unique constraint is to be included in the generated DDL for a primary or secondary table.

Version

Specifies the version field or property of an entity class that serves as its optimistic lock value.

Scripting on this page tracks web page traffic, but does not change the content in any way.