Module org.jooq.meta

Package org.jooq.meta

Class DefaultColumnDefinition

java.lang.Object

org.jooq.meta.AbstractDefinition

org.jooq.meta.AbstractContainerElementDefinition<TableDefinition>

org.jooq.meta.AbstractTypedElementDefinition<TableDefinition>

org.jooq.meta.DefaultColumnDefinition

All Implemented Interfaces:

ColumnDefinition, ContainerElementDefinition<TableDefinition>, Definition, PositionedDefinition, TypedElementDefinition<TableDefinition>

public class DefaultColumnDefinition
extends AbstractTypedElementDefinition<TableDefinition>
implements ColumnDefinition

A base implementation for column definitions.

Author:

Lukas Eder

Constructor Summary

Constructors

Constructor	Description
DefaultColumnDefinition(TableDefinition table, String name, int position, DataTypeDefinition type, boolean identity, boolean hidden, boolean readonly, String comment)
DefaultColumnDefinition(TableDefinition table, String name, int position, DataTypeDefinition type, boolean identity, boolean readonly, String comment)
DefaultColumnDefinition(TableDefinition table, String name, int position, DataTypeDefinition type, boolean identity, String comment)

Method Summary

Modifier and Type	Method	Description
final List<ForeignKeyDefinition>	getForeignKeys()	All definitions of foreign keys that this column is part of.
final List<UniqueKeyDefinition>	getKeys()	All definitions of unique and primary keys that this column is part of.
final int	getPosition()	The object's 1-based position in the parent.
final UniqueKeyDefinition	getPrimaryKey()	A definition for the primary key that this column is part of, or null if this column is not part of a primary key.
final List<UniqueKeyDefinition>	getUniqueKeys()	All definitions of unique keys that this column is part of.
final boolean	isHidden()	Whether this column is hidden.
final boolean	isIdentity()	Whether this column is the table's IDENTITY column.
final boolean	isReadonly()	Whether this column is readonly.
final boolean	isSynthetic()	Whether the object has been created "synthetically", i.e.

Methods inherited from class org.jooq.meta.AbstractTypedElementDefinition

customType, getDataType, getDefinedType, getDomain, getType, getType, mapDefinedType

Methods inherited from class org.jooq.meta.AbstractContainerElementDefinition

getContainer, getDefinitionPath

Methods inherited from class org.jooq.meta.AbstractDefinition

create, create, equals, getCatalog, getComment, getConnection, getDatabase, getDialect, getInputName, getName, getOutputName, getOverload, getPackage, getPartiallyQualifiedNames, getQualifiedInputName, getQualifiedInputNamePart, getQualifiedName, getQualifiedNamePart, getQualifiedOutputName, getQualifiedOutputNamePart, getSchema, getSource, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooq.meta.ContainerElementDefinition

getContainer

Methods inherited from interface org.jooq.meta.Definition

getCatalog, getComment, getDatabase, getDefinitionPath, getInputName, getName, getOutputName, getOverload, getPackage, getPartiallyQualifiedNames, getQualifiedInputName, getQualifiedInputNamePart, getQualifiedName, getQualifiedNamePart, getQualifiedOutputName, getQualifiedOutputNamePart, getSchema, getSource

Methods inherited from interface org.jooq.meta.TypedElementDefinition

getDefinedType, getDomain, getType, getType

Constructor Details

DefaultColumnDefinition

public DefaultColumnDefinition(TableDefinition table,
 String name,
 int position,
 DataTypeDefinition type,
 boolean identity,
 String comment)

DefaultColumnDefinition

public DefaultColumnDefinition(TableDefinition table,
 String name,
 int position,
 DataTypeDefinition type,
 boolean identity,
 boolean readonly,
 String comment)

DefaultColumnDefinition

public DefaultColumnDefinition(TableDefinition table,
 String name,
 int position,
 DataTypeDefinition type,
 boolean identity,
 boolean hidden,
 boolean readonly,
 String comment)

Method Details

isSynthetic

public final boolean isSynthetic()

Description copied from interface: Definition

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

Specified by:

isSynthetic in interface Definition

getPosition

public final int getPosition()

Description copied from interface: PositionedDefinition

The object's 1-based position in the parent.

[#17434] While in most RDBMS, this value is 1-based and a consecutive ordinal, there may be cases where a positional value is skipped, either by what's reported by the RDBMS's dictionary views, or because the definition is filtered by jOOQ-meta. Users shouldn't rely on the positions reflecting the actually generated column/attribute/etc. position.

Specified by:

getPosition in interface PositionedDefinition

getPrimaryKey

public final UniqueKeyDefinition getPrimaryKey()

Description copied from interface: ColumnDefinition

A definition for the primary key that this column is part of, or null if this column is not part of a primary key.

Specified by:

getPrimaryKey in interface ColumnDefinition

getUniqueKeys

public final List<UniqueKeyDefinition> getUniqueKeys()

Description copied from interface: ColumnDefinition

All definitions of unique keys that this column is part of.

Specified by:

getUniqueKeys in interface ColumnDefinition

getKeys

public final List<UniqueKeyDefinition> getKeys()

Description copied from interface: ColumnDefinition

All definitions of unique and primary keys that this column is part of.

Specified by:

getKeys in interface ColumnDefinition

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys()

Description copied from interface: ColumnDefinition

All definitions of foreign keys that this column is part of.

Specified by:

getForeignKeys in interface ColumnDefinition

isIdentity

public final boolean isIdentity()

Description copied from interface: ColumnDefinition

Whether this column is the table's IDENTITY column.

Specified by:

isIdentity in interface ColumnDefinition

isHidden

public final boolean isHidden()

Description copied from interface: ColumnDefinition

Whether this column is hidden.

Specified by:

isHidden in interface ColumnDefinition

isReadonly

public final boolean isReadonly()

Description copied from interface: ColumnDefinition

Whether this column is readonly.

Specified by:

isReadonly in interface ColumnDefinition