Module org.eclipse.persistence.core
Package org.eclipse.persistence.annotations
package org.eclipse.persistence.annotations
-
ClassDescriptionAn additional criteria can be specified at the Entity or MappedSuperclass level.Array types are extended object-relational data-types supported by some databases.Deprecated.Deprecated.A BatchFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, ElementCollection, BasicCollection, BasicMap).Enum used with the BatchFetch annotation, or "eclipselink.batch.type" query hint.The Cache annotation is used to configure the EclipseLink object cache.An enum that is used within the Cache annotation.Allow a cache index to be define.Allow a set of cache indexes to be define on an Entity.A CacheInterceptor can be set on an Entity and allows all EclipseLink cache access to be intercepted by the developer provided interceptor.Configures what type of Id value is used to store the object in the cache.The CacheType enum is used with the Cache annotation for a persistent class.Define the foreign key defined by the relationship to cascade the delete on the database.The ChangeTracking annotation is used to specify the org.eclipse.persistence.descriptors.changetracking.ObjectChangePolicy which computes changes sets for EclipseLink's UnitOfWork commit process.An enum that is used within the ChangeTracking annotation.A ClassExtractor allows for a user defined class indicator in place of providing a discriminator column.A CloneCopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.CloneCopyPolicy on an Entity.Deprecated.A CompositeMember annotation is ignored unless is in composite member persistence unit.A ConversionValue annotation is used within an ObjectTypeConverter.The Convert annotation specifies that a named converter should be used with the corresponding mapped attribute.A Converter is used to customize the values during the reading from the database into the object model as well as during the writing back of changes into the database.A Converters annotation allows the definition of multiple Converter.A CopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.CopyPolicy on an Entity.The Customizer annotation is used to specify a class that implements the DescriptorCustomizer interface and is to run against an entity's class descriptor after all metadata processing has been completed.Configures what type of database change notification an entity/descriptor should use.A DeleteAll annotation is specified to indicate that when an relationship is deleted, it should use a delete all query.An enum that is used within the StoredProcedureParameter annotation.A DiscriminatorClass is used within a VariableOneToOne annotation.Specifies default mappings (those that are not explicitly decorated in XML or using annotations)should be omitted.The ExistenceChecking annotation is used to specify the type of checking EclipseLink should use when determining if an entity is new or existing.An enum that is used within the ExistenceChecking annotation.A fetch attribute is specified within a fetch group and is used as a performance enhancement that allows a group of attributes of an object to be loaded on demand, which means that the data for an attribute might not loaded from the underlying data source until an explicit access call for the attribute first occurs.A fetch group is a performance enhancement that allows a group of attributes of an object to be loaded on demand, which means that the data for an attribute might not loaded from the underlying data source until an explicit access call for the attribute first occurs.A FetchGroups annotation allows the definition of multiple FetchGroup.HashPartitioning partitions access to a database cluster by the hash of a field value from the object, such as the object's location, or tenant.IdValidation configures which id values are considered valid when loading from the database.Allow a database INDEX to be define when generating DDL.Allow a set of database indexes to be define on an Entity.An InstantiationCopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.InstantiationCopyPolicy on an Entity.A JoinFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, BasicCollection, BasicMap).An enum type that is used within the JoinFetch annotation.The MapKeyConvert annotation specifies that a named converter should be used with the corresponding mapped attribute key column.Multitenant specifies that a given entity is shared amongst multiple tenants of a given application.An enum that is used within the Multitenant annotation.A Mutable annotation can be used on a @Basic mapping.A NamedStoredFunctionQueries annotation allows the definition of multiple NamedStoredFunctionQuery.A NamedStoredFunctionQuery annotation allows the definition of queries that call stored functions as named queries.A NamedStoredProcedureQueries annotation allows the definition of multiple NamedStoredProcedureQuery.A NamedStoredProcedureQuery annotation allows the definition of queries that call stored procedures as named queries.The NonCacheable annotation is used to configure caching behavior for relationships.The ObjectTypeConverter annotation is used to specify a TopLink org.eclipse.persistence.mappings.converters.ObjectTypeConverter that converts a fixed number of database data value(s) to Java object value(s) during the reading and writing of a mapped attribute An ObjectTypeConverter must be be uniquely identified by name and can be defined at the class, field and property level and can be specified within an Entity, MappedSuperclass and Embeddable class.An ObjectTypeConverters annotation allows the definition of multiple ObjectTypeConverter.The OptimisticLocking annotation is used to specify the type of optimistic locking TopLink should use when updating or deleting entities.An enum that is used within the OptimisticLocking annotation.OrderCorrection annotation may be specified together with OrderColumn annotation.The OrderCorrectionType enum is used with OrderCorrection annotation that could be applied together with OrderColumn annotation.Partitioning is used to partition the data for a class across multiple difference databases or across a database cluster such as Oracle RAC.A Partitioning is used to partition the data for a class across multiple difference databases or across a database cluster such as Oracle RAC.PinnedPartitionPolicy pins requests to a single connection pool.The PrimaryKey annotation allows advanced configuration of the Id.A PrivateOwned annotation is used to specify a relationship is privately owned.Annotation for user defined properties.Annotation for a user defined property.Redirectors allow EclipseLink queries to be intercepted and pre/post processed or redirected.Represent a specific range partition.RangePartitioningPolicy partitions access to a database cluster by a field value from the object, such as the object's id, location, or tenant.The ReadOnly annotation is used to specify that a class is read only.Annotation for org.eclipse.persistence.mappings.TransformationMapping.ReplicationPartitioning sends requests to a set of connection pools.A ReturnInsert annotation allows for INSERT operations to return values back into the object being written.A ReturnUpdate annotation allows for UPDATE operations to return values back into the object being written.RoundRobinPartitioning sends requests in a round robin fashion to the set of connection pools.A SerializedConverter is used to serialize an object's value into a database binary, character, or XML field.A TypeConverters annotation allows the definition of multiple SerializedConverter.SerializedObject annotation is used to set an org.eclipse.persistence.descriptors.SerializedObjectPolicy on an Entity or MappedSuperClass.A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.Struct types are extended object-relational data-types supported by some databases.A StructConverter is a special type of converter that handles the conversion of a specific database Struct type.A StructConverters annotation allows the definition of multiple StructConverter.Struct types are extended object-relational data-types supported by some databases.Tenant discriminator column(s) are used with a SINGLE_TABLE multitenant strategy.A TenantDiscriminatorColumns annotation allows the definition of multiple TenantDiscriminatorColumn.A tenant table discriminator is used with a TABLE_PER_TENANT multitenant strategy.An enum that is used within the TenantTableDiscriminator annotation.A TimeOfDay annotation is used to specify a specific time of day using a Calendar instance which is to be used within an OptimisticLocking annotation.Transformation is an optional annotation for org.eclipse.persistence.mappings.TransformationMapping.PUBLIC: This class is used by our JPA annotation processing to discover which annotations may coexist with a jakarta.persistence.Transient annotation.The TypeConverter annotation is used to specify an EclipseLink org.eclipse.persistence.mappings.converters.TypeConversionConverter for modification of the data value(s) during the reading and writing of a mapped attribute.A TypeConverters annotation allows the definition of multiple TypeConverter.UnionPartitioning sends queries to all connection pools and unions the results.Defines a primary key generator that may be referenced by name when a generator element is specified for the
GeneratedValueannotation.A UuidGenerators annotation allows the definition of multiple UuidGenerator.Represent a specific value partition.ValuePartitioning partitions access to a database cluster by a field value from the object, such as the object's location, or tenant.Variable one to one mappings are used to represent a pointer references between a java object and an implementer of an interface.Specifies that this class contains virtual attributes.Annotation for org.eclipse.persistence.mappings.TransformationMapping.An optional annotation for org.eclipse.persistence.mappings.TransformationMapping.