Top Interfaces Classes
[default module]

Package org.hibernate.boot.jaxb.mapping.spi


Interface Summary

Modifier and TypeInterface and Description
public interface
public interface
AttributesContainer

Common interface for JAXB bindings which are containers of attributes.

public interface
CollectionAttribute

Common interface for Jaxb bindings that represent persistent collection attributes.

public interface
EntityOrMappedSuperclass

Common interface for JAXB bindings representing entities and mapped-superclasses.

public interface
FetchableAttribute

Common interface for JAXB bindings that represent attributes with laziness and fetch style.

public interface
LifecycleCallback

Common interface for all the JAXB bindings representing lifecycle callbacks.

public interface
public interface
ManagedType

Common interface for JAXB bindings representing entities, mapped-superclasses and embeddables (JPA collective calls these "managed types" in terms of its Metamodel api).

public interface
public interface
PersistentAttribute

Common interface for JAXB bindings that represent persistent attributes.

public interface
SchemaAware

Common interface for JAXB bindings that understand database schema (tables, sequences, etc).

Class Summary

Modifier and TypeClass and Description
public class
public class
public class
public class
public class
public class
public class
public class
public class
public class
public class
JaxbAssociationOverride

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AssociationOverride { String name(); JoinColumn[] joinColumns() default{}; JoinTable joinTable() default @JoinTable; }

Java class for association-override complex type.

public class
JaxbAttributeOverride

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AttributeOverride { String name(); Column column(); }

Java class for attribute-override complex type.

public class
JaxbAttributes

This element contains the entity field or property mappings.

public class
JaxbBasic

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Basic { FetchType fetch() default EAGER; boolean optional() default true; }

Java class for basic complex type.

public class
JaxbCascadeType

public enum CascadeType { ALL, PERSIST, MERGE, REMOVE, REFRESH, DETACH};

Java class for cascade-type complex type.

public class
JaxbCollectionTable

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface CollectionTable { String name() default ""; String catalog() default ""; String schema() default ""; JoinColumn[] joinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; }

Java class for collection-table complex type.

public class
JaxbColumn

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Column { String name() default ""; boolean unique() default false; boolean nullable() default true; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; String table() default ""; int length() default 255; int precision() default 0; // decimal precision int scale() default 0; // decimal scale }

Java class for column complex type.

public class
JaxbColumnResult

@Target({}) @Retention(RUNTIME) public @interface ColumnResult { String name(); Class type() default void.class; }

Java class for column-result complex type.

public class
JaxbConstructorResult

@Target({}) @Retention(RUNTIME) public @interface ConstructorResult { Class targetClass(); ColumnResult[] columns(); }

Java class for constructor-result complex type.

public class
JaxbConvert

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface Convert { Class converter() default void.class; String attributeName() default ""; boolean disableConversion() default false; }

Java class for convert complex type.

public class
JaxbConverter

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface Converter { boolean autoApply() default false; }

Java class for converter complex type.

public class
JaxbDiscriminatorColumn

@Target({TYPE}) @Retention(RUNTIME) public @interface DiscriminatorColumn { String name() default "DTYPE"; DiscriminatorType discriminatorType() default STRING; String columnDefinition() default ""; int length() default 31; }

Java class for discriminator-column complex type.

public class
JaxbElementCollection

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ElementCollection { Class targetClass() default void.class; FetchType fetch() default LAZY; }

Java class for element-collection complex type.

public class
JaxbEmbeddable

Defines the settings and mappings for embeddable objects.

public class
JaxbEmbeddableAttributes

Java class for embeddable-attributes complex type.

public class
JaxbEmbedded

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Embedded {}

Java class for embedded complex type.

public class
JaxbEmbeddedId

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface EmbeddedId {}

Java class for embedded-id complex type.

public class
JaxbEmptyType

Java class for emptyType complex type.

public class
JaxbEntity

Defines the settings and mappings for an entity.

public class
JaxbEntityListener

Defines an entity listener to be invoked at lifecycle events for the entities that list this listener.

public class
JaxbEntityListeners

@Target({TYPE}) @Retention(RUNTIME) public @interface EntityListeners { Class[] value(); }

Java class for entity-listeners complex type.

public class
JaxbEntityMappings

The entity-mappings element is the root element of a mapping file.

public class
JaxbEntityResult

@Target({}) @Retention(RUNTIME) public @interface EntityResult { Class entityClass(); FieldResult[] fields() default {}; String discriminatorColumn() default ""; }

Java class for entity-result complex type.

public class
JaxbFieldResult

@Target({}) @Retention(RUNTIME) public @interface FieldResult { String name(); String column(); }

Java class for field-result complex type.

public class
JaxbForeignKey

@Target({}) @Retention(RUNTIME) public @interface ForeignKey { String name() default ""; ConstraintMode value() defalut CONSTRAINT String foreign-key-definition() default ""; Note that the elements that embed the use of the annotation default this use as @ForeignKey(PROVIDER_DEFAULT) }

Java class for foreign-key complex type.

public class
JaxbGeneratedValue

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface GeneratedValue { GenerationType strategy() default AUTO; String generator() default ""; }

Java class for generated-value complex type.

public class
JaxbId

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Id {}

Java class for id complex type.

public class
JaxbIdClass

@Target({TYPE}) @Retention(RUNTIME) public @interface IdClass { Class value(); }

Java class for id-class complex type.

public class
JaxbIndex

@Target({}) @Retention(RUNTIME) public @interface Index { String name() default ""; String columnList(); boolean unique() default false; }

Java class for index complex type.

public class
JaxbInheritance

@Target({TYPE}) @Retention(RUNTIME) public @interface Inheritance { InheritanceType strategy() default SINGLE_TABLE; }

Java class for inheritance complex type.

public class
JaxbJoinColumn

@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 table() default ""; ForeignKey foreignKey() default @ForeignKey(); }

Java class for join-column complex type.

public class
JaxbJoinTable

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface JoinTable { String name() default ""; String catalog() default ""; String schema() default ""; JoinColumn[] joinColumns() default {}; JoinColumn[] inverseJoinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; }

Java class for join-table complex type.

public class
JaxbLob

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Lob {}

Java class for lob complex type.

public class
JaxbManyToMany

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToMany { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default LAZY; String mappedBy() default ""; }

Java class for many-to-many complex type.

public class
JaxbManyToOne

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToOne { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default EAGER; boolean optional() default true; }

Java class for many-to-one complex type.

public class
JaxbMapKey

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKey { String name() default ""; }

Java class for map-key complex type.

public class
JaxbMapKeyClass

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKeyClass { Class value(); }

Java class for map-key-class complex type.

public class
JaxbMapKeyColumn

@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 table() default ""; int length() default 255; int precision() default 0; // decimal precision int scale() default 0; // decimal scale }

Java class for map-key-column complex type.

public class
JaxbMapKeyJoinColumn

@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 table() default ""; }

Java class for map-key-join-column complex type.

public class
JaxbMappedSuperclass

Defines the settings and mappings for a mapped superclass.

public class
JaxbNamedAttributeNode

@Target({}) @Retention(RUNTIME) public @interface NamedAttributeNode { String value(); String subgraph() default ""; String keySubgraph() default ""; }

Java class for named-attribute-node complex type.

public class
JaxbNamedEntityGraph

@Target({TYPE}) @Retention(RUNTIME) public @interface NamedEntityGraph { String name() default ""; NamedAttributeNode[] attributeNodes() default {}; boolean includeAllAttributes() default false; NamedSubgraph[] subgraphs() default {}; NamedSubGraph[] subclassSubgraphs() default {}; }

Java class for named-entity-graph complex type.

public class
JaxbNamedNativeQuery

@Target({TYPE}) @Retention(RUNTIME) public @interface NamedNativeQuery { String name(); String query(); QueryHint[] hints() default {}; Class resultClass() default void.class; String resultSetMapping() default ""; //named SqlResultSetMapping }

Java class for named-native-query complex type.

public class
JaxbNamedQuery

@Target({TYPE}) @Retention(RUNTIME) public @interface NamedQuery { String name(); String query(); LockModeType lockMode() default NONE; QueryHint[] hints() default {}; }

Java class for named-query complex type.

public class
JaxbNamedStoredProcedureQuery

@Target({TYPE}) @Retention(RUNTIME) public @interface NamedStoredProcedureQuery { String name(); String procedureName(); StoredProcedureParameter[] parameters() default {}; Class[] resultClasses() default {}; String[] resultSetMappings() default{}; QueryHint[] hints() default {}; }

Java class for named-stored-procedure-query complex type.

public class
JaxbNamedSubgraph

@Target({}) @Retention(RUNTIME) public @interface NamedSubgraph { String name(); Class type() default void.class; NamedAttributeNode[] attributeNodes(); }

Java class for named-subgraph complex type.

public class
JaxbOneToMany

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToMany { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default LAZY; String mappedBy() default ""; }

Java class for one-to-many complex type.

public class
JaxbOneToOne

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToOne { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default EAGER; boolean optional() default true; String mappedBy() default ""; boolean orphanRemoval() default false; }

Java class for one-to-one complex type.

public class
JaxbOrderColumn

@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 ""; }

Java class for order-column complex type.

public class
JaxbPersistenceUnitDefaults

These defaults are applied to the persistence unit as a whole unless they are overridden by local annotation or XML element settings.

public class
JaxbPersistenceUnitMetadata

Metadata that applies to the persistence unit and not just to the mapping file in which it is contained.

public class
JaxbPostLoad

@Target({METHOD}) @Retention(RUNTIME) public @interface PostLoad {}

Java class for post-load complex type.

public class
JaxbPostPersist

@Target({METHOD}) @Retention(RUNTIME) public @interface PostPersist {}

Java class for post-persist complex type.

public class
JaxbPostRemove

@Target({METHOD}) @Retention(RUNTIME) public @interface PostRemove {}

Java class for post-remove complex type.

public class
JaxbPostUpdate

@Target({METHOD}) @Retention(RUNTIME) public @interface PostUpdate {}

Java class for post-update complex type.

public class
JaxbPrePersist

@Target({METHOD}) @Retention(RUNTIME) public @interface PrePersist {}

Java class for pre-persist complex type.

public class
JaxbPreRemove

@Target({METHOD}) @Retention(RUNTIME) public @interface PreRemove {}

Java class for pre-remove complex type.

public class
JaxbPreUpdate

@Target({METHOD}) @Retention(RUNTIME) public @interface PreUpdate {}

Java class for pre-update complex type.

public class
JaxbPrimaryKeyJoinColumn

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface PrimaryKeyJoinColumn { String name() default ""; String referencedColumnName() default ""; String columnDefinition() default ""; }

Java class for primary-key-join-column complex type.

public class
JaxbQueryHint

@Target({}) @Retention(RUNTIME) public @interface QueryHint { String name(); String value(); }

Java class for query-hint complex type.

public class
JaxbSecondaryTable

@Target({TYPE}) @Retention(RUNTIME) public @interface SecondaryTable { String name(); String catalog() default ""; String schema() default ""; PrimaryKeyJoinColumn[] pkJoinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; }

Java class for secondary-table complex type.

public class
JaxbSequenceGenerator

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface SequenceGenerator { String name(); String sequenceName() default ""; String catalog() default ""; String schema() default ""; int initialValue() default 1; int allocationSize() default 50; }

Java class for sequence-generator complex type.

public class
JaxbSqlResultSetMapping

@Target({TYPE}) @Retention(RUNTIME) public @interface SqlResultSetMapping { String name(); EntityResult[] entities() default {}; ConstructorResult[] classes() default{}; ColumnResult[] columns() default {}; }

Java class for sql-result-set-mapping complex type.

public class
JaxbStoredProcedureParameter

@Target({TYPE}) @Retention(RUNTIME) public @interface StoredProcedureParameter { String name() default ""; ParameterMode mode() default ParameterMode.IN; Class type(); }

Java class for stored-procedure-parameter complex type.

public class
JaxbTable

@Target({TYPE}) @Retention(RUNTIME) public @interface Table { String name() default ""; String catalog() default ""; String schema() default ""; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; }

Java class for table complex type.

public class
JaxbTableGenerator

@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface TableGenerator { String name(); 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 {}; }

Java class for table-generator complex type.

public class
JaxbTransient

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Transient {}

Java class for transient complex type.

public class
JaxbUniqueConstraint

@Target({}) @Retention(RUNTIME) public @interface UniqueConstraint { String name() default ""; String[] columnNames(); }

Java class for unique-constraint complex type.

public class
JaxbVersion

@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Version {}

Java class for version complex type.

public class
ObjectFactory

This object contains factory methods for each Java content interface and Java element interface generated in the org.hibernate.boot.jaxb.mapping.spi package.