Interface TableMetaInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
SingleTableConfig
public interface TableMetaInfo extends Serializable
This interface defines a few methods that returns extra infos (hints) about a table.
Author:
Karl Eilebrecht

  • Method Details

    • tableName

      String tableName()
      Returns:
      name of the SQL-table

    • idColumnName

      String idColumnName()
      Returns the id-column name of the table for joining and result retrieval.

      • Every table in a setup must have a single id-column.
      • The ID-columns of all tables within a setup must be of the same SQL-type.
      • The concrete type of the ID-column is not relevant and thus not specified here.
      Returns:
      name of the SQL-table's ID-column

    • tableNature

      TableNature tableNature()
      Returns:
      information about the characteristics of this table

    • tableFilters

      List<FilterColumn> tableFilters()
      List of filter columns defined on the table, these filters will be applied whenever a query selects data from the table.