Package javax.jdo.annotations

Annotation Type ForeignKey

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

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Column[] columns
      Columns that compose this foreign key.
      java.lang.String deferred
      Whether this foreign key is deferred (constraint is checked only at commit).
      ForeignKeyAction deleteAction
      The delete action of this foreign key.
      Extension[] extensions
      Vendor extensions.
      java.lang.String[] members
      Member (field and property) names that compose this foreign key.
      java.lang.String name
      Name of the foreign key.
      java.lang.String table
      Table for the foreign key.
      java.lang.String unique
      Whether this foreign key is unique.
      ForeignKeyAction updateAction
      The update action of this foreign key.

    • Element Detail

      • name

        java.lang.String name
        Name of the foreign key.
        Returns:
        the name of the foreign key
        Default:
        ""

      • table

        java.lang.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

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

      • unique

        java.lang.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:
        javax.jdo.annotations.ForeignKeyAction.RESTRICT

      • updateAction

        ForeignKeyAction updateAction
        The update action of this foreign key.
        Returns:
        the update action of this foreign key
        Default:
        javax.jdo.annotations.ForeignKeyAction.RESTRICT

      • members

        java.lang.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:
        {}

      • extensions

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