org.jooq

Interface RecordType<R extends Record>

public interface RecordType<R extends Record>

A record type for Table, Cursor, Result and other objects.

This type differs from Row in several ways:

• It is generic using <R>
• It is not repeated for degrees 1 to 22, such as Row1 .. RowN
• It is not part of the DSL

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
DataType<?>	dataType(int fieldIndex) Get the data type for a given field index.
DataType<?>	dataType(Name fieldName) Get the data type for a given field name.
DataType<?>	dataType(String fieldName) Get the data type for a given field name.
DataType<?>[]	dataTypes() Get an array of data types for this record type.
<T> Field<T>	field(Field<T> field) Get a specific field from this record type.
Field<?>	field(int fieldIndex) Get a specific field from this record type.
<T> Field<T>	field(int fieldIndex, Class<T> type) Get a specific field from this record type coerced to type.
<T> Field<T>	field(int fieldIndex, DataType<T> dataType) Get a specific field from this record type coerced to dataType.
Field<?>	field(Name fieldName) Get a specific qualified field from this record type.
<T> Field<T>	field(Name fieldName, Class<T> type) Get a specific field from this record type coerced to type.
<T> Field<T>	field(Name fieldName, DataType<T> dataType) Get a specific field from this record type coerced to dataType.
Field<?>	field(String fieldName) Get a specific field from this record type.
<T> Field<T>	field(String fieldName, Class<T> type) Get a specific field from this record type coerced to type.
<T> Field<T>	field(String fieldName, DataType<T> dataType) Get a specific field from this record type coerced to dataType.
Field<?>[]	fields() Get all fields from this record type.
Field<?>[]	fields(Field<?>... fields) Get all fields from this record type, providing some fields.
Field<?>[]	fields(int... fieldIndexes) Get all fields from this record type, providing some field indexes.
Field<?>[]	fields(Name... fieldNames) Get all fields from this record type, providing some field names.
Field<?>[]	fields(String... fieldNames) Get all fields from this record type, providing some field names.
int	indexOf(Field<?> field) Get a field's index from this record type.
int	indexOf(Name fieldName) Get a field's index from this record type.
int	indexOf(String fieldName) Get a field's index from this record type.
int	size() Get the degree of this record type.
Class<?>	type(int fieldIndex) Get the type for a given field index.
Class<?>	type(Name fieldName) Get the type for a given field name.
Class<?>	type(String fieldName) Get the type for a given field name.
Class<?>[]	types() Get an array of types for this record type.

Method Detail

size

int size()

Get the degree of this record type.

field

<T> Field<T> field(Field<T> field)

Get a specific field from this record type.

This will return:

• A field that is the same as the argument field (by identity comparison).
• A field that is equal to the argument field (exact matching fully qualified name).
• A field that is equal to the argument field (partially matching qualified name).
• A field whose name is equal to the name of the argument field.
• null otherwise.

If several fields have the same name, the first one is returned and a warning is logged.

Type Parameters:

T - The generic field type

Parameters:

field - The field to fetch

Returns:

The field itself or an aliased field

field

Field<?> field(String fieldName)

Get a specific field from this record type.

Parameters:

fieldName - The field to fetch

Returns:

The field with the given name

field

<T> Field<T> field(String fieldName,
                   Class<T> type)

Get a specific field from this record type coerced to type.

Parameters:

fieldName - The field to fetch

type - The type to coerce the resulting field to

Returns:

The field with the given name

field

<T> Field<T> field(String fieldName,
                   DataType<T> dataType)

Get a specific field from this record type coerced to dataType.

Parameters:

fieldName - The field to fetch

dataType - The data type to coerce the resulting field to

Returns:

The field with the given name

field

Field<?> field(Name fieldName)

Get a specific qualified field from this record type.

Parameters:

fieldName - The field to fetch

Returns:

The field with the given name

field

<T> Field<T> field(Name fieldName,
                   Class<T> type)

Get a specific field from this record type coerced to type.

Parameters:

fieldName - The field to fetch

type - The type to coerce the resulting field to

Returns:

The field with the given name

field

<T> Field<T> field(Name fieldName,
                   DataType<T> dataType)

Get a specific field from this record type coerced to dataType.

Parameters:

fieldName - The field to fetch

dataType - The data type to coerce the resulting field to

Returns:

The field with the given name

field

Field<?> field(int fieldIndex)

Get a specific field from this record type.

Parameters:

fieldIndex - The field's index of the field to fetch

Returns:

The field with the given name

field

<T> Field<T> field(int fieldIndex,
                   Class<T> type)

Get a specific field from this record type coerced to type.

Parameters:

fieldIndex - The field's index of the field to fetch

type - The type to coerce the resulting field to

Returns:

The field with the given name

field

<T> Field<T> field(int fieldIndex,
                   DataType<T> dataType)

Get a specific field from this record type coerced to dataType.

Parameters:

fieldIndex - The field's index of the field to fetch

dataType - The data type to coerce the resulting field to

Returns:

The field with the given name

fields

Field<?>[] fields()

Get all fields from this record type.

Returns:

All available fields

fields

Field<?>[] fields(Field<?>... fields)

Get all fields from this record type, providing some fields.

Returns:

All available fields

See Also:

field(Field)

fields

Field<?>[] fields(String... fieldNames)

Get all fields from this record type, providing some field names.

Returns:

All available fields

See Also:

field(String)

fields

Field<?>[] fields(Name... fieldNames)

Get all fields from this record type, providing some field names.

Returns:

All available fields

See Also:

field(Name)

fields

Field<?>[] fields(int... fieldIndexes)

Get all fields from this record type, providing some field indexes.

Returns:

All available fields

See Also:

field(int)

indexOf

int indexOf(Field<?> field)

Get a field's index from this record type.

Parameters:

field - The field to look for

Returns:

The field's index or -1 if the field is not contained in this Row

indexOf

int indexOf(String fieldName)

Get a field's index from this record type.

Parameters:

fieldName - The field name to look for

Returns:

The field's index or -1 if the field is not contained in this Row

indexOf

int indexOf(Name fieldName)

Get a field's index from this record type.

Parameters:

fieldName - The field name to look for

Returns:

The field's index or -1 if the field is not contained in this Row

types

Class<?>[] types()

Get an array of types for this record type.

Entries in the resulting array correspond to Field.getType() for the corresponding Field in fields()

type

Class<?> type(int fieldIndex)

Get the type for a given field index.

Parameters:

fieldIndex - The field's index of the field's type to fetch

Returns:

The field's type

type

Class<?> type(String fieldName)

Get the type for a given field name.

Parameters:

fieldName - The field's name of the field's type to fetch

Returns:

The field's type

type

Class<?> type(Name fieldName)

Get the type for a given field name.

Parameters:

fieldName - The field's name of the field's type to fetch

Returns:

The field's type

dataTypes

DataType<?>[] dataTypes()

Get an array of data types for this record type.

Entries in the resulting array correspond to Field.getDataType() for the corresponding Field in fields()

dataType

DataType<?> dataType(int fieldIndex)

Get the data type for a given field index.

Parameters:

fieldIndex - The field's index of the field's data type to fetch

Returns:

The field's data type

dataType

DataType<?> dataType(String fieldName)

Get the data type for a given field name.

Parameters:

fieldName - The field's name of the field's data type to fetch

Returns:

The field's data type

dataType

DataType<?> dataType(Name fieldName)

Get the data type for a given field name.

Parameters:

fieldName - The field's name of the field's data type to fetch

Returns:

The field's data type