Top Description Fields Constructors Methods
org.jooq.impl

public Class UDTImpl<R extends org.jooq.UDTRecord<R>>

extends AbstractNamed
implements UDT<R extends UDTRecord<R>>, FieldsTrait, UNotYetImplemented
Class Inheritance
All Implemented Interfaces
org.jooq.impl.QOM.UNotYetImplemented, org.jooq.impl.QOM.UEmpty, org.jooq.QueryPart, java.io.Serializable, org.jooq.impl.FieldsTrait, org.jooq.Fields, org.jooq.UDT, org.jooq.RecordQualifier, org.jooq.Qualified, org.jooq.Named
Known Direct Subclasses
org.jooq.impl.Snapshot.SnapshotUDT
Annotations
@Internal
Static Imports
org.jooq.impl.Tools.getMappedSchema

Deprecated

as a consequence of QOM.UNotYetImplemented being deprecated. See corresponding docs for further information.

A common base type for UDT's

This type is for JOOQ INTERNAL USE only. Do not reference directly

Author
Lukas Eder

Field Summary

Modifier and TypeField and Description
private final FieldsImpl<R>
fields

private final Package
pkg

private final Schema
schema

private final boolean
synthetic

private transient DataType<R>
type

Constructor Summary

AccessConstructor and Description
public
UDTImpl(String name, Schema schema)

public
UDTImpl(String name, Schema schema, Package pkg)

public
UDTImpl(String name, Schema schema, Package pkg, boolean synthetic)

Method Summary

Modifier and TypeMethod and Description
public final Schema
$schema()

Implements org.jooq.Qualified.$schema.

Experimental query object model accessor method, see also QOM.
public final void
accept(Context<?> ctx)

Implements org.jooq.QueryPartInternal.accept.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
protected static final <R extends UDTRecord<R>, T> UDTField<R, T>
createField(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt)

Deprecated - 3.12.0 - [#8000] - Use createField(Name, DataType, UDT) instead.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T> UDTField<R, T>
createField(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment)

Deprecated - 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String) instead.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U>
createField(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment, Converter<T, U> converter)

Deprecated - 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String, Converter) instead.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U>
createField(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment, Binding<T, U> binding)

Deprecated - 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String, Binding) instead.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T, X, U> UDTField<R, U>
createField(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment, Converter<X, U> converter, Binding<T, X> binding)

Deprecated - 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String, Converter, Binding) instead.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T> UDTField<R, T>
createField(Name
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt)

Deprecated as a consequence of UDTField being deprecated.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T> UDTField<R, T>
createField(Name
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment)

Deprecated as a consequence of UDTField being deprecated.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U>
createField(Name
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment, Converter<T, U> converter)

Deprecated as a consequence of UDTField being deprecated.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U>
createField(Name
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment, Binding<T, U> binding)

Deprecated as a consequence of UDTField being deprecated.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <R extends UDTRecord<R>, T, X, U> UDTField<R, U>
createField(Name
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, UDT<R> udt, String comment, Converter<X, U> converter, Binding<T, X> binding)

Deprecated as a consequence of UDTField being deprecated.
Subclasses may call this method to create UDTField objects that are linked to this table.
pack-priv final FieldsImpl<R>
fields0()

public final Row
fieldsRow()

Implements org.jooq.Fields.fieldsRow.

Get all fields known to this type as a Row.
public final Catalog
getCatalog()

Implements org.jooq.Qualified.getCatalog.

Get the object's catalog.
public final DataType<R>
getDataType()

Implements org.jooq.RecordQualifier.getDataType.

The UDT's or Table's data type as known to the database.
public final Package
getPackage()

Implements org.jooq.RecordQualifier.getPackage.

Get the UDT package if this is a UDT, or null if it is not a UDT, or if it is a schema level UDT defined outside of a package.
public Name
getQualifiedName()

Overrides org.jooq.impl.AbstractNamed.getQualifiedName.

Implements org.jooq.Named.getQualifiedName.

The qualified name of this object.
public Class<R>
getRecordType()

Implements org.jooq.RecordQualifier.getRecordType.

Subclasses must override this method if they use the generic type parameter R for other types than Record
public Schema
getSchema()

Implements org.jooq.Qualified.getSchema.

Get the object's schema.
public final boolean
isSQLUsable()

Implements org.jooq.UDT.isSQLUsable.

Whether this data type can be used from SQL statements.
public final boolean
isSynthetic()

Implements org.jooq.UDT.isSynthetic.

Whether this data type is a synthetic, structural UDT type.
public final R
newRecord()

Implements org.jooq.RecordQualifier.newRecord.

Create a new Record of this UDT's or Table's type.
Inherited from org.jooq.impl.AbstractNamed:
$nameequalsfindfindfindAllfindAllfindIgnoreCasefindIgnoreCasegetCommentgetCommentPartgetNamegetUnqualifiedNamehashCodenameOrDefaultqualify

Field Detail

fieldsback to summary
private final FieldsImpl<R> fields
pkgback to summary
private final Package pkg
schemaback to summary
private final Schema schema
syntheticback to summary
private final boolean synthetic
typeback to summary
private transient DataType<R> type

Constructor Detail

UDTImplback to summary
public UDTImpl(String name, Schema schema)
UDTImplback to summary
public UDTImpl(String name, Schema schema, Package pkg)
UDTImplback to summary
public UDTImpl(String name, Schema schema, Package pkg, boolean synthetic)

Method Detail

$schemaback to summary
public final Schema $schema()

Implements org.jooq.Qualified.$schema.

Doc from org.jooq.Qualified.$schema.

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Override
acceptback to summary
public final void accept(Context<?> ctx)

Implements org.jooq.QueryPartInternal.accept.

Doc from org.jooq.QueryPartInternal.accept.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.

Annotations
@Override
createFieldback to summary
protected static final <R extends UDTRecord<R>, T> UDTField<R, T> createField(String name, DataType<T> type, UDT<R> udt)

Deprecated

- 3.12.0 - [#8000] - Use createField(Name, DataType, UDT) instead.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:String

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

Annotations
@Deprecated
createFieldback to summary
protected static final <R extends UDTRecord<R>, T> UDTField<R, T> createField(String name, DataType<T> type, UDT<R> udt, String comment)

Deprecated

- 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String) instead.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:String

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

Annotations
@Deprecated
createFieldback to summary
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U> createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<T, U> converter)

Deprecated

- 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String, Converter) instead.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:String

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

Annotations
@Deprecated
createFieldback to summary
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U> createField(String name, DataType<T> type, UDT<R> udt, String comment, Binding<T, U> binding)

Deprecated

- 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String, Binding) instead.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:String

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

Annotations
@Deprecated
createFieldback to summary
protected static final <R extends UDTRecord<R>, T, X, U> UDTField<R, U> createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<X, U> converter, Binding<T, X> binding)

Deprecated

- 3.12.0 - [#8000] - Use createField(Name, DataType, UDT, String, Converter, Binding) instead.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:String

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

Annotations
@Deprecated
createFieldback to summary
protected static final <R extends UDTRecord<R>, T> UDTField<R, T> createField(Name name, DataType<T> type, UDT<R> udt)

Deprecated

as a consequence of UDTField being deprecated. See corresponding docs for further information.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:Name

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

createFieldback to summary
protected static final <R extends UDTRecord<R>, T> UDTField<R, T> createField(Name name, DataType<T> type, UDT<R> udt, String comment)

Deprecated

as a consequence of UDTField being deprecated. See corresponding docs for further information.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:Name

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

createFieldback to summary
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U> createField(Name name, DataType<T> type, UDT<R> udt, String comment, Converter<T, U> converter)

Deprecated

as a consequence of UDTField being deprecated. See corresponding docs for further information.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:Name

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

createFieldback to summary
protected static final <R extends UDTRecord<R>, T, U> UDTField<R, U> createField(Name name, DataType<T> type, UDT<R> udt, String comment, Binding<T, U> binding)

Deprecated

as a consequence of UDTField being deprecated. See corresponding docs for further information.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:Name

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

createFieldback to summary
protected static final <R extends UDTRecord<R>, T, X, U> UDTField<R, U> createField(Name name, DataType<T> type, UDT<R> udt, String comment, Converter<X, U> converter, Binding<T, X> binding)

Deprecated

as a consequence of UDTField being deprecated. See corresponding docs for further information.

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters
name:Name

The name of the field (case-sensitive!)

type:DataType<T>

The data type of the field

Annotations
@SuppressWarnings:unchecked
fields0back to summary
pack-priv final FieldsImpl<R> fields0()
fieldsRowback to summary
public final Row fieldsRow()

Implements org.jooq.Fields.fieldsRow.

Doc from org.jooq.Fields.fieldsRow.

Get all fields known to this type as a Row.

Annotations
@Override
getCatalogback to summary
public final Catalog getCatalog()

Implements org.jooq.Qualified.getCatalog.

Doc from org.jooq.Qualified.getCatalog.

Get the object's catalog.

Annotations
@Override
getDataTypeback to summary
public final DataType<R> getDataType()

Implements org.jooq.RecordQualifier.getDataType.

Doc from org.jooq.RecordQualifier.getDataType.

The UDT's or Table's data type as known to the database.

Annotations
@Override
getPackageback to summary
public final Package getPackage()

Implements org.jooq.RecordQualifier.getPackage.

Doc from org.jooq.RecordQualifier.getPackage.

Get the UDT package if this is a UDT, or null if it is not a UDT, or if it is a schema level UDT defined outside of a package.

Annotations
@Override
getQualifiedNameback to summary
public Name getQualifiedName()

Overrides org.jooq.impl.AbstractNamed.getQualifiedName.

Implements org.jooq.Named.getQualifiedName.

Doc from org.jooq.Named.getQualifiedName.

The qualified name of this object.

Annotations
@Override
getRecordTypeback to summary
public Class<R> getRecordType()

Implements org.jooq.RecordQualifier.getRecordType.

Subclasses must override this method if they use the generic type parameter R for other types than Record

Annotations
@Override
getSchemaback to summary
public Schema getSchema()

Implements org.jooq.Qualified.getSchema.

Doc from org.jooq.Qualified.getSchema.

Get the object's schema.

Annotations
@Override
isSQLUsableback to summary
public final boolean isSQLUsable()

Implements org.jooq.UDT.isSQLUsable.

Doc from org.jooq.UDT.isSQLUsable.

Whether this data type can be used from SQL statements.

Annotations
@Override
isSyntheticback to summary
public final boolean isSynthetic()

Implements org.jooq.UDT.isSynthetic.

Doc from org.jooq.UDT.isSynthetic.

Whether this data type is a synthetic, structural UDT type.

This is true for example:

  • For Oracle TAB%ROWTYPE references, which are synthetic PL/SQL RECORD types in PL/SQL.
Annotations
@Override
newRecordback to summary
public final R newRecord()

Implements org.jooq.RecordQualifier.newRecord.

Doc from org.jooq.RecordQualifier.newRecord.

Create a new Record of this UDT's or Table's type.

Annotations
@Override