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

Interface Definition

All Known Subinterfaces:
ArrayDefinition, AttributeDefinition, CheckConstraintDefinition, ColumnDefinition, ConstraintDefinition, ContainerElementDefinition<T>, DomainDefinition, EmbeddableColumnDefinition, EmbeddableDefinition, EnumDefinition, EnumLiteralDefinition, ForeignKeyDefinition, IdentityDefinition, IndexColumnDefinition, IndexDefinition, InverseForeignKeyDefinition, ManyToManyKeyDefinition, PackageDefinition, ParameterDefinition, PositionedDefinition, RoutineDefinition, SequenceDefinition, SyntheticDaoDefinition, TableDefinition, TableElementDefinition, TypedElementDefinition<T>, UDTDefinition, UniqueKeyDefinition, XMLNamespaceDefinition, XMLSchemaCollectionDefinition, XMLTypeDefinition
All Known Implementing Classes:
AbstractConstraintDefinition, AbstractContainerElementDefinition, AbstractDefinition, AbstractElementContainerDefinition, AbstractIndexDefinition, AbstractPackageDefinition, AbstractRoutineDefinition, AbstractTableDefinition, AbstractTypedElementDefinition, AbstractUDTDefinition, CatalogDefinition, CUBRIDTableDefinition, DefaultArrayDefinition, DefaultAttributeDefinition, DefaultCheckConstraintDefinition, DefaultColumnDefinition, DefaultDomainDefinition, DefaultEmbeddableColumnDefinition, DefaultEmbeddableDefinition, DefaultEnumDefinition, DefaultEnumLiteralDefinition, DefaultForeignKeyDefinition, DefaultIdentityDefinition, DefaultIndexColumnDefinition, DefaultInverseForeignKeyDefinition, DefaultManyToManyKeyDefinition, DefaultMetaTableDefinition, DefaultParameterDefinition, DefaultSequenceDefinition, DefaultSyntheticDaoDefinition, DefaultUniqueKeyDefinition, DefaultXMLNamespaceDefinition, DefaultXMLSchemaCollectionDefinition, DefaultXMLTypeDefinition, DerbyTableDefinition, FirebirdRoutineDefinition, FirebirdTableDefinition, FirebirdTableValuedFunction, H2RoutineDefinition, H2TableDefinition, HSQLDBRoutineDefinition, HSQLDBTableDefinition, HSQLDBTableValuedFunction, MySQLRoutineDefinition, MySQLTableDefinition, PostgresMaterializedViewDefinition, PostgresRoutineDefinition, PostgresTableDefinition, PostgresTableValuedFunction, PostgresUDTDefinition, SchemaDefinition, SQLiteTableDefinition, XMLPackageDefinition, XMLRoutineDefinition, XMLTableDefinition
public interface Definition
A general interface defining any database object, such as tables, views, stored procedures, etc.
Author:
Lukas Eder

  • Method Details

    • getDatabase

      Database getDatabase()
      Returns:
      A reference to the Database context

    • getCatalog

      CatalogDefinition getCatalog()
      Returns:
      The catalog of this object.

    • getSchema

      SchemaDefinition getSchema()
      Returns:
      The schema of this object or null if this object is a CatalogDefinition.

    • getPackage

      PackageDefinition getPackage()
      Returns:
      The package of this object or null if this object is not contained in a package.

    • getName

      String getName()
      Returns:
      The name of this object, e.g. [my_table]. This corresponds to getInputName()

    • getInputName

      String getInputName()
      Returns:
      The name of this object, e.g. [my_table], as defined in the source database.

    • getOutputName

      String getOutputName()
      Returns:
      The name of this object, e.g. [my_table], as defined for the target database. This may differ from the input name if schema / table rewriting is applied.

    • getComment

      String getComment()
      Returns:
      The comment of this object

    • getDefinitionPath

      List<Definition> getDefinitionPath()
      Returns:
      A path of definitions for this definition, e.g. [schema].[package].[routine].[parameter]

    • getQualifiedName

      String getQualifiedName()
      Returns:
      A qualified name for this object (corresponding to getName())

    • getQualifiedInputName

      String getQualifiedInputName()
      Returns:
      A qualified name for this object (corresponding to getInputName())

    • getQualifiedOutputName

      String getQualifiedOutputName()
      Returns:
      A qualified name for this object (corresponding to getOutputName())

    • getQualifiedNamePart

      Name getQualifiedNamePart()
      Returns:
      A qualified name for this object (corresponding to getName())

    • getQualifiedInputNamePart

      Name getQualifiedInputNamePart()
      Returns:
      A qualified name for this object (corresponding to getInputName())

    • getQualifiedOutputNamePart

      Name getQualifiedOutputNamePart()
      Returns:
      A qualified name for this object (corresponding to getOutputName())

    • getPartiallyQualifiedNames

      List<String> getPartiallyQualifiedNames()
      Returns:
      A list of partially qualified names for this definition, going from getName() (unqualified) to getQualifiedName() (fully qualified), mostly used for caching purposes when looking up ForcedType.

    • getOverload

      String getOverload()
      Returns:
      The overload suffix if applicable

    • getSource

      String getSource()
      Returns:
      The source code of this object, if applicable, or null, if no such source code is available.

    • isSynthetic

      default boolean isSynthetic()
      Whether the object has been created "synthetically", i.e. from SyntheticObjectsType, rather than from the underlying meta data source.