Package org.eclnt.ccee.db.dofw.annotations

Annotation Interface doproperty

@Retention(RUNTIME) @Inherited public @interface doproperty

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autoIncrement
    Indicates that a field is automatically set by the database, typically due to autoincrement / serial features.
    boolean
    autoIncrementExcludeFromUpdate
    Additional specification to the autoIncrement() attribute: if the field is not part of the key then by default the field content still can be set by the application and as consequence the field is part of the UPDATE statement when updating existing data.
    boolean
    boolean2int
    Data type mapping rule: Java data type is Boolean, SQL data type is String.
    ENUMBooleanDefault
    boolean2StringDefault
    If the string representation of the boolean neither matches "true" or "false" then the default value that is passed back can be explicitly defined.
    boolean
    boolean2StringJN
    Data type mapping rule: Java data type is Boolean, SQL data type is string.
    boolean
    boolean2StringX
    Data type mapping rule: Java data type is Boolean, SQL data type is string.
    boolean
    boolean2StringYN
    Data type mapping rule: Java data type is Boolean, SQL data type is string.
    String
    column
    Column name, if not set then the column name is assumed to be the same as the property name.
    boolean
    date2long
    Data type mapping rule: Java data type is Date, SQL data type is Long.
    boolean
    date2longYYMMDD
    Data type mapping rule: Java data type is Date, SQL data type is Long.
    boolean
    date2longYYYYMMDD
    Data type mapping rule: Java data type is Date, SQL data type is Long.
    String
    dbNullValue
    In some scenarios a database value is set e.g. to "0" for indicating that the value is "null".
    boolean
    key
    Indicator that the property is representing a key column.
    boolean
    localDate2longYYMMDD
    Data type mapping rule: Java data type is LocalDate, SQL data type is Long.
    boolean
    localDate2longYYYYMMDD
    Data type mapping rule: Java data type is LocalDate, SQL data type is Long.
    boolean
    onlyReadWithSingleReadOperations
    If set to true then the property is not read during normal query operations - but only is read with "queryOne" and with "reread" operations.
    boolean
    string2bytes64
    Data type mapping rule: Java data type is String.
    boolean
    string2bytesHEX
    Data type mapping rule: Java data type is String.
    ENUMTrim
    trim
    Indicator that the string that is read from the database is trimmed.
    boolean
    uuid2string
    Data type mapping rule: Java data type is UUID.
    String
    YYMMDDCenturyReference
    Data type mapping rule: Java data type is LocalDate, SQL data type is Long.

  • Element Details

    • key

      boolean key
      Indicator that the property is representing a key column.
      Default:
      false

    • column

      String column
      Column name, if not set then the column name is assumed to be the same as the property name.
      Default:
      "UNDEFINED"

    • date2long

      boolean date2long
      Data type mapping rule: Java data type is Date, SQL data type is Long.
      Default:
      false

    • date2longYYYYMMDD

      boolean date2longYYYYMMDD
      Data type mapping rule: Java data type is Date, SQL data type is Long. The long value is representing the date in the format YYYYMMDD.
      Default:
      false

    • date2longYYMMDD

      boolean date2longYYMMDD
      Data type mapping rule: Java data type is Date, SQL data type is Long. The long value is representing the date in the format YYMMDD.
      Default:
      false

    • localDate2longYYYYMMDD

      boolean localDate2longYYYYMMDD
      Data type mapping rule: Java data type is LocalDate, SQL data type is Long. The long value is representing the date in the format YYYYMMDD.
      Default:
      false

    • localDate2longYYMMDD

      boolean localDate2longYYMMDD
      Data type mapping rule: Java data type is LocalDate, SQL data type is Long. The long value is representing the date in the format YYMMDD.
      Default:
      false

    • YYMMDDCenturyReference

      String YYMMDDCenturyReference
      Data type mapping rule: Java data type is LocalDate, SQL data type is Long. The long value is representing the date in the format YYMMDD. There is an additional column that represents the century. Example the field contains "221004" and the additional field is "20", so the full data is "20221004".
      Default:
      "UNDEFINED"

    • boolean2StringX

      boolean boolean2StringX
      Data type mapping rule: Java data type is Boolean, SQL data type is string. "true" is represented by "X" and "false" is represented by " ".
      Default:
      false

    • boolean2StringJN

      boolean boolean2StringJN
      Data type mapping rule: Java data type is Boolean, SQL data type is string. "true" is represented by "J" and "false" is represented by "N".
      Default:
      false

    • boolean2StringYN

      boolean boolean2StringYN
      Data type mapping rule: Java data type is Boolean, SQL data type is string. "true" is represented by "Y" and "false" is represented by "N".
      Default:
      false

    • boolean2StringDefault

      ENUMBooleanDefault boolean2StringDefault
      If the string representation of the boolean neither matches "true" or "false" then the default value that is passed back can be explicitly defined.
      Default:
      FALSE

    • boolean2int

      boolean boolean2int
      Data type mapping rule: Java data type is Boolean, SQL data type is String. "true" is represented by "X" and "false" is represented by null.
      Default:
      false

    • trim

      ENUMTrim trim
      Indicator that the string that is read from the database is trimmed.
      Default:
      undefined

    • string2bytes64

      boolean string2bytes64
      Data type mapping rule: Java data type is String. SQL type is array of Byte.
      Default:
      false

    • string2bytesHEX

      boolean string2bytesHEX
      Data type mapping rule: Java data type is String. SQL type is array of Byte.
      Default:
      false

    • uuid2string

      boolean uuid2string
      Data type mapping rule: Java data type is UUID. SQL type is String.
      Default:
      false

    • autoIncrement

      boolean autoIncrement
      Indicates that a field is automatically set by the database, typically due to autoincrement / serial features. As consequence this field will not be set in the INSERT statement.
      Default:
      false

    • autoIncrementExcludeFromUpdate

      boolean autoIncrementExcludeFromUpdate
      Additional specification to the autoIncrement() attribute: if the field is not part of the key then by default the field content still can be set by the application and as consequence the field is part of the UPDATE statement when updating existing data. By setting this attribute to false, you define that the field will also not be part of the UPDATE statement, so the field will never be touched by database operations - it only is read from the database.

      Please pay attention: setting this attribute only makes sense if the attribute autoIncrement() is set to true!
      Default:
      false

    • onlyReadWithSingleReadOperations

      boolean onlyReadWithSingleReadOperations
      If set to true then the property is not read during normal query operations - but only is read with "queryOne" and with "reread" operations. You may switch this annotation to true with Clob-values that should be ignored with normal querying.

      This annotation must not be used with properties that are part of the key of the object.
      Default:
      false

    • dbNullValue

      String dbNullValue
      In some scenarios a database value is set e.g. to "0" for indicating that the value is "null". Here you can define a property value that is used to indicate a null-value.
      Default:
      "UNDEFINED"