org.seasar.doma

Annotation Type TableGenerator

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface TableGenerator

Indicates an identifier generator that uses a table.

The annotated field must be a member of an Entity annotated class. This annotation must be used in conjunction with the Id annotation and the GeneratedValue annotation.

 @Entity
 public class Employee {

     @Id
     @GeneratedValue(strategy = GenerationType.TABLE)
     @TableGenerator(pkColumnValue = "EMPLOYEE_ID")
     Integer id;

     ...
 }
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	pkColumnValue

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	allocationSize
java.lang.String	catalog
java.lang.Class<? extends TableIdGenerator>	implementer
long	initialValue
java.lang.String	pkColumnName
java.lang.String	schema
java.lang.String	table
java.lang.String	valueColumnName

Element Detail

pkColumnValue

public abstract java.lang.String pkColumnValue

Returns:

the value of the primary key column.

catalog

public abstract java.lang.String catalog

Returns:

the catalog name.

Default:

""

schema

public abstract java.lang.String schema

Returns:

the schema name.

Default:

""

table

public abstract java.lang.String table

Returns:

the table name.

Default:

"ID_GENERATOR"

pkColumnName

public abstract java.lang.String pkColumnName

Returns:

the column name that is the primary key.

Default:

"PK"

valueColumnName

public abstract java.lang.String valueColumnName

Returns:

the column name that has generated identifiers.

Default:

"VALUE"

initialValue

public abstract long initialValue

Returns:

the initial value.

Default:

1L

allocationSize

public abstract long allocationSize

Returns:

the allocated size.

Default:

1L

implementer

public abstract java.lang.Class<? extends TableIdGenerator> implementer

Returns:

the implementation class of the TableIdGenerator interface.

Default:

org.seasar.doma.jdbc.id.BuiltinTableIdGenerator.class