Package org.hibernate.boot.jaxb.mapping.spi
package org.hibernate.boot.jaxb.mapping.spi
-
ClassDescriptionMaps a discriminator value to its corresponding entity name.JAXB binding interface for discriminated association based attributes (any and many-to-any)JAXB binding interface for describing the discriminator of a discriminated associationThe key of a
JaxbAnyMapping- the (logical) foreign-key valueDescribes the discriminator of a discriminated association (any, many-to-any), including the mapping of discriminator values to matching entity name <p>Java class for any-discriminator complex type</p>.See `@org.hibernate.annotations.Any` <p>Java class for hbm-any-mapping complex type</p>.Describes the "foreign key" of a discriminated association (any, many-to-any).JAXB binding interface for association attributes (to-one and plural mappings)@Repeatable(AssociationOverrides.class) @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AssociationOverride { String name(); JoinColumn[] joinColumns() default{}; ForeignKey foreignKey() default @ForeignKey(PROVIDER_DEFAULT); JoinTable joinTable() default @JoinTable; } <p>Java class for association-override complex type</p>.@Repeatable(AttributeOverrides.class) @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AttributeOverride { String name(); Column column(); } <p>Java class for attribute-override complex type</p>.JAXB binding interface for commonality between things which contain attributes.This element contains the entity field or property mappings.See `@jakarta.persistence.Basic` See `@jakarta.persistence.Lob` See `@jakarta.persistence.Temporal` See `@jakarta.persistence.Enumerated` See `@jakarta.persistence.Convert` See `@org.hibernate.annotations.Nationalized` See `@org.hibernate.annotations.OptimisticLock` See `@org.hibernate.annotations.AttributeAccessor` See `@org.hibernate.annotations.Type` See `@org.hibernate.annotations.JavaType` See `@org.hibernate.annotations.JdbcType` See `@org.hibernate.annotations.JdbcTypeCode` See `@org.hibernate.annotations.Mutability` See `@org.hibernate.annotations.Immutable` <p>Java class for basic complex type</p>.A model part that is (or can be) basic-valued - JaxbIdImpl, JaxbBasicImpl and JaxbElementCollectionImplSee @org.hibernate.annotations.Cache Used to specify Hibernate-specific extra control over the caching of entity and collection state.public enum CascadeType { ALL, PERSIST, MERGE, REMOVE, REFRESH, DETACH } <p>Java class for cascade-type complex type</p>.@Target({}) @Retention(RUNTIME) public @interface CheckConstraint { String name() default ""; String constraint(); String options() default ""; } <p>Java class for check-constraint complex type</p>.See `@org.hibernate.annotations.CollectionId` See `@org.hibernate.annotations.CollectionIdType` See `@org.hibernate.annotations.CollectionIdJavaType` See `@org.hibernate.annotations.CollectionIdJdbcType` See `@org.hibernate.annotations.CollectionIdJdbcTypeCode` <p>Java class for collection-id complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface CollectionTable { String name() default ""; String catalog() default ""; String schema() default ""; JoinColumn[] joinColumns() default {}; ForeignKey foreignKey() default @ForeignKey(ConstraintMode.PROVIDER_DEFAULT); UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; String options() default ""; } <p>Java class for collection-table complex type</p>.See `@org.hibernate.annotations.CollectionType` <p>Java class for collection-user-type complex type</p>.See @CollectionTypeRegistration <p>Java class for collection-user-type-registration complex type</p>.See `@jakarta.persistence.Column` See `@org.hibernate.annotations.Comment` See `@org.hibernate.annotations.Check` See `@org.hibernate.annotations.ColumnDefault` See `@org.hibernate.annotations.ColumnTransformer` <p>Java class for column complex type</p>.@Target({}) @Retention(RUNTIME) public @interface ColumnResult { String name(); Class<?> type() default void.class; } <p>Java class for column-result complex type</p>.See @CompositeTypeRegistration <p>Java class for composite-user-type-registration complex type</p>.Configuration parameter user-types <p>Java class for configuration-parameter complex type</p>.@Target({}) @Retention(RUNTIME) public @interface ConstructorResult { Class<?> targetClass(); ColumnResult[] columns(); } <p>Java class for constructor-result complex type</p>.@Target({TYPE}) @Retention(RUNTIME) public @interface Converter { boolean autoApply() default false; } <p>Java class for converter complex type</p>.See @ConverterRegistration <p>Java class for converter-registration complex type</p>.@Repeatable(Converts.class) @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface Convert { Class<? extends AttributeConverter> converter() default AttributeConverter.class; String attributeName() default ""; boolean disableConversion() default false; } <p>Java class for convert complex type</p>.org.hibernate.annotations.SQLInsert org.hibernate.annotations.SQLUpdate org.hibernate.annotations.SQLDelete org.hibernate.annotations.SQLDeleteAll <p>Java class for custom-sql complex type</p>.<p>Java class for database-object complex type</p>.<p>Java class for anonymous complex type</p>.<p>Java class for database-object-scope complex type</p>.@Target({TYPE}) @Retention(RUNTIME) public @interface DiscriminatorColumn { String name() default "DTYPE"; DiscriminatorType discriminatorType() default STRING; String columnDefinition() default ""; String options() default ""; int length() default 31; } <p>Java class for discriminator-column complex type</p>.@interface DiscriminatorFormula { /** The fragment */ String value(); DiscriminatorType discriminatorType() default STRING; } @interface DiscriminatorOptions { boolean force() default false; ...Mapping of a discriminator value to the corresponding entity-name@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ElementCollection { Class<?> targetClass() default void.class; FetchType fetch() default FetchType.LAZY; } <p>Java class for element-collection complex type</p>.<p>Java class for embeddable-attributes complex type</p>.See `@jakarta.persistence.Embeddable` <p>Java class for embeddable complex type</p>.See @EmbeddableInstantiatorRegistration <p>Java class for embeddable-instantiator-registration complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface EmbeddedId {} <p>Java class for embedded-id complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Embedded {} <p>Java class for embedded complex type</p>.A model part that is (or can be) embeddable-valued (composite) - JaxbEmbeddedIdImpl, JaxbEmbeddedIdImpl and JaxbElementCollectionImpl<p>Java class for emptyType complex type</p>.Defines the settings and mappings for an entity.@Target({TYPE}) @Retention(RUNTIME) public @interface EntityListeners { Class<?>[] value(); } <p>Java class for entity-listeners complex type</p>.Defines an entity listener to be invoked at lifecycle events for the entities that list this listener.The entity-mappings element is the root element of a mapping file.JAXB binding interface for commonality between entity and mapped-superclass mappings@Target({}) @Retention(RUNTIME) public @interface EntityResult { Class<?> entityClass(); LockModeType lockMode() default LockModeType.OPTIMISTIC; FieldResult[] fields() default {}; String discriminatorColumn() default ""; } <p>Java class for entity-result complex type</p>.<p>Java class for fetch-profile complex type</p>.<p>Java class for anonymous complex type</p>.@Target({}) @Retention(RUNTIME) public @interface FieldResult { String name(); String column(); } <p>Java class for field-result complex type</p>.Specifies a filter definition.Used to identify all bind parameters in the condition element @interface ParamDef { String name(); Class<?> type(); Class<? extends Supplier> resolver() default Supplier.class; } <p>Java class for anonymous complex type</p>.Applies a filter defined by hbm-filter-def usage <p>Java class for filter complex type</p>.<p>Java class for anonymous complex type</p>.@Target({}) @Retention(RUNTIME) public @interface ForeignKey { String name() default ""; ConstraintMode value() default CONSTRAINT; String foreign-key-definition() default ""; String options() default ""; } Note that the elements that embed the use of the annotation default this use as @ForeignKey(PROVIDER_DEFAULT).@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface GeneratedValue { GenerationType strategy() default AUTO; String generator() default ""; } <p>Java class for generated-value complex type</p>.Names a org.hibernate.id.IdentifierGenerator implementation (class attribute) as well as any configuration information need by the implementation (Hibernate will pass it the parameters after instantiation).<p>Java class for hql-import complex type</p>.@Target({TYPE}) @Retention(RUNTIME) public @interface IdClass { Class<?> value(); } <p>Java class for id-class complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Id {} <p>Java class for id complex type</p>.@Target({}) @Retention(RUNTIME) public @interface Index { String name() default ""; String columnList(); boolean unique() default false; String options() default ""; } <p>Java class for index complex type</p>.@Target({TYPE}) @Retention(RUNTIME) public @interface Inheritance { InheritanceType strategy() default InheritanceType.SINGLE_TABLE; } <p>Java class for inheritance complex type</p>.See @JavaTypeRegistration <p>Java class for java-type-registration complex type</p>.See @JdbcTypeRegistration <p>Java class for jdbc-type-registration complex type</p>.@Repeatable(JoinColumns.class) @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface JoinColumn { String name() default ""; String referencedColumnName() default ""; boolean unique() default false; boolean nullable() default true; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; String options() default ""; String table() default ""; ForeignKey foreignKey() default @ForeignKey(); CheckConstraint[] check() default {}; String comment() default ""; } <p>Java class for join-column complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface JoinTable { String name() default ""; String catalog() default ""; String schema() default ""; JoinColumn[] joinColumns() default {}; JoinColumn[] inverseJoinColumns() default {}; ForeignKey foreignKey() default @ForeignKey(ConstraintMode.PROVIDER_DEFAULT); ForeignKey inverseForeignKey() default @ForeignKey(ConstraintMode.PROVIDER_DEFAULT); UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; CheckConstraint[] check() default {}; String comment() default ""; String options() default ""; } <p>Java class for join-table complex type</p>.JAXB binding interface for lifecycle callbacks.JAXB binding interface for commonality between things which allow callback declarations.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Lob {} <p>Java class for lob complex type</p>.Non-id, non-version singular attributeCommon interface for JAXB bindings representing entities, mapped-superclasses and embeddables (JPA collective calls these "managed types" in terms of its Metamodel api).@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToMany { Class<?> targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default FetchType.LAZY; String mappedBy() default ""; } <p>Java class for many-to-many complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToOne { Class<?> targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default FetchType.EAGER; boolean optional() default true; } <p>Java class for many-to-one complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKeyClass { Class<?> value(); } <p>Java class for map-key-class complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKeyColumn { String name() default ""; boolean unique() default false; boolean nullable() default false; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; String options() default ""; String table() default ""; int length() default 255; int precision() default 0; // decimal precision int scale() default 0; // decimal scale } <p>Java class for map-key-column complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKey { String name() default ""; } <p>Java class for map-key complex type</p>.@Repeatable(MapKeyJoinColumns.class) @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKeyJoinColumn { String name() default ""; String referencedColumnName() default ""; boolean unique() default false; boolean nullable() default false; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; String options() default ""; String table() default ""; ForeignKey foreignKey() default @ForeignKey(ConstraintMode.PROVIDER_DEFAULT); } <p>Java class for map-key-join-column complex type</p>.Defines the settings and mappings for a mapped superclass.See `@org.hibernate.annotations.TenantId` <p>Java class for multi-tenancy complex type</p>.@Target({}) @Retention(RUNTIME) public @interface NamedAttributeNode { String value(); String subgraph() default ""; String keySubgraph() default ""; } <p>Java class for named-attribute-node complex type</p>.@Repeatable(NamedEntityGraphs.class) @Target({TYPE}) @Retention(RUNTIME) public @interface NamedEntityGraph { String name() default ""; NamedAttributeNode[] attributeNodes() default {}; boolean includeAllAttributes() default false; NamedSubgraph[] subgraphs() default {}; NamedSubGraph[] subclassSubgraphs() default {}; } <p>Java class for named-entity-graph complex type</p>.@Repeatable(NamedQueries.class) @Target({TYPE}) @Retention(RUNTIME) public @interface NamedQuery { String name(); String query(); LockModeType lockMode() default LockModeType.NONE; QueryHint[] hints() default {}; } <p>Java class for named-query complex type</p>.@Repeatable(NamedNativeQueries.class) @Target({TYPE}) @Retention(RUNTIME) public @interface NamedNativeQuery { String name(); String query(); QueryHint[] hints() default {}; Class<?> resultClass() default void.class; String resultSetMapping() default ""; //named SqlResultSetMapping EntityResult[] entities() default {}; ConstructorResult[] classes() default {}; ColumnResult[] columns() default {}; } <p>Java class for named-native-query complex type</p>.@Repeatable(NamedStoredProcedureQueries.class) @Target({TYPE}) @Retention(RUNTIME) public @interface NamedStoredProcedureQuery { String name(); String procedureName(); StoredProcedureParameter[] parameters() default {}; Class[] resultClasses() default {}; String[] resultSetMappings() default{}; QueryHint[] hints() default {}; } <p>Java class for named-stored-procedure-query complex type</p>.@Target({}) @Retention(RUNTIME) public @interface NamedSubgraph { String name(); Class<?> type() default void.class; NamedAttributeNode[] attributeNodes(); } <p>Java class for named-subgraph complex type</p>.See `@org.hibernate.annotations.Nationalized` <p>Java class for nationalized complex type</p>.JAXB binding interface for natural-id definitionsSee `@org.hibernate.annotations.NaturalId` <p>Java class for natural-id complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToMany { Class<?> targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default FetchType.LAZY; String mappedBy() default ""; boolean orphanRemoval() default false; } <p>Java class for one-to-many complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToOne { Class<?> targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default FetchType.EAGER; boolean optional() default true; String mappedBy() default ""; boolean orphanRemoval() default false; } <p>Java class for one-to-one complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OrderColumn { String name() default ""; boolean nullable() default true; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; String options() default ""; } <p>Java class for order-column complex type</p>.These defaults are applied to the persistence unit as a whole unless they are overridden by local annotation or XML element settings.Metadata that applies to the persistence unit and not just to the mapping file in which it is contained.Common interface for JAXB bindings that represent persistent attributes.See `@org.hibernate.annotations.ManyToAny` <p>Java class for hbm-many-to-any complex type</p>.<p>Java class for anonymous complex type</p>.JAXB binding interface for plural attributesorg.hibernate.FetchMode enum values <p>Java class for plural-fetch-mode</p>.See `@org.hibernate.annotations.PolymorphismType` See `@org.hibernate.annotations.Polymorphism` <p>Java class for polymorphism-type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PostLoad {} <p>Java class for post-load complex type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PostPersist {} <p>Java class for post-persist complex type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PostRemove {} <p>Java class for post-remove complex type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PostUpdate {} <p>Java class for post-update complex type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PrePersist {} <p>Java class for pre-persist complex type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PreRemove {} <p>Java class for pre-remove complex type</p>.@Target({METHOD}) @Retention(RUNTIME) public @interface PreUpdate {} <p>Java class for pre-update complex type</p>.@Repeatable(PrimaryKeyJoinColumns.class) @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface PrimaryKeyJoinColumn { String name() default ""; String referencedColumnName() default ""; String columnDefinition() default ""; String options() default ""; ForeignKey foreignKey() default @ForeignKey(PROVIDER_DEFAULT); } <p>Java class for primary-key-join-column complex type</p>.public @interface PropertyRef { String value(); } <p>Java class for property-ref complex type</p>.Models a named query hint in the JAXB model@Target({}) @Retention(RUNTIME) public @interface QueryHint { String name(); String value(); } <p>Java class for query-hint complex type</p>.Used only by tools to generate finder methods for named queries <p>Java class for query-param-type complex type</p>.Common interface for JAXB bindings that understand database schema (tables, sequences, etc).See `@jakarta.persistence.SecondaryTable` See `@org.hibernate.annotations.SecondaryRow` <p>Java class for secondary-table complex type</p>.@Repeatable(SequenceGenerators.class) @Target({TYPE, METHOD, FIELD, PACKAGE}) @Retention(RUNTIME) public @interface SequenceGenerator { String name() default ""; String sequenceName() default ""; String catalog() default ""; String schema() default ""; int initialValue() default 1; int allocationSize() default 50; String options() default ""; } <p>Java class for sequence-generator complex type</p>.org.hibernate.FetchMode enum values <p>Java class for singular-fetch-mode</p>.@Repeatable(SqlResultSetMappings.class) @Target({TYPE}) @Retention(RUNTIME) public @interface SqlResultSetMapping { String name(); EntityResult[] entities() default {}; ConstructorResult[] classes() default{}; ColumnResult[] columns() default {}; } <p>Java class for sql-result-set-mapping complex type</p>.@org.hibernate.annotations.SQLSelect <p>Java class for sql-select complex type</p>.Commonality between non-id, non-version and non-embedded.@Target({}) @Retention(RUNTIME) public @interface StoredProcedureParameter { String name() default ""; ParameterMode mode() default ParameterMode.IN; Class<?> type(); } <p>Java class for stored-procedure-parameter complex type</p>.<p>Java class for synchronized-table complex type</p>.@Repeatable(TableGenerators.class) @Target({TYPE, METHOD, FIELD, PACKAGE}) @Retention(RUNTIME) public @interface TableGenerator { String name() default ""; String table() default ""; String catalog() default ""; String schema() default ""; String pkColumnName() default ""; String valueColumnName() default ""; String pkColumnValue() default ""; int initialValue() default 0; int allocationSize() default 50; UniqueConstraint[] uniqueConstraints() default {}; Indexes[] indexes() default {}; String options() default ""; } <p>Java class for table-generator complex type</p>.@Target({TYPE}) @Retention(RUNTIME) public @interface Table { String name() default ""; String catalog() default ""; String schema() default ""; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; CheckConstraint[] check() default {}; String comment() default ""; String options() default ""; } <p>Java class for table complex type</p>.See `@org.hibernate.annotations.TenantId` <p>Java class for tenant-id complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Transient {} <p>Java class for transient complex type</p>.@Target({}) @Retention(RUNTIME) public @interface UniqueConstraint { String name() default ""; String[] columnNames(); String options() default ""; } <p>Java class for unique-constraint complex type</p>.See `@org.hibernate.annotations.Type` <p>Java class for user-type complex type</p>.See @TypeRegistration <p>Java class for user-type-registration complex type</p>.See `@org.hibernate.annotations.UuidGenerator` <p>Java class for uuid-generator complex type</p>.@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Version {} <p>Java class for version complex type</p>.This object contains factory methods for each Java content interface and Java element interface generated in the org.hibernate.boot.jaxb.mapping.spi package.