001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.persistence;
037:
038: import java.lang.annotation.Target;
039: import java.lang.annotation.Retention;
040: import static java.lang.annotation.ElementType.FIELD;
041: import static java.lang.annotation.ElementType.METHOD;
042: import static java.lang.annotation.ElementType.TYPE;
043: import static java.lang.annotation.RetentionPolicy.RUNTIME;
044:
045: /**
046: * This annotation defines a primary key generator that may be
047: * referenced by name when a generator element is specified for
048: * the {@link GeneratedValue} annotation. A table generator
049: * may be specified on the entity class or on the primary key
050: * field or property. The scope of the generator name is global
051: * to the persistence unit (across all generator types).
052: *
053: * <pre>
054: * Example 1:
055: *
056: * @Entity public class Employee {
057: * ...
058: * @TableGenerator(
059: * name="empGen",
060: * table="ID_GEN",
061: * pkColumnName="GEN_KEY",
062: * valueColumnName="GEN_VALUE",
063: * pkColumnValue="EMP_ID",
064: * allocationSize=1)
065: * @Id
066: * @GeneratedValue(strategy=TABLE, generator="empGen")
067: * public int id;
068: * ...
069: * }
070: *
071: * Example 2:
072: *
073: * @Entity public class Address {
074: * ...
075: * @TableGenerator(
076: * name="addressGen",
077: * table="ID_GEN",
078: * pkColumnName="GEN_KEY",
079: * valueColumnName="GEN_VALUE",
080: * pkColumnValue="ADDR_ID")
081: * @Id
082: * @GeneratedValue(strategy=TABLE, generator="addressGen")
083: * public int id;
084: * ...
085: * }
086: * </pre>
087: *
088: * @since Java Persistence 1.0
089: */
090: @Target({TYPE,METHOD,FIELD})
091: @Retention(RUNTIME)
092: public @interface TableGenerator {
093:
094: /**
095: * (Required) A unique generator name that can be referenced
096: * by one or more classes to be the generator for id values.
097: */
098: String name();
099:
100: /**
101: * (Optional) Name of table that stores the generated id values.
102: * <p> Defaults to a name chosen by persistence provider.
103: */
104: String table() default "";
105:
106: /** (Optional) The catalog of the table.
107: * <p> Defaults to the default catalog.
108: */
109: String catalog() default "";
110:
111: /** (Optional) The schema of the table.
112: * <p> Defaults to the default schema for user.
113: */
114: String schema() default "";
115:
116: /**
117: * (Optional) Name of the primary key column in the table.
118: * <p> Defaults to a provider-chosen name.
119: */
120: String pkColumnName() default "";
121:
122: /**
123: * (Optional) Name of the column that stores the last value generated.
124: * <p> Defaults to a provider-chosen name.
125: */
126: String valueColumnName() default "";
127:
128: /**
129: * (Optional) The primary key value in the generator table
130: * that distinguishes this set of generated values from others
131: * that may be stored in the table.
132: * <p> Defaults to a provider-chosen value to store in the
133: * primary key column of the generator table
134: */
135: String pkColumnValue() default "";
136:
137: /**
138: * (Optional) The initial value to be used when allocating id
139: * numbers from the generator.
140: */
141: int initialValue() default 0;
142:
143: /**
144: * (Optional) The amount to increment by when allocating id
145: * numbers from the generator.
146: */
147: int allocationSize() default 50;
148:
149: /**
150: * (Optional) Unique constraints that are to be placed on the
151: * table. These are only used if table generation is in effect.
152: * These constraints apply in addition to primary key constraints.
153: * <p> Defaults to no additional constraints.
154: */
155: UniqueConstraint[] uniqueConstraints() default {};
156: }
|