Module org.jooq.meta

Package org.jooq.meta

Interface UDTDefinition

All Superinterfaces:

Definition, PackageDefinition

All Known Implementing Classes:

AbstractUDTDefinition, PostgresUDTDefinition

public interface UDTDefinition
extends PackageDefinition

A definition for a UDT

This extends PackageDefinition because Oracle internally models UDT's in similar ways as packages. This is especially true for the way, member procedures and functions are called.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
AttributeDefinition	getAttribute(int attributeIndex)	Get an attribute in this UDT by its index (starting at 0)
AttributeDefinition	getAttribute(String attributeName)	Get an attribute in this UDT by its name
List<AttributeDefinition>	getAttributes()	All attributes in the UDT
List<RoutineDefinition>	getRoutines()	All routines in the UDT
List<UDTDefinition>	getSubtypes()	The subtypes of this UDT, if any.
UDTDefinition	getSupertype()	The supertype of this UDT, if any.
boolean	isInstantiable()	Whether the UDT is instantiable.
boolean	isInTypeHierarchy()	Whether this UDT has either subtypes or supertypes or both.
boolean	isSynthetic()	Whether this UDT is a synthetic type.

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.PackageDefinition

getConstants, getUDTs

Method Details

getAttributes

List<AttributeDefinition> getAttributes()

All attributes in the UDT

getAttribute

AttributeDefinition getAttribute(String attributeName)

Get an attribute in this UDT by its name

getAttribute

AttributeDefinition getAttribute(int attributeIndex)

Get an attribute in this UDT by its index (starting at 0)

getRoutines

List<RoutineDefinition> getRoutines()

All routines in the UDT

Specified by:

getRoutines in interface PackageDefinition

isSynthetic

boolean isSynthetic()

Whether this UDT is a synthetic type.

Specified by:

isSynthetic in interface Definition

isInTypeHierarchy

boolean isInTypeHierarchy()

Whether this UDT has either subtypes or supertypes or both.

getSubtypes

List<UDTDefinition> getSubtypes()

The subtypes of this UDT, if any.

getSupertype

UDTDefinition getSupertype()

The supertype of this UDT, if any.

isInstantiable

boolean isInstantiable()

Whether the UDT is instantiable.