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: * Is used to specify a mapped column for joining an entity association.
046: *
047: * <pre>
048: * Example:
049: *
050: * @ManyToOne
051: * @JoinColumn(name="ADDR_ID")
052: * public Address getAddress() { return address; }
053: * </pre>
054: *
055: * @since Java Persistence 1.0
056: */
057: @Target({METHOD,FIELD})
058: @Retention(RUNTIME)
059: public @interface JoinColumn {
060:
061: /**
062: * (Optional) The name of the foreign key column.
063: * The table in which it is found depends upon the
064: * context. If the join is for a OneToOne or Many-
065: * ToOne mapping, the foreign key column is in the
066: * table of the source entity. If the join is for a
067: * ManyToMany, the foreign key is in a join table.
068: *
069: * Default (only applies if a single join column is used):
070: * The concatenation of the following: the name of the
071: * referencing relationship property or field of the referencing
072: * entity; "_"; the name of the referenced primary key column.
073: * If there is no such referencing relationship property or
074: * field in the entity, the join column name is formed as the
075: * concatenation of the following: the name of the entity; "_";
076: * the name of the referenced primary key column.
077: */
078: String name() default "";
079:
080: /**
081: * (Optional) The name of the column referenced
082: * by this foreign key column. When used with
083: * relationship mappings, the referenced column is
084: * in the table of the target entity. When used inside
085: * a JoinTable annotation, the referenced key column
086: * is in the entity table of the owning entity, or
087: * inverse entity if the join is part of the inverse join
088: * definition.
089: *
090: * Default (only applies if single join column is being
091: * used): The same name as the primary key column of the
092: * referenced table.
093: */
094: String referencedColumnName() default "";
095:
096: /**
097: * (Optional) Whether the property is a unique key.
098: * This is a shortcut for the UniqueConstraint annotation
099: * at the table level and is useful for when the
100: * unique key constraint is only a single field. It is
101: * not necessary to explicitly specify this for a join
102: * column that corresponds to a primary key that is
103: * part of a foreign key.
104: */
105: boolean unique() default false;
106:
107: /** (Optional) Whether the foreign key column is nullable. */
108: boolean nullable() default true;
109:
110: /**
111: * (Optional) Whether the column is included in
112: * SQL INSERT statements generated by the persistence
113: * provider.
114: */
115: boolean insertable() default true;
116:
117: /**
118: * (Optional) Whether the column is included in
119: * SQL UPDATE statements generated by the persistence
120: * provider.
121: */
122: boolean updatable() default true;
123:
124: /**
125: * (Optional) The SQL fragment that is used when
126: * generating the DDL for the column.
127: * <p> Defaults to the generated SQL for the column.
128: */
129: String columnDefinition() default "";
130:
131: /**
132: * (Optional) The name of the table that contains
133: * the column. If a table is not specified, the column
134: * is assumed to be in the primary table of the
135: * applicable entity.
136: */
137: String table() default "";
138: }
|