Annotation Type Join

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

  • Element Details

    • table

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

    • column

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

    • indexed

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

    • index

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

    • unique

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

    • uniqueKey

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

    • outer

      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:
      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

      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

      String primaryKey
      Name for a generated primary key constraint.
      Returns:
      the name of the generated primary key constraint
      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:
      {}