Package net.java.ao.schema

Annotation Interface PrimaryKey

@Retention(RUNTIME) @Target(METHOD) public @interface PrimaryKey

Marks a method such that the corresponding database field will be the primary key for the table in question. Using this annotation, it is possible to specify arbitrary primary key field names and types.

The logic in both migrations and entity invocation handling assumes that there is only a single primary key per entity type. If the entity type does not contain exactly one field (may be more than one method) as a primary key, odd errors will ensue. Primary keys need not be defined within the entity type itself. For example, most entities inherit from the Entity interface, which defines the id field as the primary key. Such entities would not have to (in fact, should not at all) explicitly define a primary key field.

Author:
Daniel Spiewak

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Specifies a name for the underlying field.

  • Element Details

    • value

      String value
      Specifies a name for the underlying field. Should be used to override the field name in much the same way as the Accessor and Mutator annotations. Unless specified, the underlying field name will be generated by the field name converter for the EntityManager in use.
      Default:
      ""