FileDocCategorySizeDatePackage
TableGenerator.javaAPI DocGlassfish v2 API5645Fri May 04 22:34:08 BST 2007javax.persistence

TableGenerator

public class TableGenerator
This annotation defines a primary key generator that may be referenced by name when a generator element is specified for the {@link GeneratedValue} annotation. A table generator may be specified on the entity class or on the primary key field or property. The scope of the generator name is global to the persistence unit (across all generator types).
Example 1:

@Entity public class Employee {
...
@TableGenerator(
name="empGen",
table="ID_GEN",
pkColumnName="GEN_KEY",
valueColumnName="GEN_VALUE",
pkColumnValue="EMP_ID",
allocationSize=1)
@Id
@GeneratedValue(strategy=TABLE, generator="empGen")
public int id;
...
}

Example 2:

@Entity public class Address {
...
@TableGenerator(
name="addressGen",
table="ID_GEN",
pkColumnName="GEN_KEY",
valueColumnName="GEN_VALUE",
pkColumnValue="ADDR_ID")
@Id
@GeneratedValue(strategy=TABLE, generator="addressGen")
public int id;
...
}
since
Java Persistence 1.0

Fields Summary
Constructors Summary
Methods Summary
intallocationSize()
(Optional) The amount to increment by when allocating id numbers from the generator.

java.lang.Stringcatalog()
(Optional) The catalog of the table.

Defaults to the default catalog.

intinitialValue()
(Optional) The initial value to be used when allocating id numbers from the generator.

java.lang.Stringname()
(Required) A unique generator name that can be referenced by one or more classes to be the generator for id values.

java.lang.StringpkColumnName()
(Optional) Name of the primary key column in the table.

Defaults to a provider-chosen name.

java.lang.StringpkColumnValue()
(Optional) The primary key value in the generator table that distinguishes this set of generated values from others that may be stored in the table.

Defaults to a provider-chosen value to store in the primary key column of the generator table

java.lang.Stringschema()
(Optional) The schema of the table.

Defaults to the default schema for user.

java.lang.Stringtable()
(Optional) Name of table that stores the generated id values.

Defaults to a name chosen by persistence provider.

javax.persistence.UniqueConstraint[]uniqueConstraints()
(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect. These constraints apply in addition to primary key constraints.

Defaults to no additional constraints.

java.lang.StringvalueColumnName()
(Optional) Name of the column that stores the last value generated.

Defaults to a provider-chosen name.