Annotation Type ForeignKey


@Target({TYPE,FIELD,METHOD}) @Retention(RUNTIME) public @interface ForeignKey
Annotation for a database foreign-key. Corresponds to the xml element "foreign-key".
Since:
2.1
Version:
2.1
  • Element Details

    • name

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

      String table
      Table for the foreign key. This is needed iff annotating a type where the foreign key is not defined on the primary table for the type.
      Returns:
      the table on which the foreign key is defined
      Default:
      ""
    • deferred

      String deferred
      Whether this foreign key is deferred (constraint is checked only at commit).
      Returns:
      whether this foreign key is deferred
      Default:
      ""
    • unique

      String unique
      Whether this foreign key is unique.
      Returns:
      whether this foreign key is unique
      Default:
      ""
    • deleteAction

      ForeignKeyAction deleteAction
      The delete action of this foreign key.
      Returns:
      the delete action of this foreign key
      Default:
      RESTRICT
    • updateAction

      ForeignKeyAction updateAction
      The update action of this foreign key.
      Returns:
      the update action of this foreign key
      Default:
      RESTRICT
    • members

      String[] members
      Member (field and property) names that compose this foreign key.
      Returns:
      the member names that compose this foreign key
      Default:
      {}
    • columns

      Column[] columns
      Columns that compose this foreign key.
      Returns:
      the columns that compose this foreign key
      Default:
      {}