org.jooq.RecordType Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
/**
* A record type for {@link Table}, {@link Cursor}, {@link Result} and other
* objects.
*
* This type differs from {@link Row} in several ways:
*
* - It is generic using
<R>
* - It is not repeated for degrees 1 to 22, such as {@link Row1} ..
* {@link RowN}
* - It is not part of the DSL
*
*
* @author Lukas Eder
*/
public interface RecordType {
/**
* Get the degree of this record type.
*/
int size();
/**
* 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.
*
* @param The generic field type
* @param field The field to fetch
* @return The field itself or an aliased field
*/
Field field(Field field);
/**
* Get a specific field from this record type.
*
* @param fieldName The field to fetch
* @return The field with the given name
*/
Field field(String fieldName);
/**
* Get a specific field from this record type coerced to type.
*
* @param fieldName The field to fetch
* @param type The type to coerce the resulting field to
* @return The field with the given name
*/
Field field(String fieldName, Class type);
/**
* Get a specific field from this record type coerced to dataType.
*
* @param fieldName The field to fetch
* @param dataType The data type to coerce the resulting field to
* @return The field with the given name
*/
Field field(String fieldName, DataType dataType);
/**
* Get a specific qualified field from this record type.
*
* @param fieldName The field to fetch
* @return The field with the given name
*/
Field field(Name fieldName);
/**
* Get a specific field from this record type coerced to type.
*
* @param fieldName The field to fetch
* @param type The type to coerce the resulting field to
* @return The field with the given name
*/
Field field(Name fieldName, Class type);
/**
* Get a specific field from this record type coerced to dataType.
*
* @param fieldName The field to fetch
* @param dataType The data type to coerce the resulting field to
* @return The field with the given name
*/
Field field(Name fieldName, DataType dataType);
/**
* Get a specific field from this record type.
*
* @param fieldIndex The field's index of the field to fetch
* @return The field with the given name
*/
Field field(int fieldIndex);
/**
* Get a specific field from this record type coerced to type.
*
* @param fieldIndex The field's index of the field to fetch
* @param type The type to coerce the resulting field to
* @return The field with the given name
*/
Field field(int fieldIndex, Class type);
/**
* Get a specific field from this record type coerced to dataType.
*
* @param fieldIndex The field's index of the field to fetch
* @param dataType The data type to coerce the resulting field to
* @return The field with the given name
*/
Field field(int fieldIndex, DataType dataType);
/**
* Get all fields from this record type.
*
* @return All available fields
*/
Field[] fields();
/**
* Get all fields from this record type, providing some fields.
*
* @return All available fields
* @see #field(Field)
*/
Field[] fields(Field... fields);
/**
* Get all fields from this record type, providing some field names.
*
* @return All available fields
* @see #field(String)
*/
Field[] fields(String... fieldNames);
/**
* Get all fields from this record type, providing some field names.
*
* @return All available fields
* @see #field(Name)
*/
Field[] fields(Name... fieldNames);
/**
* Get all fields from this record type, providing some field indexes.
*
* @return All available fields
* @see #field(int)
*/
Field[] fields(int... fieldIndexes);
/**
* Get a field's index from this record type.
*
* @param field The field to look for
* @return The field's index or -1 if the field is not
* contained in this Row
*/
int indexOf(Field field);
/**
* Get a field's index from this record type.
*
* @param fieldName The field name to look for
* @return The field's index or -1 if the field is not
* contained in this Row
*/
int indexOf(String fieldName);
/**
* Get a field's index from this record type.
*
* @param fieldName The field name to look for
* @return The field's index or -1 if the field is not
* contained in this Row
*/
int indexOf(Name fieldName);
/**
* Get an array of types for this record type.
*
* Entries in the resulting array correspond to {@link Field#getType()} for
* the corresponding Field in {@link #fields()}
*/
Class[] types();
/**
* Get the type for a given field index.
*
* @param fieldIndex The field's index of the field's type to fetch
* @return The field's type
*/
Class type(int fieldIndex);
/**
* Get the type for a given field name.
*
* @param fieldName The field's name of the field's type to fetch
* @return The field's type
*/
Class type(String fieldName);
/**
* Get the type for a given field name.
*
* @param fieldName The field's name of the field's type to fetch
* @return The field's type
*/
Class type(Name fieldName);
/**
* Get an array of data types for this record type.
*
* Entries in the resulting array correspond to {@link Field#getDataType()}
* for the corresponding Field in {@link #fields()}
*/
DataType[] dataTypes();
/**
* Get the data type for a given field index.
*
* @param fieldIndex The field's index of the field's data type to fetch
* @return The field's data type
*/
DataType dataType(int fieldIndex);
/**
* Get the data type for a given field name.
*
* @param fieldName The field's name of the field's data type to fetch
* @return The field's data type
*/
DataType dataType(String fieldName);
/**
* Get the data type for a given field name.
*
* @param fieldName The field's name of the field's data type to fetch
* @return The field's data type
*/
DataType dataType(Name fieldName);
}