Annotation Type Key

@Target({FIELD,METHOD}) @Retention(RUNTIME) public @interface Key
Annotation for the key of a map relation. Corresponds to the xml element "key".
Since:
2.1
Version:
2.1

  • Element Details

    • types

      Class[] types
      Types of the keys. This can be determined if using JDK1.5 generics but is required otherwise. Multiple types can be specified if the implementation supports multiple types.
      Returns:
      the types of keys
      Default:
      {}

    • serialized

      String serialized
      Whether the key is to be stored serialized (into a single column of a join table).
      Returns:
      whether the key is to be stored serialized
      Default:
      ""

    • embedded

      String embedded
      Whether this key is embedded.
      Returns:
      whether this key is embedded
      Default:
      ""

    • embeddedMapping

      Embedded[] embeddedMapping
      The embedded mapping for the key.
      Returns:
      the embedded mapping for the key
      Default:
      {}

    • dependent

      String dependent
      Whether the key is dependent on the owner (and will be deleted when the owner is deleted).
      Returns:
      whether the key is dependent on the owner
      Default:
      ""

    • table

      String table
      Name of the table for the key.
      Returns:
      name of the table for the key
      Default:
      ""

    • column

      String column
      Name of the column to store the key in.
      Returns:
      name of the column to store the key in
      Default:
      ""

    • deleteAction

      ForeignKeyAction deleteAction
      Delete action to apply to the foreign key for the key.
      Returns:
      delete action to apply to the foreign key for the key
      Default:
      UNSPECIFIED

    • updateAction

      ForeignKeyAction updateAction
      Update action to apply to the foreign key for the key.
      Returns:
      update action to apply to the foreign key for the key
      Default:
      UNSPECIFIED

    • indexed

      String indexed
      Whether the value column(s) should be indexed.
      Returns:
      whether the value column(s) should be indexed.
      Default:
      ""

    • index

      String index
      The name of the index to generate.
      Returns:
      the name of the index
      Default:
      ""

    • unique

      String unique
      Whether the element column(s) contents should be considered unique
      Returns:
      whether the element column(s) contents should be considered unique
      Default:
      ""

    • uniqueKey

      String uniqueKey
      The name of the unique key constraint to generate.
      Returns:
      the name of the unique key constraint
      Default:
      ""

    • mappedBy

      String mappedBy
      Name of a member in the value class where this key is stored.
      Returns:
      the name of a member in the value class where this key is stored
      Default:
      ""

    • columns

      Column[] columns
      The column(s) for the key
      Returns:
      the column(s) for the key
      Default:
      {}

    • generateForeignKey

      String generateForeignKey
      Generate or assume a foreign key constraint exists on the column or columns associated with this join. Specify "true" or "false".
      Returns:
      whether to generate or assume a foreign key constraint
      Default:
      ""

    • foreignKey

      String foreignKey
      Name for a generated foreign key constraint.
      Returns:
      the name of the generated foreign key constraint
      Default:
      ""

    • extensions

      Extension[] extensions
      Vendor extensions.
      Returns:
      the vendor extensions
      Default:
      {}