org.jooq.meta

Interface Definition

All Known Subinterfaces:

ArrayDefinition, AttributeDefinition, CheckConstraintDefinition, ColumnDefinition, DomainDefinition, EnumDefinition, ForeignKeyDefinition, IdentityDefinition, IndexColumnDefinition, IndexDefinition, PackageDefinition, ParameterDefinition, RoutineDefinition, SequenceDefinition, TableDefinition, TypedElementDefinition<T>, UDTDefinition, UniqueKeyDefinition

All Known Implementing Classes:

AbstractDefinition, AbstractElementContainerDefinition, AbstractIndexDefinition, AbstractPackageDefinition, AbstractRoutineDefinition, AbstractTableDefinition, AbstractTypedElementDefinition, AbstractUDTDefinition, CatalogDefinition, CUBRIDTableDefinition, DefaultArrayDefinition, DefaultAttributeDefinition, DefaultCheckConstraintDefinition, DefaultColumnDefinition, DefaultDomainDefinition, DefaultEnumDefinition, DefaultForeignKeyDefinition, DefaultIdentityDefinition, DefaultIndexColumnDefinition, DefaultParameterDefinition, DefaultSequenceDefinition, DefaultUniqueKeyDefinition, DerbyTableDefinition, FirebirdRoutineDefinition, FirebirdTableDefinition, FirebirdTableValuedFunction, H2RoutineDefinition, H2TableDefinition, HSQLDBRoutineDefinition, HSQLDBTableDefinition, JDBCTableDefinition, 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 Summary

Modifier and Type	Method and Description
CatalogDefinition	getCatalog()
String	getComment()
Database	getDatabase()
List<Definition>	getDefinitionPath()
String	getInputName()
String	getName()
String	getOutputName()
String	getOverload()
String	getQualifiedInputName()
Name	getQualifiedInputNamePart()
String	getQualifiedName()
Name	getQualifiedNamePart()
String	getQualifiedOutputName()
Name	getQualifiedOutputNamePart()
SchemaDefinition	getSchema()

Method Detail

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.

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())

getOverload

String getOverload()

Returns:

The overload suffix if applicable