org.jooq.Name 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;
import static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.FIREBIRD;
import static org.jooq.SQLDialect.H2;
import static org.jooq.SQLDialect.HSQLDB;
// ...
// ...
import static org.jooq.SQLDialect.POSTGRES;
// ...
// ...
import org.jooq.conf.Settings;
/**
* A SQL identifier QueryPart.
*
* A Name is a {@link QueryPart} that renders a SQL identifier
* according to the settings specified in {@link Settings#getRenderNameStyle()}.
*
* @author Lukas Eder
*/
public interface Name extends QueryPart {
/**
* The qualified name of this SQL identifier.
*/
String[] getName();
/**
* Create a {@link WindowDefinition} from this name.
*
* This creates a window definition that can be
*
* - declared in the
WINDOW clause (see
* {@link SelectWindowStep#window(WindowDefinition...)}
* - referenced from the
OVER clause (see
* {@link AggregateFunction#over(WindowDefinition)}
*
*/
@Support({ CUBRID, POSTGRES })
WindowDefinition as(WindowSpecification window);
/**
* Specify a subselect to refer to by the Name to form a common
* table expression.
*
* Column names are implicitly inherited from the SELECT
* statement.
*/
@Support({ FIREBIRD, H2, HSQLDB, POSTGRES })
CommonTableExpression as(Select select);
/**
* Add a list of fields to this name to make this name a
* {@link DerivedColumnList}.
*
* The DerivedColumnList can then be used along with a
* subselect to form a {@link CommonTableExpression} to be used with
* WITH clauses.
*/
@Support({ FIREBIRD, H2, HSQLDB, POSTGRES })
DerivedColumnList fields(String... fieldNames);
}