org.jooq.SelectField Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* 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 QueryPart to be used exclusively in SELECT
* clauses
*
* @author Lukas Eder
*/
public interface SelectField extends QueryPart {
// ------------------------------------------------------------------------
// API
// ------------------------------------------------------------------------
/**
* The name of the field.
*
* The name is any of these:
*
* - The formal name of the field, if it is a physical table/view
* field
* - The alias of an aliased field
* - A generated / unspecified value for any other expression
* - The name of a parameter if it is a named {@link Param}
*
*/
String getName();
/**
* The field's underlying {@link Converter}.
*
* By default, all fields reference an identity-converter
* Converter<T, T>. Custom data types may be obtained by a
* custom {@link Converter} placed on the generated {@link TableField}.
*/
Converter getConverter();
/**
* The field's underlying {@link Binding}.
*/
Binding getBinding();
/**
* The Java type of the field.
*/
Class getType();
/**
* The type of this field (might not be dialect-specific).
*/
DataType getDataType();
/**
* The dialect-specific type of this field.
*/
DataType getDataType(Configuration configuration);
}