http://www.jooq.org/jooq: jOOQ effectively combines complex SQL, typesafety, source code generation, active records,
stored procedures, advanced data types, and Java in a fluent, intuitive DSL.
/*
* 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 org.jooq.exception.DataAccessException;
Base functionality declaration for all query objects
This interface is for JOOQ INTERNAL USE only. Do not reference directly
Author: Lukas Eder
/**
* Base functionality declaration for all query objects
* <p>
* This interface is for JOOQ INTERNAL USE only. Do not reference directly
*
* @author Lukas Eder
*/
@Internal
public interface QueryPartInternal extends QueryPart {
Whether a call to accept(Context<?>) would render content. Deprecated: - Calling rendersContent(Context<?>) directly on a QueryPart is almost always a mistake.
/**
* Whether a call to {@link #accept(Context)} would render content.
*
* @deprecated - Calling {@link #rendersContent(Context)} directly on a
* {@link QueryPart} is almost always a mistake.
*/
@Deprecated
boolean rendersContent(Context<?> ctx);
This QueryPart can accept a Context object in order to render a SQL string or to bind its variables. Deprecated: - Calling accept(Context<?>) directly on a QueryPart is almost always a mistake. Instead, Context.visit(QueryPart) should be called.
/**
* This {@link QueryPart} can <code>accept</code> a {@link Context} object
* in order to render a SQL string or to bind its variables.
*
* @deprecated - Calling {@link #accept(Context)} directly on a
* {@link QueryPart} is almost always a mistake. Instead,
* {@link Context#visit(QueryPart)} should be called.
*/
@Deprecated
void accept(Context<?> ctx);
Render this QueryPart to a SQL string contained in context.sql(). The context will contain
additional information about how to render this QueryPart,
e.g. whether this QueryPart should be rendered as a
declaration or reference, whether this QueryPart's contained
bind variables should be inlined or replaced by '?', etc.
Deprecated: - 3.4.0 - [#2694] - Use accept(Context<?>) instead.
/**
* Render this {@link QueryPart} to a SQL string contained in
* <code>context.sql()</code>. The <code>context</code> will contain
* additional information about how to render this <code>QueryPart</code>,
* e.g. whether this <code>QueryPart</code> should be rendered as a
* declaration or reference, whether this <code>QueryPart</code>'s contained
* bind variables should be inlined or replaced by <code>'?'</code>, etc.
*
* @deprecated - 3.4.0 - [#2694] - Use {@link #accept(Context)} instead.
*/
@Deprecated
void toSQL(RenderContext ctx);
Bind all parameters of this QueryPart to a PreparedStatement
This method is for JOOQ INTERNAL USE only. Do not reference directly
Params: - ctx – The context holding the next bind index and other information
for variable binding
Throws: - DataAccessException – If something went wrong while binding a
variable
Deprecated: - 3.4.0 - [#2694] - Use accept(Context<?>) instead.
/**
* Bind all parameters of this {@link QueryPart} to a PreparedStatement
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*
* @param ctx The context holding the next bind index and other information
* for variable binding
* @throws DataAccessException If something went wrong while binding a
* variable
* @deprecated - 3.4.0 - [#2694] - Use {@link #accept(Context)} instead.
*/
@Deprecated
void bind(BindContext ctx) throws DataAccessException;
The Clauses that are represented by this query part. QueryParts can specify several Clauses for which an event will be emitted before (in forward order) and after (in reverse order) visiting the the query part through Context.visit(QueryPart)
This method is for JOOQ INTERNAL USE only. Do not reference directly
Returns: The Clauses represented by this query part or
null or an empty array if this query part does not
represent a clause.
/**
* The {@link Clause}s that are represented by this query part.
* <p>
* {@link QueryPart}s can specify several <code>Clause</code>s for which an
* event will be emitted {@link Context#start(Clause) before} (in forward
* order) and {@link Context#end(Clause) after} (in reverse order) visiting
* the the query part through {@link Context#visit(QueryPart)}
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*
* @return The <code>Clause</code>s represented by this query part or
* <code>null</code> or an empty array if this query part does not
* represent a clause.
*/
@SuppressWarnings("javadoc")
Clause[] clauses(Context<?> ctx);
/**
* Check whether this {@link QueryPart} is able to declare fields in a
* <code>SELECT</code> clause.
* <p>
* This method can be used by any {@link Context} to check how a certain SQL
* clause should be rendered.
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*/
boolean declaresFields();
/**
* Check whether this {@link QueryPart} is able to declare tables in a
* <code>FROM</code> clause or <code>JOIN</code> clause.
* <p>
* This method can be used by any {@link Context} to check how a certain SQL
* clause should be rendered.
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*/
boolean declaresTables();
/**
* Check whether this {@link QueryPart} is able to declare windows in a
* <code>WINDOW</code> clause.
* <p>
* This method can be used by any {@link Context} to check how a certain SQL
* clause should be rendered.
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*/
boolean declaresWindows();
/**
* Check whether this {@link QueryPart} is able to declare common table
* expressions in a <code>WITH</code> clause.
* <p>
* This method can be used by any {@link Context} to check how a certain SQL
* clause should be rendered.
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*/
boolean declaresCTE();
/**
* Check whether this {@link QueryPart} is able to generate
* <code>CAST</code> expressions around bind variables.
* <p>
* This method can be used by any {@link Context} to check how a certain SQL
* clause should be rendered.
* <p>
* This method is for JOOQ INTERNAL USE only. Do not reference directly
*/
boolean generatesCast();
}