Package org.apache.openejb.jee.jpa
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
Interface Summary Interface Description Field Mapping RelationField -
Class Summary Class Description AssociationOverride Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AssociationOverride { String name(); JoinColumn[] joinColumns() default{}; JoinTable joinTable() default @JoinTable; }AttributeOverride Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AttributeOverride { String name(); Column column(); }Attributes This element contains the entity field or property mappings.Basic Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Basic { FetchType fetch() default EAGER; boolean optional() default true; }CascadeType public enum CascadeType { ALL, PERSIST, MERGE, REMOVE, REFRESH, DETACH};CollectionTable Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface CollectionTable { String name() default ""; String catalog() default ""; String schema() default ""; JoinColumn[] joinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; }Column 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 }ColumnResult Target({}) @Retention(RUNTIME) public @interface ColumnResult { String name(); }DiscriminatorColumn Target({TYPE}) @Retention(RUNTIME) public @interface DiscriminatorColumn { String name() default "DTYPE"; DiscriminatorType discriminatorType() default STRING; String columnDefinition() default ""; int length() default 31; }ElementCollection Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ElementCollection { Class targetClass() default void.class; FetchType fetch() default LAZY; }Embeddable Defines the settings and mappings for embeddable objects.EmbeddableAttributes Java class for embeddable-attributes complex type.Embedded Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Embedded {}EmbeddedId Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface EmbeddedId {}EmptyType Java class for emptyType complex type.Entity Defines the settings and mappings for an entity.EntityListener Defines an entity listener to be invoked at lifecycle events for the entities that list this listener.EntityListeners Target({TYPE}) @Retention(RUNTIME) public @interface EntityListeners { Class[] value(); }EntityMappings The entity-mappings element is the root element of a mapping file.EntityResult Target({}) @Retention(RUNTIME) public @interface EntityResult { Class entityClass(); FieldResult[] fields() default {}; String discriminatorColumn() default ""; }FieldResult Target({}) @Retention(RUNTIME) public @interface FieldResult { String name(); String column(); }GeneratedValue Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface GeneratedValue { GenerationType strategy() default AUTO; String generator() default ""; }Id Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Id {}IdClass Target({TYPE}) @Retention(RUNTIME) public @interface IdClass { Class value(); }Inheritance Target({TYPE}) @Retention(RUNTIME) public @interface Inheritance { InheritanceType strategy() default SINGLE_TABLE; }JoinColumn 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 ""; }JoinTable 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 {}; }JpaJaxbUtil Lob Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Lob {}ManyToMany Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToMany { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default LAZY; String mappedBy() default ""; }ManyToOne Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface ManyToOne { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default EAGER; boolean optional() default true; }MapKey Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKey { String name() default ""; }MapKeyClass Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKeyClass { Class value(); }MapKeyColumn 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 }MapKeyJoinColumn 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 ""; }MappedSuperclass Defines the settings and mappings for a mapped superclass.NamedNativeQuery Target({TYPE}) @Retention(RUNTIME) public @interface NamedNativeQuery { String name(); String query(); QueryHint[] hints() default {}; Class resultClass() default void.class; String resultSetMapping() default ""; //named SqlResultSetMapping }NamedQuery Target({TYPE}) @Retention(RUNTIME) public @interface NamedQuery { String name(); String query(); LockModeType lockMode() default NONE; QueryHint[] hints() default {}; }ObjectFactory This object contains factory methods for each Java content interface and Java element interface generated in the org.apache.openejb.jee.jpa package.OneToMany Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToMany { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default LAZY; String mappedBy() default ""; }OneToOne 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; }OrderColumn 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 ""; }PersistenceUnitDefaults These defaults are applied to the persistence unit as a whole unless they are overridden by local annotation or XML element settings.PersistenceUnitMetadata Metadata that applies to the persistence unit and not just to the mapping file in which it is contained.PostLoad Target({METHOD}) @Retention(RUNTIME) public @interface PostLoad {}PostPersist Target({METHOD}) @Retention(RUNTIME) public @interface PostPersist {}PostRemove Target({METHOD}) @Retention(RUNTIME) public @interface PostRemove {}PostUpdate Target({METHOD}) @Retention(RUNTIME) public @interface PostUpdate {}PrePersist Target({METHOD}) @Retention(RUNTIME) public @interface PrePersist {}PreRemove Target({METHOD}) @Retention(RUNTIME) public @interface PreRemove {}PreUpdate Target({METHOD}) @Retention(RUNTIME) public @interface PreUpdate {}PrimaryKeyJoinColumn Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface PrimaryKeyJoinColumn { String name() default ""; String referencedColumnName() default ""; String columnDefinition() default ""; }QueryHint Target({}) @Retention(RUNTIME) public @interface QueryHint { String name(); String value(); }SecondaryTable Target({TYPE}) @Retention(RUNTIME) public @interface SecondaryTable { String name(); String catalog() default ""; String schema() default ""; PrimaryKeyJoinColumn[] pkJoinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; }SequenceGenerator 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; }SqlResultSetMapping Target({TYPE}) @Retention(RUNTIME) public @interface SqlResultSetMapping { String name(); EntityResult[] entities() default {}; ColumnResult[] columns() default {}; }Table Target({TYPE}) @Retention(RUNTIME) public @interface Table { String name() default ""; String catalog() default ""; String schema() default ""; UniqueConstraint[] uniqueConstraints() default {}; }TableGenerator 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 {}; }Transient Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Transient {}UniqueConstraint Target({}) @Retention(RUNTIME) public @interface UniqueConstraint { String name() default ""; String[] columnNames(); }Version Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Version {} -
Enum Summary Enum Description AccessType Java class for access-type.DiscriminatorType Java class for discriminator-type.EnumType Java class for enum-type.FetchType Java class for fetch-type.GenerationType Java class for generation-type.InheritanceType Java class for inheritance-type.LockModeType Java class for lock-mode-type.TemporalType Java class for temporal-type.