Package org.apache.empire.data

Interface ColumnExpr

All Known Subinterfaces:
Column
All Known Implementing Classes:
BeanProperty, DBAbstractFuncExpr, DBAliasExpr, DBCalcExpr, DBCaseExpr, DBCaseMapExpr, DBCaseWhenExpr, DBCmdResultExpr, DBCoalesceExpr, DBColumn, DBColumnExpr, DBCommandExpr.DBCmdColumn, DBConcatExpr, DBConcatFuncExpr, DBConvertExpr, DBCountExpr, DBDecodeExpr, DBFuncExpr, DBParenthesisExpr, DBQueryColumn, DBScalarExpr, DBTableColumn, DBValueExpr, DBVarArgsFuncExpr, DBView.DBViewColumn, OracleRowNumExpr, PostgresBoolAndOrExpr, PostgresFuncExpr, PostgresIntervalExpr
public interface ColumnExpr
The column interface provides methods for accessing metadata that is relevant for managing and displaying data available through the RecordData interface.

  • Method Details

    • getDataType

      DataType getDataType()
      Returns the column's data type.
      Returns:
      the column's data type
      See Also:

    • getName

      String getName()
      Returns the physical column name.
      Returns:
      the physical column name

    • getTitle

      String getTitle()
      Returns the column's display title.
      Returns:
      the column's display title

    • getControlType

      String getControlType()
      Returns the column's control type used for displaying and entering data.
      Returns:
      the column's control type used for displaying and entering data

    • getAttribute

      Object getAttribute(String name)
      Returns a metadata attribute.
      Parameters:
      name - the name of the attribute
      Returns:
      the metadata attribute

    • setAttribute

      <T extends ColumnExpr> T setAttribute(String name, Object value)
      Sets the value of a column attribute.
      Type Parameters:
      T - the column expression type
      Parameters:
      name - the attribute name
      value - the value of the attribute
      Returns:
      returns self (this)

    • getEnumType

      Class<Enum<?>> getEnumType()
      Returns the enum type for this column

      Returns:
      the enum type

    • getOptions

      Options getOptions()
      Returns an option set with possible column values and their corresponding display text.
      Returns:
      option set with possible column values and their corresponding display text

    • getBeanPropertyName

      String getBeanPropertyName()
      Returns the name of a Java bean property to which this column is mapped.
      Returns:
      the name of a Java bean property to which this column is mapped

    • getUpdateColumn

      Column getUpdateColumn()
      Returns the underlying source column (if any). If an expression is based not based on a particutlar column this function returns null.
      Returns:
      the column on which this expression is based or null if not applicable.

    • getSourceColumn

      @Deprecated Column getSourceColumn()
      Deprecated.