/*
* 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;
import java.io.OutputStream;
import java.io.Writer;
import java.lang.reflect.Constructor;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLData;
import java.sql.Statement;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;
import javax.annotation.Generated;
import javax.persistence.Column;
import org.jooq.exception.DataTypeException;
import org.jooq.exception.IOException;
import org.jooq.exception.MappingException;
import org.jooq.impl.DefaultRecordMapper;
import org.jooq.impl.DefaultRecordMapperProvider;
import org.jooq.tools.Convert;
/**
* A database result record.
* <p>
* A record essentially combines a list of columns ({@link Field}) with a
* corresponding list of values, each value being of the respective field's
* type.
* <p>
* While records can be seen as generic column / value mappings, their concrete
* implementations often specialise the above description in any of the
* following ways:
* <p>
* <h5>Table records</h5>
* <p>
* Records originating from a concrete database table (or view) are modelled by
* jOOQ as {@link TableRecord} or {@link UpdatableRecord}, if they contain a
* primary key. If you're using jOOQ's code generator, you can generate even
* more concrete types of table records, i.e. one table record per table.
* <p>
* <h5>UDT records</h5>
* <p>
* {@link SQLDialect#ORACLE} and {@link SQLDialect#POSTGRES} formally support
* user defined types (UDT), which are modelled by jOOQ as {@link UDTRecord}. In
* addition to being regular records (column / value mappings), they also
* implement the JDBC {@link SQLData} API in order to be streamed to a JDBC
* {@link PreparedStatement} or from a JDBC {@link ResultSet}
* <p>
* <h5>Records of well-defined degree</h5>
* <p>
* When projecting custom record types in SQL, new ad-hoc types of a certain
* degree are formed on the fly. Records with degree <= 22 are reflected by
* jOOQ through the {@link Record1}, {@link Record2}, ... {@link Record22}
* classes, which cover the respective row value expressions {@link Row1},
* {@link Row2}, ... {@link Row22}
* <p>
* Note that generated <code>TableRecords</code> and <code>UDTRecords</code>
* also implement a <code>Record[N]</code> interface, if <code>N <= 22</code>
* <p>
* <h5>Record implements Comparable</h5>
* <p>
* jOOQ records have a natural ordering implemented in the same way as this is
* defined in the SQL standard. For more details, see the
* {@link #compareTo(Record)} method
*
* @author Lukas Eder
* @see Result
*/
public interface Record extends Attachable, Comparable<Record> {
/**
* Get this record's fields as a {@link Row}.
*/
Row fieldsRow();
/**
* Get a specific field from this Record.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased table, the field will be aliased accordingly.
*
* @see Row#field(Field)
*/
<T> Field<T> field(Field<T> field);
/**
* Get a specific field from this Record.
*
* @see Row#field(String)
*/
Field<?> field(String name);
/**
* Get a specific qualified field from this Record.
*
* @see Row#field(Name)
*/
Field<?> field(Name name);
/**
* Get a specific field from this Record.
*
* @see Row#field(int)
*/
Field<?> field(int index);
/**
* Get all fields from this Record.
*
* @see Row#fields()
*/
Field<?>[] fields();
/**
* Get all fields from this Record, providing some fields.
*
* @return All available fields
* @see Row#fields(Field...)
*/
Field<?>[] fields(Field<?>... fields);
/**
* Get all fields from this Record, providing some field names.
*
* @return All available fields
* @see Row#fields(String...)
*/
Field<?>[] fields(String... fieldNames);
/**
* Get all fields from this Record, providing some field names.
*
* @return All available fields
* @see Row#fields(Name...)
*/
Field<?>[] fields(Name... fieldNames);
/**
* Get all fields from this Record, providing some field indexes.
*
* @return All available fields
* @see Row#fields(int...)
*/
Field<?>[] fields(int... fieldIndexes);
/**
* Get this record's values as a {@link Row}.
*/
Row valuesRow();
/**
* Get a value from this Record, providing a field.
* <p>
* If this record contains a field with the same {@link Field#getName()} as
* the argument field, that value is retrieved.
*
* @param <T> The generic field parameter
* @param field The field
* @return The value of a field contained in this record
* @throws IllegalArgumentException If the argument field is not contained
* in {@link #fieldsRow()}
*/
<T> T get(Field<T> field) throws IllegalArgumentException;
/**
* Get a converted value from this Record, providing a field.
* <p>
* If this record contains a field with the same {@link Field#getName()} as
* the argument field, that value is retrieved.
*
* @param <T> The conversion type parameter
* @param field The field
* @param type The conversion type
* @return The value of a field contained in this record
* @throws IllegalArgumentException If the argument field is not contained
* in {@link #fieldsRow()}
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Class)
*/
<T> T get(Field<?> field, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this Record, providing a field.
* <p>
* If this record contains a field with the same {@link Field#getName()} as
* the argument field, that value is retrieved.
*
* @param <T> The database type parameter
* @param <U> The conversion type parameter
* @param field The field
* @param converter The data type converter
* @return The value of a field contained in this record
* @throws IllegalArgumentException If the argument field is not contained
* in {@link #fieldsRow()}
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Converter)
*/
<T, U> U get(Field<T> field, Converter<? super T, ? extends U> converter) throws IllegalArgumentException,
DataTypeException;
/**
* Get a value from this Record, providing a field name.
*
* @param fieldName The field's name
* @return The value of a field's name contained in this record
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
*/
Object get(String fieldName) throws IllegalArgumentException;
/**
* Get a converted value from this Record, providing a field name.
*
* @param <T> The conversion type parameter
* @param fieldName The field's name
* @param type The conversion type
* @return The value of a field's name contained in this record
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Class)
*/
<T> T get(String fieldName, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this Record, providing a field name.
*
* @param <U> The conversion type parameter
* @param fieldName The field's name
* @param converter The data type converter
* @return The value of a field's name contained in this record
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Converter)
*/
<U> U get(String fieldName, Converter<?, ? extends U> converter) throws IllegalArgumentException, DataTypeException;
/**
* Get a value from this Record, providing a field name.
*
* @param fieldName The field's name
* @return The value of a field's name contained in this record
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
*/
Object get(Name fieldName) throws IllegalArgumentException;
/**
* Get a converted value from this Record, providing a field name.
*
* @param <T> The conversion type parameter
* @param fieldName The field's name
* @param type The conversion type
* @return The value of a field's name contained in this record
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Class)
*/
<T> T get(Name fieldName, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this Record, providing a field name.
*
* @param <U> The conversion type parameter
* @param fieldName The field's name
* @param converter The data type converter
* @return The value of a field's name contained in this record
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Converter)
*/
<U> U get(Name fieldName, Converter<?, ? extends U> converter) throws IllegalArgumentException, DataTypeException;
/**
* Get a value from this record, providing a field index.
*
* @param index The field's index
* @return The value of a field's index contained in this record
* @throws IllegalArgumentException If the argument index is not contained
* in the record
*/
Object get(int index) throws IllegalArgumentException;
/**
* Get a converted value from this record, providing a field index.
*
* @param <T> The conversion type parameter
* @param index The field's index
* @param type The conversion type
* @return The value of a field's index contained in this record
* @throws IllegalArgumentException If the argument index is not contained
* in the record
* @throws DataTypeException wrapping data type conversion exception that
* might have occurred
* @see Convert#convert(Object, Class)
*/
<T> T get(int index, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this record, providing a field index.
*
* @param <U> The conversion type parameter
* @param index The field's index
* @param converter The data type converter
* @return The value of a field's index contained in this record
* @throws IllegalArgumentException If the argument index is not contained
* in the record
* @throws DataTypeException wrapping data type conversion exception that
* might have occurred
* @see Convert#convert(Object, Converter)
*/
<U> U get(int index, Converter<?, ? extends U> converter) throws IllegalArgumentException, DataTypeException;
/**
* Set a value into this record.
* <p>
* This will always set the {@link #changed(Field)} flag for the given
* <code>field</code>, no matter if setting the value actually changes the
* value.
* <p>
* Changing {@link Table#getPrimaryKey()} values will set all
* {@link #changed()} flags to true, in order to produce complete
* <code>INSERT</code> statements on subsequent
* {@link UpdatableRecord#store()} operations.
*
* @param <T> The generic field parameter
* @param field The field
* @param value The value
*/
<T> void set(Field<T> field, T value);
/**
* Set a value into this record.
* <p>
* This will always set the {@link #changed(Field)} flag for the given
* <code>field</code>, no matter if setting the value actually changes the
* value.
* <p>
* Changing {@link Table#getPrimaryKey()} values will set all
* {@link #changed()} flags to true, in order to produce complete
* <code>INSERT</code> statements on subsequent
* {@link UpdatableRecord#store()} operations.
*
* @param <T> The generic field parameter
* @param <U> The conversion type parameter
* @param field The field
* @param value The value
* @param converter The converter used to convert <code>value</code> into an
* appropriate type
*/
<T, U> void set(Field<T> field, U value, Converter<? extends T, ? super U> converter);
/**
* Set a value into this record.
* <p>
* Like {@link #set(Field, Object)} but returning <code>this</code> for
* fluent setting of multiple values.
*/
<T> Record with(Field<T> field, T value);
/**
* Set a value into this record.
* <p>
* Like {@link #set(Field, Object, Converter)} but returning
* <code>this</code> for fluent setting of multiple values.
*/
<T, U> Record with(Field<T> field, U value, Converter<? extends T, ? super U> converter);
/**
* Get the number of fields of this record.
*/
int size();
/**
* Get this record containing the original values as fetched from the
* database.
* <p>
* Record values can be freely modified after having fetched a record from
* the database. Every record also references the originally fetched values.
* This method returns a new record containing those original values.
*
* @see #original(Field)
* @see #original(int)
* @see #original(String)
*/
Record original();
/**
* Get an original value from this record as fetched from the database.
* <p>
* Record values can be freely modified after having fetched a record from
* the database. Every record also references the originally fetched values.
* This method returns such an original value for a field.
*
* @see #original()
*/
<T> T original(Field<T> field);
/**
* Get an original value from this record as fetched from the database.
* <p>
* Record values can be freely modified after having fetched a record from
* the database. Every record also references the originally fetched values.
* This method returns such an original value for a field.
*
* @see #original()
*/
Object original(int fieldIndex);
/**
* Get an original value from this record as fetched from the database.
* <p>
* Record values can be freely modified after having fetched a record from
* the database. Every record also references the originally fetched values.
* This method returns such an original value for a field.
*
* @see #original()
*/
Object original(String fieldName);
/**
* Get an original value from this record as fetched from the database.
* <p>
* Record values can be freely modified after having fetched a record from
* the database. Every record also references the originally fetched values.
* This method returns such an original value for a field.
*
* @see #original()
*/
Object original(Name fieldName);
/**
* Check if this record has been changed from its original as fetched from
* the database.
* <p>
* If this returns <code>false</code>, then it can be said that
* <code>record.equals(record.original())</code> is true.
*
* @see #original()
* @see #changed(Field)
* @see #changed(int)
* @see #changed(String)
*/
boolean changed();
/**
* Check if a field's value has been changed from its original as fetched
* from the database.
*
* @see #changed()
* @see #original(Field)
*/
boolean changed(Field<?> field);
/**
* Check if a field's value has been changed from its original as fetched
* from the database.
*
* @see #changed()
* @see #original(int)
*/
boolean changed(int fieldIndex);
/**
* Check if a field's value has been changed from its original as fetched
* from the database.
*
* @see #changed()
* @see #original(String)
*/
boolean changed(String fieldName);
/**
* Check if a field's value has been changed from its original as fetched
* from the database.
*
* @see #changed()
* @see #original(Name)
*/
boolean changed(Name fieldName);
/**
* Set all of this record's internal changed flags to the supplied value.
* <p>
* If the <code>changed</code> argument is <code>false</code>, the
* {@link #original()} values will be reset to the corresponding "current"
* values as well
*
* @see #changed()
* @see #changed(Field, boolean)
* @see #changed(int, boolean)
* @see #changed(String, boolean)
*/
void changed(boolean changed);
/**
* Set this record's internal changed flag to the supplied value for a given
* field.
* <p>
* If the <code>changed</code> argument is <code>false</code>, the
* {@link #original(Field)} value will be reset to the corresponding
* "current" value as well
*
* @see #changed()
* @see #changed(Field)
*/
void changed(Field<?> field, boolean changed);
/**
* Set this record's internal changed flag to the supplied value for a given
* field.
* <p>
* If the <code>changed</code> argument is <code>false</code>, the
* {@link #original(int)} value will be reset to the corresponding "current"
* value as well
*
* @see #changed()
* @see #changed(int)
*/
void changed(int fieldIndex, boolean changed);
/**
* Set this record's internal changed flag to the supplied value for a given
* field.
* <p>
* If the <code>changed</code> argument is <code>false</code>, the
* {@link #original(String)} value will be reset to the corresponding
* "current" value as well
*
* @see #changed()
* @see #changed(String)
*/
void changed(String fieldName, boolean changed);
/**
* Set this record's internal changed flag to the supplied value for a given
* field.
* <p>
* If the <code>changed</code> argument is <code>false</code>, the
* {@link #original(Name)} value will be reset to the corresponding
* "current" value as well
*
* @see #changed()
* @see #changed(Name)
*/
void changed(Name fieldName, boolean changed);
/**
* Reset all values to their {@link #original()} values and all
* {@link #changed()} flags to <code>false</code>.
*/
void reset();
/**
* Reset a given value to its {@link #original(Field)} value and its
* {@link #changed(Field)} flag to <code>false</code>.
*/
void reset(Field<?> field);
/**
* Reset a given value to its {@link #original(int)} value and its
* {@link #changed(int)} flag to <code>false</code>.
*/
void reset(int fieldIndex);
/**
* Reset a given value to its {@link #original(String)} value and its
* {@link #changed(String)} flag to <code>false</code>.
*/
void reset(String fieldName);
/**
* Reset a given value to its {@link #original(Name)} value and its
* {@link #changed(Name)} flag to <code>false</code>.
*/
void reset(Name fieldName);
/**
* Convert this record into an array.
* <p>
* The resulting array has the same number of elements as this record has
* fields. The resulting array contains data as such:
* <p>
* <code><pre>
* // For arbitrary values of i
* record.getValue(i) == record.intoArray()[i]
* </pre></code>
* <p>
* This is the same as calling <code>into(Object[].class)</code>
*
* @return This record as an array
* @see #fromArray(Object...)
*/
Object[] intoArray();
/**
* Convert this record into a list.
* <p>
* The resulting list has the same number of elements as this record has
* fields. The resulting array contains data as such:
* <p>
* <code><pre>
* // For arbitrary values of i
* record.getValue(i) == record.intoList().get(i)
* </pre></code>
* <p>
* This is the same as calling <code>Arrays.asList(intoArray())</code>
*/
List<Object> intoList();
/**
* Convert this record into a stream.
* <p>
* The resulting stream has the same number of elements as this record has
* fields. The resulting stream contains data as such:
* <p>
* This is the same as calling <code>into(Stream.class)</code>
*
* @return This record as a stream
*/
Stream<Object> intoStream();
/**
* Return this record as a name/value map.
* <p>
* This is the inverse operation to {@link #fromMap(Map)}
*
* @return This record as a map
* @see #fromMap(Map)
*/
Map<String, Object> intoMap();
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @param fields The fields of the new record
* @return The new record
*/
Record into(Field<?>... fields);
// [jooq-tools] START [into-fields]
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1> Record1<T1> into(Field<T1> field1);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2> Record2<T1, T2> into(Field<T1> field1, Field<T2> field2);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3> Record3<T1, T2, T3> into(Field<T1> field1, Field<T2> field2, Field<T3> field3);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4> Record4<T1, T2, T3, T4> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5> Record5<T1, T2, T3, T4, T5> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6> Record6<T1, T2, T3, T4, T5, T6> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7> Record7<T1, T2, T3, T4, T5, T6, T7> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8> Record8<T1, T2, T3, T4, T5, T6, T7, T8> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9> Record9<T1, T2, T3, T4, T5, T6, T7, T8, T9> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Record10<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> Record11<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> Record12<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> Record13<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> Record14<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> Record15<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> Record16<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17> Record17<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18> Record18<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19> Record19<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20> Record20<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19, Field<T20> field20);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21> Record21<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19, Field<T20> field20, Field<T21> field21);
/**
* Copy this record into a new record holding only a subset of the previous
* fields.
*
* @return The new record
* @see #into(Table)
*/
@Generated("This class was generated using jOOQ-tools")
<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> Record22<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> into(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11, Field<T12> field12, Field<T13> field13, Field<T14> field14, Field<T15> field15, Field<T16> field16, Field<T17> field17, Field<T18> field18, Field<T19> field19, Field<T20> field20, Field<T21> field21, Field<T22> field22);
// [jooq-tools] END [into-fields]
/**
* Map resulting records onto a custom type.
* <p>
* This will map this record onto your custom type using a
* {@link RecordMapper} as provided by
* {@link Configuration#recordMapperProvider()}. If no custom provider is
* specified, the {@link DefaultRecordMapperProvider} is used.
*
* @param <E> The generic entity type.
* @param type The entity type.
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @see #from(Object)
* @see DefaultRecordMapper
*/
<E> E into(Class<? extends E> type) throws MappingException;
/**
* Map resulting records onto a custom type.
* <p>
* This is the same as {@link #into(Class)}, except that no new object is
* instantiated as a result. Instead, you can provide your own custom POJO
* instance.
*
* @param <E> The generic entity type.
* @param object The receiving bean.
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @throws NullPointerException if <code>object</code> is <code>null</code>
* @see #from(Object)
*/
<E> E into(E object) throws MappingException;
/**
* Map resulting records onto a custom record type.
* <p>
* The mapping algorithm is this:
* <p>
* <h5>jOOQ will map <code>Record</code> values by equal field names:</h5>
* <p>
* <ul>
* <li>For every field in the <code>table</code> argument with
* {@link Field#getName()} <code>"MY_field"</code> (case-sensitive!), a
* corresponding field with the same name in this record will be searched.</li>
* <li>If several fields in this record share the same
* {@link Field#getName()}, then the first one returning true on
* {@link Field#equals(Object)} will be returned. (e.g. qualified field
* names match)</li>
* </ul>
* <p>
* <h5>Other restrictions</h5>
* <p>
* <ul>
* <li>{@link Table#getRecordType()} must return a class of type
* {@link TableRecord}, which must provide a default constructor. Non-public
* default constructors are made accessible using
* {@link Constructor#setAccessible(boolean)}</li>
* </ul>
*
* @param <R> The generic table record type.
* @param table The table type.
*/
<R extends Record> R into(Table<R> table);
/**
* Generate an in-memory JDBC {@link ResultSet} containing the data of this
* <code>Record</code>.
* <p>
* Use this as an adapter for JDBC-compliant code that expects a
* {@link ResultSet} to operate on, rather than a jOOQ {@link Result}. The
* returned <code>ResultSet</code> allows for the following behaviour
* according to the JDBC specification:
* <ul>
* <li> {@link ResultSet#CLOSE_CURSORS_AT_COMMIT}: The cursors (i.e.
* {@link Statement} object) are no longer available</li>
* <li> {@link ResultSet#CONCUR_READ_ONLY}: You cannot update the database
* through this <code>ResultSet</code>, as the underlying {@link Result}
* object does not hold any open database refences anymore</li>
* <li> {@link ResultSet#FETCH_FORWARD}: The fetch direction is forward only,
* and cannot be changed</li>
* <li> {@link ResultSet#TYPE_SCROLL_INSENSITIVE}: You can use any of the
* <code>ResultSet</code>'s scrolling methods, e.g. {@link ResultSet#next()}
* or {@link ResultSet#previous()}, etc.</li>
* </ul>
* <p>
* You may use {@link DSLContext#fetch(ResultSet)} to unwind this wrapper
* again.
* <p>
* This is the same as creating a new {@link Result} with this
* <code>Record</code> only, and then calling {@link Result#intoResultSet()}
* on that <code>Result</code>
*
* @return A wrapper JDBC <code>ResultSet</code>
*/
ResultSet intoResultSet();
/**
* Map this record into a custom mapper callback.
*
* @param mapper The mapper callback
* @return The custom mapped record
*/
<E> E map(RecordMapper<Record, E> mapper);
/**
* Load data into this record from a source.
* <p>
* The mapping algorithm is this:
* <p>
* <h5>If <code>source</code> is an <code>array</code></h5>
* <p>
* Loading of data is delegated to {@link #fromArray(Object...)}
* <p>
* <h5>If <code>source</code> is a {@link Map}</h5>
* <p>
* <p>
* Loading of data is delegated to {@link #fromMap(Map)}
* <p>
* <h5>If any JPA {@link Column} annotations are found on the {@link Class}
* of the provided <code>source</code>, only those are used. Matching
* candidates are:</h5>
* <p>
* <ul>
* <li>Public no-argument instance methods annotated with
* <code>Column</code></li>
* <li>Public no-argument instance methods starting with <code>getXXX</code>
* or <code>isXXX</code>, if there exists a matching public single-argument
* <code>setXXX()</code> instance method that is annotated with
* <code>Column</code></li>
* <li>Public instance member fields annotated with <code>Column</code></li>
* </ul>
* Additional matching rules:
* <ul>
* <li>{@link Column#name()} must match {@link Field#getName()}. All other
* annotation attributes are ignored</li>
* <li>Only the first match per field is used</li>
* <li>Matching methods have a higher priority than matching member fields</li>
* <li>Explicitly matching methods have a higher priority than implicitly
* matching methods (implicitly matching getter = setter is annotated)</li>
* <li>Static methods / member fields are ignored</li>
* </ul>
* <p>
* <h5>If there are no JPA <code>Column</code> annotations, or jOOQ can't
* find the <code>javax.persistence</code> API on the classpath, jOOQ will
* map members by naming convention:</h5>
* <p>
* If {@link Field#getName()} is <code>MY_field</code> (case-sensitive!),
* then this field's value will be fetched from the first of these:
* <ul>
* <li>Public no-argument instance method <code>MY_field()</code></li>
* <li>Public no-argument instance method <code>myField()</code></li>
* <li>Public no-argument instance method <code>getMY_field()</code></li>
* <li>Public no-argument instance method <code>getMyField()</code></li>
* <li>Public instance member field <code>MY_field</code></li>
* <li>Public instance member field <code>myField</code></li>
* </ul>
* <p>
* <h5>Other restrictions</h5>
* <p>
* <ul>
* <li>primitive types are supported.</li>
* </ul>
* <p>
* <h5>General notes</h5>
* <p>
* The resulting record will have its internal "changed" flags set to true
* for all values. This means that {@link UpdatableRecord#store()} will
* perform an <code>INSERT</code> statement. If you wish to store the record
* using an <code>UPDATE</code> statement, use
* {@link DSLContext#executeUpdate(UpdatableRecord)} instead.
* <p>
* This is the same as calling
* <code>record.from(source, record.fields())</code>
*
* @param source The source object to copy data from
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @see #into(Class)
* @see #from(Object, Field...)
*/
void from(Object source) throws MappingException;
/**
* Load data into this record from a source, providing some fields.
* <p>
* This is the same as {@link #from(Object)}, except that only fields
* contained in the <code>fields</code> argument will be mapped.
*
* @param source The source object to copy data from
* @param fields The record's fields to use for mapping
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @see #into(Class)
* @see #from(Object)
*/
void from(Object source, Field<?>... fields) throws MappingException;
/**
* Load data into this record from a source, providing some field names.
* <p>
* This is the same as {@link #from(Object)}, except that only fields
* contained in the <code>fieldNames</code> argument will be mapped.
*
* @param source The source object to copy data from
* @param fieldNames The record's fields names to use for mapping
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @see #into(Class)
* @see #from(Object)
*/
void from(Object source, String... fieldNames) throws MappingException;
/**
* Load data into this record from a source, providing some field names.
* <p>
* This is the same as {@link #from(Object)}, except that only fields
* contained in the <code>fieldNames</code> argument will be mapped.
*
* @param source The source object to copy data from
* @param fieldNames The record's fields names to use for mapping
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @see #into(Class)
* @see #from(Object)
*/
void from(Object source, Name... fieldNames) throws MappingException;
/**
* Load data into this record from a source, providing some field indexes.
* <p>
* This is the same as {@link #from(Object)}, except that only fields
* contained in the <code>fieldIndexes</code> argument will be mapped.
*
* @param source The source object to copy data from
* @param fieldIndexes The record's fields indexes to use for mapping
* @throws MappingException wrapping any reflection exception that might
* have occurred while mapping records
* @see #into(Class)
* @see #from(Object)
*/
void from(Object source, int... fieldIndexes) throws MappingException;
/**
* Load data from a map into this record.
* <p>
* The argument map is expected to hold field-name / value pairs where
* field-names correspond to actual field names as provided by
* {@link #field(String)}. Missing fields will be left untouched. Excess
* fields will be ignored.
* <p>
* This is the inverse operation to {@link #intoMap()}. This is the same as
* calling <code>record.fromMap(map, record.fields())</code>
*
* @see #intoMap()
* @see #fromMap(Map, Field...)
*/
void fromMap(Map<String, ?> map);
/**
* Load data from a map into this record, providing some fields.
* <p>
* The argument map is expected to hold field-name / value pairs where
* field-names correspond to actual field names as provided by
* {@link #field(String)}. Missing fields will be left untouched. Excess
* fields will be ignored.
* <p>
* This is the same as {@link #fromMap(Map)}, except that only fields
* contained in the <code>fields</code> argument will be mapped.
*
* @see #intoMap()
* @see #fromMap(Map)
*/
void fromMap(Map<String, ?> map, Field<?>... fields);
/**
* Load data from a map into this record, providing some field names.
* <p>
* The argument map is expected to hold field-name / value pairs where
* field-names correspond to actual field names as provided by
* {@link #field(String)}. Missing fields will be left untouched. Excess
* fields will be ignored.
* <p>
* This is the same as {@link #fromMap(Map)}, except that only fields
* contained in the <code>fieldNames</code> argument will be mapped.
*
* @see #intoMap()
* @see #fromMap(Map)
*/
void fromMap(Map<String, ?> map, String... fieldNames);
/**
* Load data from a map into this record, providing some field names.
* <p>
* The argument map is expected to hold field-name / value pairs where
* field-names correspond to actual field names as provided by
* {@link #field(Name)}. Missing fields will be left untouched. Excess
* fields will be ignored.
* <p>
* This is the same as {@link #fromMap(Map)}, except that only fields
* contained in the <code>fieldNames</code> argument will be mapped.
*
* @see #intoMap()
* @see #fromMap(Map)
*/
void fromMap(Map<String, ?> map, Name... fieldNames);
/**
* Load data from a map into this record, providing some field indexes.
* <p>
* The argument map is expected to hold field-name / value pairs where
* field-names correspond to actual field names as provided by
* {@link #field(String)}. Missing fields will be left untouched. Excess
* fields will be ignored.
* <p>
* This is the same as {@link #fromMap(Map)}, except that only fields
* contained in the <code>fieldIndexes</code> argument will be mapped.
*
* @see #intoMap()
* @see #fromMap(Map)
*/
void fromMap(Map<String, ?> map, int... fieldIndexes);
/**
* Load data from an array into this record.
* <p>
* The argument array is expected to hold values for this record's field
* indexes. Missing values will be left untouched. Excess values will be
* ignored.
* <p>
* This is the inverse operation to {@link #intoArray()}
*
* @see #intoArray()
* @see #fromArray(Object[], Field...)
*/
void fromArray(Object... array);
/**
* Load data from an array into this record, providing some fields.
* <p>
* The argument array is expected to hold values for this record's field
* indexes. Missing values will be left untouched. Excess values will be
* ignored.
* <p>
* This is the same as {@link #fromArray(Object...)}, except that only
* fields contained in the <code>fields</code> argument will be mapped.
*
* @see #intoArray()
* @see #fromArray(Object...)
*/
void fromArray(Object[] array, Field<?>... fields);
/**
* Load data from an array into this record, providing some fields names.
* <p>
* The argument array is expected to hold values for this record's field
* indexes. Missing values will be left untouched. Excess values will be
* ignored.
* <p>
* This is the same as {@link #fromArray(Object...)}, except that only
* fields contained in the <code>fieldNames</code> argument will be mapped.
*
* @see #intoArray()
* @see #fromArray(Object...)
*/
void fromArray(Object[] array, String... fieldNames);
/**
* Load data from an array into this record, providing some fields names.
* <p>
* The argument array is expected to hold values for this record's field
* indexes. Missing values will be left untouched. Excess values will be
* ignored.
* <p>
* This is the same as {@link #fromArray(Object...)}, except that only
* fields contained in the <code>fieldNames</code> argument will be mapped.
*
* @see #intoArray()
* @see #fromArray(Object...)
*/
void fromArray(Object[] array, Name... fieldNames);
/**
* Load data from an array into this record, providing some fields indexes.
* <p>
* The argument array is expected to hold values for this record's field
* indexes. Missing values will be left untouched. Excess values will be
* ignored.
* <p>
* This is the same as {@link #fromArray(Object...)}, except that only
* fields contained in the <code>fieldIndexes</code> argument will be
* mapped.
*
* @see #intoArray()
* @see #fromArray(Object...)
*/
void fromArray(Object[] array, int... fieldIndexes);
// -------------------------------------------------------------------------
// Formatting methods
// -------------------------------------------------------------------------
/**
* Get a simple formatted representation of this result as a JSON array.
* <p>
* The format is the following: <code><pre>
* [value-2-1,value-2-2,...,value-2-n]
* </pre></code>
*
* @return The formatted result
*/
String formatJSON();
/**
* Get a simple formatted representation of this result as a JSON data
* structure, according to the format.
*
* @return The formatted result
* @see JSONFormat
*/
String formatJSON(JSONFormat format);
/**
* Like {@link #formatJSON()}, but the data is output onto an {@link OutputStream}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatJSON(OutputStream stream) throws IOException;
/**
* Like {@link #formatJSON(JSONFormat)}, but the data is output onto an {@link OutputStream}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatJSON(OutputStream stream, JSONFormat format) throws IOException;
/**
* Like {@link #formatJSON()}, but the data is output onto a {@link Writer}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatJSON(Writer writer) throws IOException;
/**
* Like {@link #formatJSON(JSONFormat)}, but the data is output onto a {@link Writer}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatJSON(Writer writer, JSONFormat format) throws IOException;
/**
* Get this record formatted as XML.
*
* @see Result#formatXML()
*/
String formatXML();
/**
* Get this record formatted as XML.
*
* @see Result#formatXML(XMLFormat)
*/
String formatXML(XMLFormat format);
/**
* Like {@link #formatXML()}, but the data is output onto an {@link OutputStream}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatXML(OutputStream stream) throws IOException;
/**
* Like {@link #formatXML(XMLFormat)}, but the data is output onto an {@link OutputStream}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatXML(OutputStream stream, XMLFormat format) throws IOException;
/**
* Like {@link #formatXML()}, but the data is output onto a {@link Writer}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatXML(Writer writer) throws IOException;
/**
* Like {@link #formatXML(XMLFormat)}, but the data is output onto a {@link Writer}.
*
* @throws IOException - an unchecked wrapper for {@link java.io.IOException}, if anything goes wrong.
*/
void formatXML(Writer writer, XMLFormat format) throws IOException;
// -------------------------------------------------------------------------
// Inherited methods
// -------------------------------------------------------------------------
/**
* Get a hash code of this <code>Record</code>, based on the underlying row
* value expression.
* <p>
* In order to fulfill the general contract of {@link Object#hashCode()} and
* {@link Object#equals(Object)}, a <code>Record</code>'s hash code value
* depends on all hash code values of this <code>Record</code>'s underlying
* column values.
*
* @return A hash code value for this record
* @see #equals(Object)
*/
@Override
int hashCode();
/**
* Compare this <code>Record</code> with another <code>Record</code> for
* equality.
* <p>
* Two records are considered equal if
* <ul>
* <li>They have the same degree</li>
* <li>For every <code>i BETWEEN 0 AND degree, r1[i] = r2[i]</code></li>
* </ul>
* <p>
* Note, that the above rules correspond to the SQL comparison predicate
* behaviour as illustrated in the following example: <code><pre>
* -- A row value expression comparison predicate
* SELECT *
* FROM my_table
* WHERE (1, 'A') = (1, 'A')
* </pre></code>
* <p>
* Unlike SQL, jOOQ allows to compare also incompatible records, e.g.
* records
* <ul>
* <li>... whose degrees are not equal (results in <code>false</code>)</li>
* <li>... whose column types are not equal (results in <code>false</code>)</li>
* <li>... whose record types are not equal (irrelevant for the result)</li>
* </ul>
* <p>
* It can be said that for all R1, R2, if <code>R1.equal(R2)</code>, then
* <code>R1.compareTo(R2) == 0</code>
*
* @param other The other record
* @return Whether the two records are equal
* @see #compareTo(Record)
* @see #hashCode()
*/
@Override
boolean equals(Object other);
/**
* Compares this <code>Record</code> with another <code>Record</code>
* according to their natural ordering.
* <p>
* jOOQ Records implement {@link Comparable} to allow for naturally ordering
* Records in a "SQL way", i.e. according to the following rules:
* <p>
* <h5>Records being compared must have the same ROW type</h5>
* <p>
* Two Records are comparable if and only if they have the same
* <code>ROW</code> type, i.e. if their {@link Record#fieldsRow()
* fieldsRow()} methods return fields of the same type and degree.
* <p>
* <h5>Comparison rules</h5>
* <p>
* Assume the following notations:
* <ul>
* <li><code>X[i]</code> means <code>X.getValue(i)</code></li>
* <li><code>X = Y</code> means <code>X.compareTo(Y) == 0</code></li>
* <li><code>X < Y</code> means <code>X.compareTo(Y) < 0</code></li>
* <li><code>X[i] = Y[i]</code> means
* <code>(X[i] == null && Y[i] == null) || X[i].compareTo(Y[i]) < 0</code>
* </li>
* <li><code>X[i] < Y[i]</code> means
* <code>Y[i] == null || X[i].compareTo(Y[i]) < 0</code>. This
* corresponds to the SQL <code>NULLS LAST</code> clause.</li>
* </ul>
* Then, for two comparable Records <code>r1</code> and <code>r2</code>,
* <code>x = r1.compareTo(r2)</code> yields:
* <ul>
* <li><strong><code>x = -1</code></strong>: if <code><pre>
* (r1[0] < r2[0])
* OR (r1[0] = r2[0] AND r1[1] < r2[1])
* OR ...
* OR (r1[0] = r2[0] AND ... AND r1[N-1] = r2[N-1] AND r1[N] < r2[N])</pre></code>
* </li>
* <li><strong><code>x = 0</code></strong>: if <code><pre>
* OR (r1[0] = r2[0] AND ... AND r1[N-1] = r2[N-1] AND r1[N] = r2[N])</pre></code>
* </li>
* <li><strong><code>x = 1</code></strong>: if <code><pre>
* (r1[0] > r2[0])
* OR (r1[0] = r2[0] AND r1[1] > r2[1])
* OR ...
* OR (r1[0] = r2[0] AND ... AND r1[N-1] = r2[N-1] AND r1[N] > r2[N])</pre></code>
* </li>
* </ul>
* <p>
* Note, that the above rules correspond to the SQL ordering behaviour as
* illustrated in the following examples: <code><pre>
* -- A SQL ORDER BY clause, ordering all records by columns in their order
* SELECT a, b, c
* FROM my_table
* ORDER BY 1, 2, 3
*
* -- A row value expression comparison predicate
* SELECT *
* FROM my_table
* WHERE (a, b, c) < (1, 2, 3)
* </pre></code>
* <p>
* See {@link Row1#lessThan(Row1)}, {@link Row2#lessThan(Row2)}, ...,
* {@link Row22#lessThan(Row22)} for more details about row value expression
* comparison predicates
* <p>
* Alternative sorting behaviour can be achieved through
* {@link Result#sortAsc(java.util.Comparator)} and similar methods.
*
* @throws NullPointerException If the argument record is <code>null</code>
* @throws ClassCastException If the argument record is not comparable with
* this record according to the above rules.
*/
@Override
int compareTo(Record record);
// -------------------------------------------------------------------------
// XXX: Deprecated and discouraged methods
// -------------------------------------------------------------------------
/**
* Get a value from this Record, providing a field.
* <p>
* [#2211] Future versions of jOOQ might remove the {@link #getValue(Field)}
* method. It is recommended to use {@link #get(Field)} instead.
*
* @see #get(Field)
*/
<T> T getValue(Field<T> field) throws IllegalArgumentException;
/**
* Get a value from this record, providing a field.
*
* @param <T> The generic field parameter
* @param field The field
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field contained in this record, or defaultValue,
* if <code>null</code>
* @throws IllegalArgumentException If the argument field is not contained
* in {@link #fieldsRow()}
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<T> T getValue(Field<T> field, T defaultValue) throws IllegalArgumentException;
/**
* Get a converted value from this Record, providing a field.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(Field, Class)} method. It is recommended to use
* {@link #get(Field, Class)} instead.
*
* @see #get(Field, Class)
*/
<T> T getValue(Field<?> field, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this record, providing a field.
*
* @param <T> The conversion type parameter
* @param field The field
* @param type The conversion type
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field contained in this record, or defaultValue,
* if <code>null</code>
* @throws IllegalArgumentException If the argument field is not contained
* in {@link #fieldsRow()}
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Class)
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<T> T getValue(Field<?> field, Class<? extends T> type, T defaultValue) throws IllegalArgumentException,
DataTypeException;
/**
* Get a converted value from this Record, providing a field.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(Field, Converter)} method. It is recommended to use
* {@link #get(Field, Converter)} instead.
*
* @see #get(Field, Converter)
*/
<T, U> U getValue(Field<T> field, Converter<? super T, ? extends U> converter) throws IllegalArgumentException,
DataTypeException;
/**
* Get a converted value from this record, providing a field.
*
* @param <T> The database type parameter
* @param <U> The conversion type parameter
* @param field The field
* @param converter The data type converter
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field contained in this record, or defaultValue,
* if <code>null</code>
* @throws IllegalArgumentException If the argument field is not contained
* in {@link #fieldsRow()}
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Converter)
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<T, U> U getValue(Field<T> field, Converter<? super T, ? extends U> converter, U defaultValue)
throws IllegalArgumentException, DataTypeException;
/**
* Get a value from this Record, providing a field name.
* <p>
* [#2211] Future versions of jOOQ might remove the {@link #getValue(String)}
* method. It is recommended to use {@link #get(String)} instead.
*
* @see #get(String)
*/
Object getValue(String fieldName) throws IllegalArgumentException;
/**
* Get a value from this record, providing a field name.
*
* @param fieldName The field's name
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field's name contained in this record, or
* defaultValue, if <code>null</code>
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
Object getValue(String fieldName, Object defaultValue) throws IllegalArgumentException;
/**
* Get a converted value from this Record, providing a field name.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(String, Class)} method. It is recommended to use
* {@link #get(String, Class)} instead.
*
* @see #get(String, Class)
*/
<T> T getValue(String fieldName, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this record, providing a field name.
*
* @param <T> The conversion type parameter
* @param fieldName The field's name
* @param type The conversion type
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field's name contained in this record, or
* defaultValue, if <code>null</code>
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Class)
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<T> T getValue(String fieldName, Class<? extends T> type, T defaultValue) throws IllegalArgumentException,
DataTypeException;
/**
* Get a converted value from this Record, providing a field name.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(String, Converter)} method. It is recommended to use
* {@link #get(String, Converter)} instead.
*
* @see #get(String, Converter)
*/
<U> U getValue(String fieldName, Converter<?, ? extends U> converter) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this record, providing a field name.
*
* @param <U> The conversion type parameter
* @param fieldName The field's name
* @param converter The data type converter
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field's name contained in this record, or
* defaultValue, if <code>null</code>
* @throws IllegalArgumentException If the argument fieldName is not
* contained in the record
* @throws DataTypeException wrapping any data type conversion exception
* that might have occurred
* @see Convert#convert(Object, Converter)
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<U> U getValue(String fieldName, Converter<?, ? extends U> converter, U defaultValue) throws IllegalArgumentException,
DataTypeException;
/**
* Get a value from this Record, providing a field name.
* <p>
* [#2211] Future versions of jOOQ might remove the {@link #getValue(Name)}
* method. It is recommended to use {@link #get(Name)} instead.
*
* @see #get(Name)
*/
Object getValue(Name fieldName) throws IllegalArgumentException;
/**
* Get a converted value from this Record, providing a field name.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(Name, Class)} method. It is recommended to use
* {@link #get(Name, Class)} instead.
*
* @see #get(Name, Class)
*/
<T> T getValue(Name fieldName, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this Record, providing a field name.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(Name, Converter)} method. It is recommended to use
* {@link #get(Name, Converter)} instead.
*
* @see #get(Name, Converter)
*/
<U> U getValue(Name fieldName, Converter<?, ? extends U> converter) throws IllegalArgumentException, DataTypeException;
/**
* Get a value from this record, providing a field index.
* <p>
* [#2211] Future versions of jOOQ might remove the {@link #getValue(int)}
* method. It is recommended to use {@link #get(int)} instead.
*
* @see #get(int)
*/
Object getValue(int index) throws IllegalArgumentException;
/**
* Get a value from this record, providing a field index.
*
* @param index The field's index
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field's index contained in this record, or
* defaultValue, if <code>null</code>
* @throws IllegalArgumentException If the argument index is not contained
* in the record
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
Object getValue(int index, Object defaultValue) throws IllegalArgumentException;
/**
* Get a converted value from this record, providing a field index.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(int, Class)} method. It is recommended to use
* {@link #get(int, Class)} instead.
*
* @see #get(int, Class)
*/
<T> T getValue(int index, Class<? extends T> type) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this record, providing a field index.
*
* @param <T> The conversion type parameter
* @param index The field's index
* @param type The conversion type
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field's index contained in this record, or
* defaultValue, if <code>null</code>
* @throws IllegalArgumentException If the argument index is not contained
* in the record
* @throws DataTypeException wrapping data type conversion exception that
* might have occurred
* @see Convert#convert(Object, Class)
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<T> T getValue(int index, Class<? extends T> type, T defaultValue) throws IllegalArgumentException,
DataTypeException;
/**
* Get a converted value from this record, providing a field index.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #getValue(int, Converter)} method. It is recommended to use
* {@link #get(int, Converter)} instead.
*
* @see #get(int, Converter)
*/
<U> U getValue(int index, Converter<?, ? extends U> converter) throws IllegalArgumentException, DataTypeException;
/**
* Get a converted value from this record, providing a field index.
*
* @param <U> The conversion type parameter
* @param index The field's index
* @param converter The data type converter
* @param defaultValue The default value instead of <code>null</code>
* @return The value of a field's index contained in this record, or
* defaultValue, if <code>null</code>
* @throws IllegalArgumentException If the argument index is not contained
* in the record
* @throws DataTypeException wrapping data type conversion exception that
* might have occurred
* @see Convert#convert(Object, Converter)
* @deprecated - 3.3.0 - [#2878] - This method will be removed in jOOQ 4.0
*/
@Deprecated
<U> U getValue(int index, Converter<?, ? extends U> converter, U defaultValue) throws IllegalArgumentException,
DataTypeException;
/**
* Set a value into this record.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #set(Field, Object)} method. It is recommended to use
* {@link #set(Field, Object)} instead.
*
* @see #set(Field, Object)
*/
<T> void setValue(Field<T> field, T value);
/**
* Set a value into this record.
* <p>
* [#2211] Future versions of jOOQ might remove the
* {@link #set(Field, Object, Converter)} method. It is recommended to use
* {@link #set(Field, Object, Converter)} instead.
*
* @see #set(Field, Object, Converter)
*/
<T, U> void setValue(Field<T> field, U value, Converter<? extends T, ? super U> converter);
}