AttributeOverride


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   * The <code>AttributeOverride</code> annotation is used to 
34   * override the mapping of a {@link Basic} (whether explicit or 
35   * default) property or field or Id property or field.
36   *
37   * <p> The <code>AttributeOverride</code> annotation may be 
38   * applied to an entity that extends a mapped superclass or to 
39   * an embedded field or property to override a basic mapping 
40   * defined by the mapped superclass or embeddable class. If the 
41   * <code>AttributeOverride</code> annotation is not specified, 
42   * the column is mapped the same as in the original mapping.
43   *
44   * <pre>
45   * <p> Example:
46   *
47   *   &#064;MappedSuperclass
48   *   public class Employee {
49   *       &#064;Id protected Integer id;
50   *       &#064;Version protected Integer version;
51   *       protected String address;
52   *       public Integer getId() { ... }
53   *       public void setId(Integer id) { ... }
54   *       public String getAddress() { ... }
55   *       public void setAddress(String address) { ... }
56   *   }
57   *
58   *   &#064;Entity
59   *   &#064;AttributeOverride(name="address", column=&#064;Column(name="ADDR"))
60   *   public class PartTimeEmployee extends Employee {
61   *       // address field mapping overridden to ADDR
62   *       protected Float wage();
63   *       public Float getHourlyWage() { ... }
64   *       public void setHourlyWage(Float wage) { ... }
65   *   }
66   * </pre>
67   *
68   * @see Embedded
69   * @see Embeddable
70   * @see MappedSuperclass
71   *
72   * @since Java Persistence 1.0
73   */
74  @Target  ({TYPE, METHOD, FIELD}) 
75  @Retention  (RUNTIME)
76  
77  public @interface AttributeOverride {
78  
79      /**
80       * (Required) The name of the property whose mapping is being 
81       * overridden if property-based access is being used, or the 
82       * name of the field if field-based access is used.
83       */
84      String   name();
85  
86      /**
87       * (Required) The column that is being mapped to the persistent 
88       * attribute. The mapping type will remain the same as is 
89       * defined in the embeddable class or mapped superclass.
90       */
91      Column column();
92  }
93
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags