AssociationOverride


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  package javax.persistence;
24  
25  import java.lang.annotation.Target  ;
26  import java.lang.annotation.Retention  ;
27  import static java.lang.annotation.ElementType.TYPE  ;
28  import static java.lang.annotation.ElementType.METHOD  ;
29  import static java.lang.annotation.ElementType.FIELD  ;
30  import static java.lang.annotation.RetentionPolicy.RUNTIME  ;
31  
32  /**
33   * This annotation is used to override a many-to-one or
34   * one-to-one mapping of property or field for an entity relationship.
35   *
36   * <p> The <code>AssociationOverride</code> annotation may be applied
37   * to an entity that extends a mapped superclass to override a many-to-one
38   * or one-to-one mapping defined by the mapped superclass. If the
39   * <code>AssociationOverride</code> annotation is not specified, the join
40   * column is mapped the same as in the original mapping.
41   * <pre>
42   *    Example:
43   *    &#064;MappedSuperclass
44   *    public class Employee {
45   *        ...
46   *        &#064;ManyToOne
47   *        protected Address address;
48   *        ...
49   *    }
50   *    
51   *    &#064;Entity 
52   *    &#064;AssociationOverride(name="address", 
53   *        joinColumns=&#064;JoinColumn(name="ADDR_ID"))
54   *    // address field mapping overridden to ADDR_ID fk
55   *    public class PartTimeEmployee extends Employee {
56   *        ...
57   *    }
58   * </pre>
59   *
60   * @see OneToOne
61   * @see ManyToOne
62   * @see MappedSuperclass
63   *
64   * @since Java Persistence 1.0
65   */
66  @Target  ({TYPE, METHOD, FIELD}) 
67  @Retention  (RUNTIME)
68  
69  public @interface AssociationOverride {
70  
71      /**
72       * The name of the relationship property whose mapping is
73       * being overridden if property-based access is being used,
74       * or the name of the relationship field if field-based access is used.
75       */
76      String   name();
77  
78      /**
79       * The join column that is being mapped to the persistent
80       * attribute. The mapping type will remain the same as is defined
81       * in the mapped superclass.
82       */
83      JoinColumn[] joinColumns();
84  }
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags