Module storm
Package st.orm.template

Interface Column

All Known Implementing Classes:
ColumnImpl
public interface Column
Represents a column in a database table.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    autoGenerated()
    Determines if the column is auto-generated, which is typical for primary keys.
    boolean
    foreignKey()
    Determines if the column is a foreign key.
    int
    index()
    Gets the 1-based index of the column.
    boolean
    insertable()
    Determines if the column is insertable.
    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.
    String
    qualifiedName(SqlDialect dialect)
    Gets the qualified name of the column including escape characters where necessary.
    boolean
    ref()
    Determines if the column is a ref column.
    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.
      Returns:
      the column index.

    • name

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

    • qualifiedName

      String qualifiedName(@Nonnull SqlDialect dialect)
      Gets the qualified name of the column including escape characters where necessary.
      Parameters:
      dialect - the SQL dialect.
      Returns:
      the qualified 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.

    • autoGenerated

      boolean autoGenerated()
      Determines if the column is auto-generated, which is typical for primary keys.
      Returns:
      true if auto-generated, false otherwise.

    • 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.