Annotation Type Column


@Target({FIELD,METHOD}) @Retention(RUNTIME) public @interface Column
Annotation for a column in the database. Corresponds to the xml element "column".
Since:
2.1
Version:
2.1
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Whether the column allows null values to be inserted.
    Default value for this column.
    Vendor extensions.
    Value to be inserted when this is an "unmapped" column
    JDBC Type for this column.
    int
    Maximum length of data stored in this column.
    Name of the column.
    int
    Scale for the column when handling floating point values.
    SQL Type for this column.
    Target column for this column in the other table when part of a foreign key relation.
    Target member in the other class or interface for this column when part of a bidirectional relation.
  • Element Details

    • name

      String name
      Name of the column.
      Returns:
      the name of the column
      Default:
      ""
    • target

      String target
      Target column for this column in the other table when part of a foreign key relation.
      Returns:
      the target column in the other table for this column when part of a foreign key relation.
      Default:
      ""
    • targetMember

      String targetMember
      Target member in the other class or interface for this column when part of a bidirectional relation.
      Returns:
      the target member for this column when part of a bidirectional relation.
      Default:
      ""
    • jdbcType

      String jdbcType
      JDBC Type for this column.
      Returns:
      JDBC type for this column
      Default:
      ""
    • sqlType

      String sqlType
      SQL Type for this column.
      Returns:
      SQL type for this column
      Default:
      ""
    • length

      int length
      Maximum length of data stored in this column.
      Returns:
      the maximum length of data stored in this column
      Default:
      -1
    • scale

      int scale
      Scale for the column when handling floating point values.
      Returns:
      the scale for the column when handling floating point values
      Default:
      -1
    • allowsNull

      String allowsNull
      Whether the column allows null values to be inserted.
      Returns:
      whether the column allows null values to be inserted
      Default:
      ""
    • defaultValue

      String defaultValue
      Default value for this column.
      Returns:
      the default value for this column
      Default:
      ""
    • insertValue

      String insertValue
      Value to be inserted when this is an "unmapped" column
      Returns:
      the value to be inserted when this is an "unmapped" column
      Default:
      ""
    • extensions

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