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.RetentionPolicy.RUNTIME;
42:
43: /**
44: * This annotation is used to specify multiple secondary tables
45: * for an entity.
46: *
47: * <pre>
48: * Example 1: Multiple secondary tables assuming primary key columns are named the same in all tables.
49: *
50: * @Entity
51: * @Table(name="EMPLOYEE")
52: * @SecondaryTables({
53: * @SecondaryTable(name="EMP_DETAIL"),
54: * @SecondaryTable(name="EMP_HIST")
55: * })
56: * public class Employee { ... }
57: *
58: * Example 2: Multiple secondary tables with differently named primary key columns.
59: *
60: * @Entity
61: * @Table(name="EMPLOYEE")
62: * @SecondaryTables({
63: * @SecondaryTable(name="EMP_DETAIL",
64: * pkJoinColumns=@PrimaryKeyJoinColumn(name="EMPL_ID")),
65: * @SecondaryTable(name="EMP_HIST",
66: * pkJoinColumns=@PrimaryKeyJoinColumn(name="EMPLOYEE_ID"))
67: * })
68: * public class Employee { ... }
69: * </pre>
70: *
71: * @since Java Persistence 1.0
72: */
73: @Target(TYPE)
74: @Retention(RUNTIME)
75: public @interface SecondaryTables {
76:
77: /** The secondary tables for an entity. */
78: SecondaryTable[] value();
79: }
|