Module storm.java
Package st.orm.template

Interface Column

All Known Implementing Classes:
ColumnImpl
public interface Column
Represents metadata about a single column in a database table, as derived from the entity or projection model.

A Column provides information about the column's name, type, nullability, and role (primary key, foreign key, version column, etc.). Columns are obtained from a Model via Model.columns() or Model.declaredColumns().

The index() method returns the 1-based index of the column within the expanded column list of the model, which includes columns from foreign key relationships.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    foreignKey()
    Determines if the column is a foreign key.
    @Nullable String
    function()
    Returns the SQL function whose result a query column stores, which a value compared with the column passes through on the value side: title_folded = fold_accents(?).
    GenerationStrategy
    generation()
    Gets the generation strategy for the primary key.
    int
    index()
    Gets the 1-based index of the column among the model's columns, or 0 for a query column, which has no position among them.
    boolean
    insertable()
    Determines if the column is insertable.
    Metamodel<Data,?>
    metamodel()
    Gets the metamodel of the column.
    String
    name()
    Gets the name of the column.
    boolean
    nullable()
    Determines if the column is nullable.
    boolean
    primaryKey()
    Determines if the column is a primary key.
    boolean
    ref()
    Determines if the column is a ref column.
    String
    sequence()
    Gets the sequence name for generating the primary key, or empty if the primary key is not generated by a sequence.
    Class<?>
    type()
    Gets the type of the column.
    boolean
    updatable()
    Determines if the column is updatable.
    boolean
    version()
    Determines if the column is used for versioning.

  • Method Details

    • index

      int index()
      Gets the 1-based index of the column among the model's columns, or 0 for a query column, which has no position among them.
      Returns:
      the column index.

    • name

      String name()
      Gets the name of the column.
      Returns:
      the column name.

    • type

      Class<?> type()
      Gets the type of the column.
      Returns:
      the type of the column.

    • primaryKey

      boolean primaryKey()
      Determines if the column is a primary key.
      Returns:
      true if it is a primary key, false otherwise.

    • generation

      GenerationStrategy generation()
      Gets the generation strategy for the primary key.
      Returns:
      the generation strategy for the primary key.

    • sequence

      String sequence()
      Gets the sequence name for generating the primary key, or empty if the primary key is not generated by a sequence.
      Returns:
      the sequence name for generating the primary key.

    • foreignKey

      boolean foreignKey()
      Determines if the column is a foreign key.
      Returns:
      true if it is a foreign key, false otherwise.

    • nullable

      boolean nullable()
      Determines if the column is nullable.
      Returns:
      true if the column can be null, false otherwise.

    • insertable

      boolean insertable()
      Determines if the column is insertable.
      Returns:
      true if the column can be inserted, false otherwise.

    • updatable

      boolean updatable()
      Determines if the column is updatable.
      Returns:
      true if the column can be updated, false otherwise.

    • version

      boolean version()
      Determines if the column is used for versioning.
      Returns:
      true if it is a version column, false otherwise.

    • ref

      boolean ref()
      Determines if the column is a ref column.
      Returns:
      if the column is a ref column, false otherwise.

    • function

      @Nullable String function()
      Returns the SQL function whose result a query column stores, which a value compared with the column passes through on the value side: title_folded = fold_accents(?). Null for a column compared with a value as it is, which every column a field maps is.
      Returns:
      the function's name, or null.
      Since:
      1.16

    • metamodel

      Metamodel<Data,?> metamodel()
      Gets the metamodel of the column.

      In case of a foreign key relationship, this metamodel represents the foreign key column on the referencing entity, the entity that declares the foreign key field.

      Returns:
      the metamodel of the column.
      Since:
      1.7