PrimaryKeyJoinColumns


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.METHOD  ;
28  import static java.lang.annotation.ElementType.FIELD  ;
29  import static java.lang.annotation.ElementType.TYPE  ;
30  import static java.lang.annotation.RetentionPolicy.RUNTIME  ;
31  
32  /**
33   * This annotation groups {@link PrimaryKeyJoinColumn} annotations.
34   * It is used to map composite foreign keys.
35   *
36   * <pre>
37   *    Example 1: ValuedCustomer subclass
38   *
39   *    &#064;Entity
40   *    &#064;Table(name="VCUST")
41   *    &#064;DiscriminatorValue("VCUST")
42   *    &#064;PrimaryKeyJoinColumns({
43   *        &#064;PrimaryKeyJoinColumn(name="CUST_ID", 
44   *            referencedColumnName="ID"),
45   *        &#064;PrimaryKeyJoinColumn(name="CUST_TYPE",
46   *            referencedColumnName="TYPE")
47   *    })
48   *    public class ValuedCustomer extends Customer { ... }
49   * </pre>
50   *
51   * @since Java Persistence 1.0
52   */
53  @Target  ({TYPE, METHOD, FIELD})
54  @Retention  (RUNTIME)
55  
56  public @interface PrimaryKeyJoinColumns {
57  
58      /** One or more {@link PrimaryKeyJoinColumn} annotations. */
59      PrimaryKeyJoinColumn[] value();
60  }
61
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags