Package com.im.df.api.capabilities

Interface DBFieldCapability

  • All Superinterfaces:
    DFCapability
    public interface DBFieldCapability
extends DFCapability
    The definition of a field that corresponds to a column (or more columns) in a table of a relational database. DBFieldCapability extends DFField and adds properties such as the column name(s) etc.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  DBFieldCapability.DBColumn
      Represents a single database column.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROP_COLUMNS
      Property code name for columns array property.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Class[] getColumnClasses()
      TODO P2 - this method is going to be removed from API.
      java.util.List<DBFieldCapability.DBColumn> getColumns()
      Get the list of database columns for this field (typically only one column).
      java.lang.String getDBSchemaName()
      Gets the name of the database schema for this field's table.
      com.im.commons.db.dml.SQLJoin getJoin()
      Gets the SQLJoin that defines how this field's table is connected with other tables within the table set.
      com.im.commons.db.util.SchemaQualifiedName getSchemaPlusTable()
      Gets this field's table SQN.
      java.lang.String[] getSortColumnNames​(boolean isAscending)
      Get the column names required to sort this field by in order that they need applying.
      boolean[] getSortColumnsAscDesc​(boolean isAscending)
      Get the ascendings/descendings required to sort this field by in order that they need applying
      java.lang.String getTable()
      Gets this field's table name.
      com.im.commons.db.ddl.DBTableInfo getTableInfo()
      Gets the DBTableInfo for this field's columns.
      com.im.commons.db.columnhandling.DBValueHandler getValueHandler()
      Get the value handler for this field.

    • Field Detail

      • PROP_COLUMNS

        static final java.lang.String PROP_COLUMNS
        Property code name for columns array property.
        See Also:
        Constant Field Values

    • Method Detail

      • getTableInfo

        com.im.commons.db.ddl.DBTableInfo getTableInfo()
        Gets the DBTableInfo for this field's columns.
        Returns:
        The DBTableInfo for this field.
        Since:
        5.12

      • getJoin

        com.im.commons.db.dml.SQLJoin getJoin()
        Gets the SQLJoin that defines how this field's table is connected with other tables within the table set.
        Returns:
        This field's table join definition.
        Since:
        6.3

      • getTable

        java.lang.String getTable()
        Gets this field's table name.
        Returns:
        The name of this field's database table.

      • getDBSchemaName

        java.lang.String getDBSchemaName()
        Gets the name of the database schema for this field's table.
        Returns:
        The database schema name where this field's table resides in.

      • getSchemaPlusTable

        com.im.commons.db.util.SchemaQualifiedName getSchemaPlusTable()
        Gets this field's table SQN.
        Returns:
        The schema qualified name for this field's table.

      • getColumns

        java.util.List<DBFieldCapability.DBColumn> getColumns()
        Get the list of database columns for this field (typically only one column).

      • getColumnClasses

        java.lang.Class[] getColumnClasses()
        TODO P2 - this method is going to be removed from API.

        Get the array of classes for all column.

      • getSortColumnNames

        java.lang.String[] getSortColumnNames​(boolean isAscending)
        Get the column names required to sort this field by in order that they need applying. For multi-column fields the order of the columns will be important.

      • getSortColumnsAscDesc

        boolean[] getSortColumnsAscDesc​(boolean isAscending)
        Get the ascendings/descendings required to sort this field by in order that they need applying

      • getValueHandler

        com.im.commons.db.columnhandling.DBValueHandler getValueHandler()
        Get the value handler for this field. The value handler deals with reading and writing values to and from the database as is dependent on the column types used by the field, and unlike the field itself is Serializable and can be passed to lower tiers.
        Returns:
        The value handler for this type of field