01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package javax.persistence;
37:
38: import java.lang.annotation.Target;
39: import java.lang.annotation.Retention;
40: import static java.lang.annotation.ElementType.TYPE;
41: import static java.lang.annotation.ElementType.METHOD;
42: import static java.lang.annotation.ElementType.FIELD;
43: import static java.lang.annotation.RetentionPolicy.RUNTIME;
44:
45: /**
46: * This annotation is used to override a many-to-one or
47: * one-to-one mapping of property or field for an entity relationship.
48: *
49: * <p> The <code>AssociationOverride</code> annotation may be applied
50: * to an entity that extends a mapped superclass to override a many-to-one
51: * or one-to-one mapping defined by the mapped superclass. If the
52: * <code>AssociationOverride</code> annotation is not specified, the join
53: * column is mapped the same as in the original mapping.
54: * <pre>
55: * Example:
56: * @MappedSuperclass
57: * public class Employee {
58: * ...
59: * @ManyToOne
60: * protected Address address;
61: * ...
62: * }
63: *
64: * @Entity
65: * @AssociationOverride(name="address",
66: * joinColumns=@JoinColumn(name="ADDR_ID"))
67: * // address field mapping overridden to ADDR_ID fk
68: * public class PartTimeEmployee extends Employee {
69: * ...
70: * }
71: * </pre>
72: *
73: * @see OneToOne
74: * @see ManyToOne
75: * @see MappedSuperclass
76: *
77: * @since Java Persistence 1.0
78: */
79: @Target({TYPE,METHOD,FIELD})
80: @Retention(RUNTIME)
81: public @interface AssociationOverride {
82:
83: /**
84: * The name of the relationship property whose mapping is
85: * being overridden if property-based access is being used,
86: * or the name of the relationship field if field-based access is used.
87: */
88: String name();
89:
90: /**
91: * The join column that is being mapped to the persistent
92: * attribute. The mapping type will remain the same as is defined
93: * in the mapped superclass.
94: */
95: JoinColumn[] joinColumns();
96: }
|