Module org.jooq.meta

Package org.jooq.meta

Interface EmbeddableColumnDefinition

All Superinterfaces:

ContainerElementDefinition<EmbeddableDefinition>, Definition, PositionedDefinition, TypedElementDefinition<EmbeddableDefinition>

All Known Implementing Classes:

DefaultEmbeddableColumnDefinition

public interface EmbeddableColumnDefinition
extends TypedElementDefinition<EmbeddableDefinition>, PositionedDefinition

An interface defining a column of an embeddable type.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
ColumnDefinition	getReferencingColumn()	The referencing column definition.
int	getReferencingColumnPosition()	The PositionedDefinition.getPosition() of getReferencingColumn() within its defining table.
DataTypeDefinition	getType()	The data type definition of the embeddable.
void	merge(EmbeddableColumnDefinition other)	Merge type information of another referencing EmbeddableColumnDefinition into this EmbeddableColumnDefinition.

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, isSynthetic

Methods inherited from interface org.jooq.meta.PositionedDefinition

getPosition

Methods inherited from interface org.jooq.meta.TypedElementDefinition

getDefinedType, getDomain, getType

Method Details

getReferencingColumn

ColumnDefinition getReferencingColumn()

The referencing column definition.

getType

DataTypeDefinition getType()

The data type definition of the embeddable.

This may be different from the data type definition of the getReferencingColumn(), depending on what merge(EmbeddableColumnDefinition) produced as a result e.g. of merging multiple distinct nullabilities.

Specified by:

getType in interface TypedElementDefinition<EmbeddableDefinition>

getReferencingColumnPosition

int getReferencingColumnPosition()

The PositionedDefinition.getPosition() of getReferencingColumn() within its defining table.

[#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.

merge

void merge(EmbeddableColumnDefinition other)

Merge type information of another referencing EmbeddableColumnDefinition into this EmbeddableColumnDefinition.

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.