Package javax.jdo.annotations

Annotation Type Join

  • @Target({TYPE,FIELD,METHOD})
@Retention(RUNTIME)
@Repeatable(Joins.class)
public @interface Join
    Annotation for the join of a relation. Corresponds to the xml element "join".
    Since:
    2.1
    Version:
    2.1

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String column
      Name of the column in the join table.
      Column[] columns
      Detail definition of the join column(s).
      ForeignKeyAction deleteAction
      Delete action to be applied to any ForeignKey on this join.
      Extension[] extensions
      Vendor extensions.
      java.lang.String foreignKey
      Name for a generated foreign key constraint.
      java.lang.String generateForeignKey
      Generate or assume a foreign key constraint exists on the column or columns associated with this join.
      java.lang.String generatePrimaryKey
      Generate or assume a primary key constraint exists on the column or columns associated with this join.
      java.lang.String index
      The name of the index to generate.
      java.lang.String indexed
      Whether the join column is indexed.
      java.lang.String outer
      Whether to use an outer join.
      java.lang.String primaryKey
      Name for a generated primary key constraint.
      java.lang.String table
      Table to join to (used when joining to secondary tables).
      java.lang.String unique
      Whether the join column is unique.
      java.lang.String uniqueKey
      The name of the unique key constraint to generate.

    • Element Detail

      • table

        java.lang.String table
        Table to join to (used when joining to secondary tables).
        Returns:
        the table
        Default:
        ""

      • column

        java.lang.String column
        Name of the column in the join table.
        Returns:
        the name of the column in the join table
        Default:
        ""

      • indexed

        java.lang.String indexed
        Whether the join column is indexed.
        Returns:
        whether the join column(s) is(are) indexed
        Default:
        ""

      • index

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

      • unique

        java.lang.String unique
        Whether the join column is unique.
        Returns:
        whether the join column(s) is(are) is unique
        Default:
        ""

      • uniqueKey

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

      • outer

        java.lang.String outer
        Whether to use an outer join.
        Returns:
        whether to use an outer join
        Default:
        ""

      • deleteAction

        ForeignKeyAction deleteAction
        Delete action to be applied to any ForeignKey on this join.
        Returns:
        the delete action
        Default:
        javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED

      • columns

        Column[] columns
        Detail definition of the join column(s). This is needed for more than one join column.
        Returns:
        the join columns
        Default:
        {}

      • generatePrimaryKey

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

      • primaryKey

        java.lang.String primaryKey
        Name for a generated primary key constraint.
        Returns:
        the name of the generated primary key constraint
        Default:
        ""

      • generateForeignKey

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

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