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 specifies the primary table for the annotated
45: * entity. Additional tables may be specified using {@link SecondaryTable}
46: * or {@link SecondaryTables} annotation.
47: *
48: * <p> If no <code>Table</code> annotation is specified for an entity
49: * class, the default values apply.
50: *
51: * <pre>
52: * Example:
53: *
54: * @Entity
55: * @Table(name="CUST", schema="RECORDS")
56: * public class Customer { ... }
57: * </pre>
58: *
59: * @since Java Persistence 1.0
60: */
61: @Target(TYPE)
62: @Retention(RUNTIME)
63: public @interface Table {
64:
65: /**
66: * (Optional) The name of the table.
67: * <p> Defaults to the entity name.
68: */
69: String name() default "";
70:
71: /** (Optional) The catalog of the table.
72: * <p> Defaults to the default catalog.
73: */
74: String catalog() default "";
75:
76: /** (Optional) The schema of the table.
77: * <p> Defaults to the default schema for user.
78: */
79: String schema() default "";
80:
81: /**
82: * (Optional) Unique constraints that are to be placed on
83: * the table. These are only used if table generation is in
84: * effect. These constraints apply in addition to any constraints
85: * specified by the {@link Column} and {@link JoinColumn}
86: * annotations and constraints entailed by primary key mappings.
87: * <p> Defaults to no additional constraints.
88: */
89: UniqueConstraint[] uniqueConstraints() default {};
90: }
|