org.jooq.UDT Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
/**
* UDT definition
*
* @param The record type
* @author Lukas Eder
*/
public interface UDT> extends QueryPart {
/**
* Get this UDT's fields as a {@link Row}
*/
Row fieldsRow();
/**
* Get a specific field from this UDT.
*
* @see Row#field(Field)
*/
Field field(Field field);
/**
* Get a specific field from this UDT.
*
* @see Row#field(String)
*/
Field field(String name);
/**
* Get a specific field from this UDT.
*
* @see Row#field(int)
*/
Field field(int index);
/**
* Get all fields from this UDT.
*
* @see Row#fields()
*/
Field[] fields();
/**
* Get the UDT schema
*/
Schema getSchema();
/**
* The name of this UDT
*/
String getName();
/**
* @return The record type produced by this table
*/
Class getRecordType();
/**
* Create a new {@link Record} of this UDT's type.
*
* @see DSLContext#newRecord(UDT)
*/
R newRecord();
/**
* The UDT's data type as known to the database
*/
DataType getDataType();
}