Package com.basis.api.admin

Interface BBjAdminColumn

All Superinterfaces:
BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote
All Known Subinterfaces:
BBjAdminBBjColumn, BBjAdminESQLColumn, BBjAdminLegacyColumn
public interface BBjAdminColumn extends BBjAdminPropertyWriter
An individual column in a table.

  • Field Details

    • FLAG_VARIABLE_LENGTH

      static final int FLAG_VARIABLE_LENGTH
      See Also:

    • FLAG_VARIABLE_TERMINATED

      static final int FLAG_VARIABLE_TERMINATED
      See Also:

    • FLAG_VARIABLE_PADDED

      static final int FLAG_VARIABLE_PADDED
      See Also:

    • FLAG_VARIABLE_ESCAPED

      static final int FLAG_VARIABLE_ESCAPED
      See Also:

    • FLAG_BINARY

      static final int FLAG_BINARY
      See Also:

    • BBX_NATIVE_TYPE

      static final String BBX_NATIVE_TYPE
      Native BBx string template type for this column.
      See Also:

    • BBX_TYPE

      static final String BBX_TYPE
      Either a native BBx string template type or a type def type name.
      See Also:

    • DESCRIPTION

      static final String DESCRIPTION
      Description of the column.
      See Also:

    • DICTIONARY_LENGTH

      static final String DICTIONARY_LENGTH
      See Also:

    • DIM

      static final String DIM
      See Also:

    • FIELD

      static final String FIELD
      Field number within the record. This is BBx "field" which corresponds to the variable length columns.
      See Also:

    • FLAG

      static final String FLAG
      Special indicator that corresponds to the FLAG_ constants in this interface.
      See Also:

    • NAME

      static final String NAME
      Name of the column.
      See Also:

    • OFFSET

      static final String OFFSET
      Offset within the field within the raw record data.
      See Also:

    • EQUALITY_OPTIMIZE_NUMERICS

      static final String EQUALITY_OPTIMIZE_NUMERICS
      Override for the default setting at the database level. Use this to specify that this specific column's data is laid out in a way that supports or does not support the use of the numeric value in optimizations for equality comparisons. If the column uses padding at the beginning of the value to right-align data in the raw byte data, this must be false or the database level setting must be false.
      See Also:

    • FULLY_OPTIMIZE_NUMERICS

      static final String FULLY_OPTIMIZE_NUMERICS
      See Also:

    • ORDINAL

      static final String ORDINAL
      Ordinal defining the order of the columns in the table.
      See Also:

    • ORIGINAL_NAME

      static final String ORIGINAL_NAME
      See Also:

    • PRECISION

      static final String PRECISION
      Total number of digits available for numeric type values or the length the value for character-based values.
      See Also:

    • SCALE

      static final String SCALE
      Number of digits available after the decimal point for numeric type columns.
      See Also:

    • SCHEMA

      static final String SCHEMA
      Schema for the column's parent table.
      See Also:

    • SQL_TYPE

      static final String SQL_TYPE
      The standard SQL data type for this column. This is an integer value that corresponds to the constants in the java.sql.Types class (e.g. Types.INTEGER, Types.VARCHAR, etc.).
      See Also:

    • TABLE

      static final String TABLE
      String value containing the name of this column's parent table.
      See Also:

    • UNIQUE_ID

      static final String UNIQUE_ID
      A unique string identifier for the column. This is only used internally.
      See Also:

    • PAD_TERMINATOR

      static final String PAD_TERMINATOR
      Integer value. The pad or terminator character for variable length terminated/padded values. This is the value that would correspond to the = modifier in a string template definition for a string value. For example, MY_COL:C(15*=10), MY_OTHER:C(15**=32)
      See Also:

  • Method Details

    • getColumn

      com.basis.sql.database.Column getColumn() throws BBjAdminException
      Returns a Column instance for this BBjAdminColumn. This is a method used internally and should not be used by third party developers.
      Returns:
      A Column instance.
      Throws:
      BBjAdminException

    • getDescriptiveProperties

      BBjAdminList<BBjAdminProperty> getDescriptiveProperties() throws BBjAdminException
      Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To get property values for general purposes, you should call the getXXX() methods.
      Returns:
      BBjAdminList containing BBjAdminProperty objects for each available property.
      Throws:
      BBjAdminException

    • setDescriptiveProperties

      void setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps) throws BBjAdminException
      Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To set property values for general purposes, you should call the setXXX() methods.
      Throws:
      BBjAdminException