Module org.jooq.meta
Package org.jooq.meta

Interface EmbeddableDefinition

All Superinterfaces:
Definition, TableElementDefinition
All Known Implementing Classes:
DefaultEmbeddableDefinition
public interface EmbeddableDefinition extends TableElementDefinition
The definition of an embeddable type.
Author:
Lukas Eder

  • Method Details

    • getDefiningTable

      TableDefinition getDefiningTable()
      The table defining the embeddable (same as TableElementDefinition.getTable()).

    • getReferencingComment

      String getReferencingComment()
      The referencing comment of this embeddable, if it differs from the defining name (Definition.getComment()).

    • getReferencingName

      String getReferencingName()
      The referencing name of this embeddable, if it differs from the defining name (Definition.getName()).

    • getReferencingInputName

      String getReferencingInputName()
      The referencing input name of this embeddable, if it differs from the defining name (Definition.getInputName()).

    • getReferencingOutputName

      String getReferencingOutputName()
      The referencing output name of this embeddable, if it differs from the defining name (Definition.getOutputName()).

    • getReferencingTable

      TableDefinition getReferencingTable()
      The table referencing the embeddable.

    • getColumns

      List<EmbeddableColumnDefinition> getColumns()
      All defining columns in the type, table or view.

    • getColumn

      EmbeddableColumnDefinition getColumn(String columnName)
      Get a defining column in this type by its name.

    • getColumn

      EmbeddableColumnDefinition getColumn(String columnName, boolean ignoreCase)
      Get a defining column in this type by its name.

    • getColumn

      EmbeddableColumnDefinition getColumn(int columnIndex)
      Get a defining column in this type by its index (starting at 0).

    • getReferencingColumn

      EmbeddableColumnDefinition getReferencingColumn(String columnName)
      Get a referencing column in this type by its referencing name.

    • getReferencingColumn

      EmbeddableColumnDefinition getReferencingColumn(String columnName, boolean ignoreCase)
      Get a referencing column in this type by its referencing name.

    • replacesFields

      boolean replacesFields()
      Whether this embeddable replaces the fields it represents.

    • merge

      void merge(EmbeddableDefinition other)
      Merge type information of another EmbeddableDefinition into this EmbeddableDefinition.

      Multiple referencing column definitions can be used to define an embeddable column definition. The types and constraints on these alternative references may differ. For example, one column may be nullable, others may not be nullable.