001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.persistence;
037:
038: import java.lang.annotation.Target;
039: import java.lang.annotation.Retention;
040: import static java.lang.annotation.ElementType.FIELD;
041: import static java.lang.annotation.ElementType.METHOD;
042: import static java.lang.annotation.RetentionPolicy.RUNTIME;
043:
044: /**
045: * This annotation is used in the mapping of associations. It
046: * is specified on the owning side of a many-to-many association,
047: * or in a unidirectional one-to-many association.
048: *
049: * <p> If the <code>JoinTable</code> annotation is missing, the
050: * default values of the annotation elements apply. The name
051: * of the join table is assumed to be the table names of the
052: * associated primary tables concatenated together (owning side
053: * first) using an underscore.
054: *
055: * <pre>
056: *
057: * Example:
058: * @JoinTable(
059: * name="CUST_PHONE",
060: * joinColumns=
061: * @JoinColumn(name="CUST_ID", referencedColumnName="ID"),
062: * inverseJoinColumns=
063: * @JoinColumn(name="PHONE_ID", referencedColumnName="ID")
064: * )
065: * </pre>
066: *
067: * @since Java Persistence 1.0
068: */
069: @Target({METHOD,FIELD})
070: @Retention(RUNTIME)
071: public @interface JoinTable {
072:
073: /**
074: * (Optional) The name of the join table.
075: *
076: * <p> Defaults to the concatenated names of
077: * the two associated primary entity tables,
078: * separated by an underscore.
079: */
080: String name() default "";
081:
082: /** (Optional) The catalog of the table.
083: * <p> Defaults to the default catalog.
084: */
085: String catalog() default "";
086:
087: /** (Optional) The schema of the table.
088: * <p> Defaults to the default schema for user.
089: */
090: String schema() default "";
091:
092: /**
093: * (Optional) The foreign key columns
094: * of the join table which reference the
095: * primary table of the entity owning the
096: * association (i.e. the owning side of
097: * the association).
098: *
099: * <p> Uses the same defaults as for {@link JoinColumn}.
100: */
101: JoinColumn[] joinColumns() default {};
102:
103: /**
104: * (Optional) The foreign key columns
105: * of the join table which reference the
106: * primary table of the entity that does
107: * not own the association (i.e. the
108: * inverse side of the association).
109: *
110: * <p> Uses the same defaults as for {@link JoinColumn}.
111: */
112: JoinColumn[] inverseJoinColumns() default {};
113:
114: /**
115: * (Optional) Unique constraints that are
116: * to be placed on the table. These are
117: * only used if table generation is in effect.
118: * <p> Defaults to no additional constraints.
119: */
120: UniqueConstraint[] uniqueConstraints() default {};
121: }
|