javax.persistence.JoinTable Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
package javax.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* This annotation is used in the mapping of associations. It
* is specified on the owning side of a many-to-many association,
* or in a unidirectional one-to-many association.
*
* If the JoinTable annotation is missing, the
* default values of the annotation elements apply. The name
* of the join table is assumed to be the table names of the
* associated primary tables concatenated together (owning side
* first) using an underscore.
*
*
*
* Example:
* @JoinTable(
* name="CUST_PHONE",
* joinColumns=
* @JoinColumn(name="CUST_ID", referencedColumnName="ID"),
* inverseJoinColumns=
* @JoinColumn(name="PHONE_ID", referencedColumnName="ID")
* )
*
*
* @since Java Persistence 1.0
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface JoinTable {
/**
* (Optional) The name of the join table.
*
* Defaults to the concatenated names of
* the two associated primary entity tables,
* separated by an underscore.
*/
String name() default "";
/** (Optional) The catalog of the table.
*
Defaults to the default catalog.
*/
String catalog() default "";
/** (Optional) The schema of the table.
*
Defaults to the default schema for user.
*/
String schema() default "";
/**
* (Optional) The foreign key columns
* of the join table which reference the
* primary table of the entity owning the
* association (i.e. the owning side of
* the association).
*
*
Uses the same defaults as for {@link JoinColumn}.
*/
JoinColumn[] joinColumns() default {};
/**
* (Optional) The foreign key columns
* of the join table which reference the
* primary table of the entity that does
* not own the association (i.e. the
* inverse side of the association).
*
*
Uses the same defaults as for {@link JoinColumn}.
*/
JoinColumn[] inverseJoinColumns() default {};
/**
* (Optional) Unique constraints that are
* to be placed on the table. These are
* only used if table generation is in effect.
*
Defaults to no additional constraints.
*/
UniqueConstraint[] uniqueConstraints() default {};
}