/*
* 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 java.util.Collection;
import org.jooq.impl.DSL;
import org.jetbrains.annotations.NotNull;
The step in the specification of aggregate functions where the SQL:2003
standard FILTER clause
can be added.
Referencing XYZ*Step
types directly from client code
It is usually not recommended to reference any XYZ*Step
types
directly from client code, or assign them to local variables. When writing
dynamic SQL, creating a statement's components dynamically, and passing them
to the DSL API statically is usually a better choice. See the manual's
section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.
Drawbacks of referencing the XYZ*Step
types directly:
- They're operating on mutable implementations (as of jOOQ 3.x)
- They're less composable and not easy to get right when dynamic SQL gets
complex
- They're less readable
- They might have binary incompatible changes between minor releases
Author: Lukas Eder
/**
* The step in the specification of aggregate functions where the SQL:2003
* standard <code>FILTER clause</code> can be added.
* <p>
* <h3>Referencing <code>XYZ*Step</code> types directly from client code</h3>
* <p>
* It is usually not recommended to reference any <code>XYZ*Step</code> types
* directly from client code, or assign them to local variables. When writing
* dynamic SQL, creating a statement's components dynamically, and passing them
* to the DSL API statically is usually a better choice. See the manual's
* section about dynamic SQL for details: <a href=
* "https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql">https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql</a>.
* <p>
* Drawbacks of referencing the <code>XYZ*Step</code> types directly:
* <ul>
* <li>They're operating on mutable implementations (as of jOOQ 3.x)</li>
* <li>They're less composable and not easy to get right when dynamic SQL gets
* complex</li>
* <li>They're less readable</li>
* <li>They might have binary incompatible changes between minor releases</li>
* </ul>
*
* @author Lukas Eder
*/
public interface AggregateFilterStep<T> extends WindowBeforeOverStep<T> {
Add a FILTER clause
to the aggregate function, connecting conditions with each other with Operator.AND
. /**
* Add a <code>FILTER clause</code> to the aggregate function, connecting
* conditions with each other with {@link Operator#AND}.
*/
@NotNull
@Support
WindowBeforeOverStep<T> filterWhere(Condition condition);
Add a FILTER clause
to the aggregate function, connecting conditions with each other with Operator.AND
. /**
* Add a <code>FILTER clause</code> to the aggregate function, connecting
* conditions with each other with {@link Operator#AND}.
*/
@NotNull
@Support
WindowBeforeOverStep<T> filterWhere(Condition... conditions);
Add a FILTER clause
to the aggregate function, connecting conditions with each other with Operator.AND
. /**
* Add a <code>FILTER clause</code> to the aggregate function, connecting
* conditions with each other with {@link Operator#AND}.
*/
@NotNull
@Support
WindowBeforeOverStep<T> filterWhere(Collection<? extends Condition> conditions);
Add a FILTER clause
to the aggregate function.
/**
* Add a <code>FILTER clause</code> to the aggregate function.
*/
@NotNull
@Support
WindowBeforeOverStep<T> filterWhere(Field<Boolean> field);
Add a FILTER clause
to the aggregate function.
Deprecated: - 3.8.0 - [#4763] - Use filterWhere(Condition)
(typically with DSL.trueCondition()
, DSL.falseCondition()
, or DSL.noCondition()
as the parameter) or filterWhere(Field)
instead. Due to ambiguity between calling this method using Field.equals(Object)
argument, vs. calling the other method via a Field.equal(Object)
argument, this method will be removed in the future.
/**
* Add a <code>FILTER clause</code> to the aggregate function.
*
* @deprecated - 3.8.0 - [#4763] - Use {@link #filterWhere(Condition)}
* (typically with {@link DSL#trueCondition()},
* {@link DSL#falseCondition()}, or {@link DSL#noCondition()} as
* the parameter) or {@link #filterWhere(Field)} instead. Due to
* ambiguity between calling this method using
* {@link Field#equals(Object)} argument, vs. calling the other
* method via a {@link Field#equal(Object)} argument, this
* method will be removed in the future.
*/
@Deprecated
@NotNull
@Support
WindowBeforeOverStep<T> filterWhere(Boolean field);
Add a FILTER clause
to the aggregate function.
NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also: - condition.condition(SQL)
- SQL
/**
* Add a <code>FILTER clause</code> to the aggregate function.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(SQL)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
WindowBeforeOverStep<T> filterWhere(SQL sql);
Add a FILTER clause
to the aggregate function.
NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also: - condition.condition(String)
- SQL
/**
* Add a <code>FILTER clause</code> to the aggregate function.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
WindowBeforeOverStep<T> filterWhere(String sql);
Add a FILTER clause
to the aggregate function.
NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also: - condition.condition(String, Object...)
- DSL.sql(String, Object...)
- SQL
/**
* Add a <code>FILTER clause</code> to the aggregate function.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String, Object...)
* @see DSL#sql(String, Object...)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
WindowBeforeOverStep<T> filterWhere(String sql, Object... bindings);
Add a FILTER clause
to the aggregate function.
NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also: - condition.condition(String, QueryPart...)
- DSL.sql(String, QueryPart...)
- SQL
/**
* Add a <code>FILTER clause</code> to the aggregate function.
* <p>
* <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String, QueryPart...)
* @see DSL#sql(String, QueryPart...)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
WindowBeforeOverStep<T> filterWhere(String sql, QueryPart... parts);
}