org.jooq.TableLike 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;
/**
* An object that can behave like a table (a table-like object)
*
* @param The record type
* @author Lukas Eder
*/
public interface TableLike extends QueryPart {
/**
* Get this table's fields as a {@link Row}
*/
Row fieldsRow();
/**
* Get a specific field from this table.
*
* 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)
*/
Field field(Field field);
/**
* Get a specific field from this table.
*
* @see Row#field(String)
*/
Field field(String name);
/**
* Get a specific field from this table and coerce it to type.
*
* @see Row#field(String, Class)
*/
Field field(String name, Class type);
/**
* Get a specific field from this table and coerce it to
* dataType.
*
* @see Row#field(String, DataType)
*/
Field field(String name, DataType dataType);
/**
* Get a specific field from this table.
*
* @see Row#field(Name)
*/
Field field(Name name);
/**
* Get a specific field from this table and coerce it to type.
*
* @see Row#field(Name, Class)
*/
Field field(Name name, Class type);
/**
* Get a specific field from this table and coerce it to
* dataType.
*
* @see Row#field(Name, DataType)
*/
Field field(Name name, DataType dataType);
/**
* Get a specific field from this table.
*
* @see Row#field(int)
*/
Field field(int index);
/**
* Get a specific field from this table and coerce it to type.
*
* @see Row#field(int, Class)
*/
Field field(int index, Class type);
/**
* Get a specific field from this table and coerce it to
* dataType.
*
* @see Row#field(int, DataType)
*/
Field field(int index, DataType dataType);
/**
* Get all fields from this table.
*
* @see Row#fields()
*/
Field[] fields();
/**
* Get all fields from this table, providing some fields.
*
* @return All available fields
* @see Row#fields(Field...)
*/
Field[] fields(Field... fields);
/**
* Get all fields from this table, providing some field names.
*
* @return All available fields
* @see Row#fields(String...)
*/
Field[] fields(String... fieldNames);
/**
* Get all fields from this table, providing some field names.
*
* @return All available fields
* @see Row#fields(Name...)
*/
Field[] fields(Name... fieldNames);
/**
* Get all fields from this table, providing some field indexes.
*
* @return All available fields
* @see Row#fields(int...)
*/
Field[] fields(int... fieldIndexes);
/**
* The underlying table representation of this object
*
* This method is useful for things like
* SELECT * FROM (SELECT * FROM x WHERE x.a = '1') WHERE ...
*/
@Support
Table asTable();
/**
* The underlying aliased table representation of this object
*
* @see Table#as(String)
*/
@Support
Table asTable(String alias);
/**
* The underlying aliased table representation of this object
*
* @see Table#as(String, String...)
*/
@Support
Table asTable(String alias, String... fieldAliases);
}