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 and 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
PackageDefinition	getPackage() The UDT's package.
List<RoutineDefinition>	getRoutines() All routines in the UDT
boolean	isSynthetic() Whether this UDT is a synthetic type.

Methods inherited from interface org.jooq.meta.PackageDefinition

getConstants, getUDTs

Methods inherited from interface org.jooq.meta.Definition

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

Method Detail

getPackage

PackageDefinition getPackage()

The UDT's package. null if the UDT is not in a package

Specified by:

getPackage in interface Definition

Returns:

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

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.