Module org.jooq.meta

Package org.jooq.meta

Class AbstractDefinition

java.lang.Object

org.jooq.meta.AbstractDefinition

All Implemented Interfaces:

Definition

Direct Known Subclasses:

AbstractConstraintDefinition, AbstractContainerElementDefinition, AbstractElementContainerDefinition, AbstractIndexDefinition, AbstractPackageDefinition, AbstractRoutineDefinition, CatalogDefinition, DefaultArrayDefinition, DefaultEnumDefinition, DefaultIdentityDefinition, DefaultInverseForeignKeyDefinition, DefaultSyntheticDaoDefinition, DefaultXMLNamespaceDefinition, DefaultXMLSchemaCollectionDefinition, DefaultXMLTypeDefinition, SchemaDefinition

public abstract class AbstractDefinition
extends Object
implements Definition

A base implementation for any type of definition.

Author:

Lukas Eder

Constructor Summary

Constructors

Constructor	Description
AbstractDefinition(Database database, SchemaDefinition schema, String name)
AbstractDefinition(Database database, SchemaDefinition schema, String name, String comment)
AbstractDefinition(Database database, SchemaDefinition schema, String name, String comment, String overload)
AbstractDefinition(Database database, SchemaDefinition schema, PackageDefinition pkg, String name, String comment, String overload)
AbstractDefinition(Database database, SchemaDefinition schema, PackageDefinition pkg, String name, String comment, String overload, String source)

Method Summary

Modifier and Type	Method	Description
protected final DSLContext	create()
protected final DSLContext	create(boolean muteExceptions)
boolean	equals(Object obj)
CatalogDefinition	getCatalog()
final String	getComment()
protected final Connection	getConnection()
final Database	getDatabase()
List<Definition>	getDefinitionPath()
protected final SQLDialect	getDialect()
final String	getInputName()
final String	getName()
String	getOutputName()	Subclasses may override this method
final String	getOverload()
final PackageDefinition	getPackage()
final List<String>	getPartiallyQualifiedNames()
final String	getQualifiedInputName()
final Name	getQualifiedInputNamePart()
final String	getQualifiedName()
final Name	getQualifiedNamePart()
final String	getQualifiedOutputName()
final Name	getQualifiedOutputNamePart()
final SchemaDefinition	getSchema()
final String	getSource()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jooq.meta.Definition

isSynthetic

Constructor Details

AbstractDefinition

public AbstractDefinition(Database database,
 SchemaDefinition schema,
 String name)

AbstractDefinition

public AbstractDefinition(Database database,
 SchemaDefinition schema,
 String name,
 String comment)

AbstractDefinition

public AbstractDefinition(Database database,
 SchemaDefinition schema,
 String name,
 String comment,
 String overload)

AbstractDefinition

public AbstractDefinition(Database database,
 SchemaDefinition schema,
 PackageDefinition pkg,
 String name,
 String comment,
 String overload)

AbstractDefinition

public AbstractDefinition(Database database,
 SchemaDefinition schema,
 PackageDefinition pkg,
 String name,
 String comment,
 String overload,
 String source)

Method Details

getDefinitionPath

public List<Definition> getDefinitionPath()

Specified by:

getDefinitionPath in interface Definition

Returns:

A path of definitions for this definition, e.g. [schema].[package].[routine].[parameter]

getPackage

public final PackageDefinition getPackage()

Specified by:

getPackage in interface Definition

Returns:

The package of this object or null if this object is not contained in a package.

getOverload

public final String getOverload()

Specified by:

getOverload in interface Definition

Returns:

The overload suffix if applicable

getCatalog

public CatalogDefinition getCatalog()

Specified by:

getCatalog in interface Definition

Returns:

The catalog of this object.

getSchema

public final SchemaDefinition getSchema()

Specified by:

getSchema in interface Definition

Returns:

The schema of this object or null if this object is a CatalogDefinition.

getName

public final String getName()

Specified by:

getName in interface Definition

Returns:

The name of this object, e.g. [my_table]. This corresponds to Definition.getInputName()

getInputName

public final String getInputName()

Specified by:

getInputName in interface Definition

Returns:

The name of this object, e.g. [my_table], as defined in the source database.

getOutputName

public String getOutputName()

Subclasses may override this method

Specified by:

getOutputName in interface Definition

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

public final String getComment()

Specified by:

getComment in interface Definition

Returns:

The comment of this object

getQualifiedName

public final String getQualifiedName()

Specified by:

getQualifiedName in interface Definition

Returns:

A qualified name for this object (corresponding to Definition.getName())

getQualifiedInputName

public final String getQualifiedInputName()

Specified by:

getQualifiedInputName in interface Definition

Returns:

A qualified name for this object (corresponding to Definition.getInputName())

getQualifiedOutputName

public final String getQualifiedOutputName()

Specified by:

getQualifiedOutputName in interface Definition

Returns:

A qualified name for this object (corresponding to Definition.getOutputName())

getQualifiedNamePart

public final Name getQualifiedNamePart()

Specified by:

getQualifiedNamePart in interface Definition

Returns:

A qualified name for this object (corresponding to Definition.getName())

getQualifiedInputNamePart

public final Name getQualifiedInputNamePart()

Specified by:

getQualifiedInputNamePart in interface Definition

Returns:

A qualified name for this object (corresponding to Definition.getInputName())

getQualifiedOutputNamePart

public final Name getQualifiedOutputNamePart()

Specified by:

getQualifiedOutputNamePart in interface Definition

Returns:

A qualified name for this object (corresponding to Definition.getOutputName())

getPartiallyQualifiedNames

public final List<String> getPartiallyQualifiedNames()

Specified by:

getPartiallyQualifiedNames in interface Definition

Returns:

A list of partially qualified names for this definition, going from Definition.getName() (unqualified) to Definition.getQualifiedName() (fully qualified), mostly used for caching purposes when looking up ForcedType.

getDatabase

public final Database getDatabase()

Specified by:

getDatabase in interface Definition

Returns:

A reference to the Database context

getConnection

protected final Connection getConnection()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

protected final DSLContext create()

create

protected final DSLContext create(boolean muteExceptions)

getDialect

protected final SQLDialect getDialect()

getSource

public final String getSource()

Specified by:

getSource in interface Definition

Returns:

The source code of this object, if applicable, or null, if no such source code is available.