com.blazebit.persistence.BaseHavingBuilder Maven / Gradle / Ivy
/*
* Copyright 2014 - 2021 Blazebit.
*
* 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.
*/
package com.blazebit.persistence;
/**
* A base interface for builders that support having.
* This is related to the fact, that a query builder supports group by and having clauses.
*
* @param The concrete builder type
* @author Christian Beikov
* @since 1.0.0
*/
public interface BaseHavingBuilder> {
/**
* Starts a {@link SubqueryInitiator} for the left hand side of a predicate.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type T.
*
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator> havingSubquery();
/**
* Starts a {@link SubqueryInitiator} for the left hand side of a predicate. All occurrences of subqueryAlias in
* expression will be replaced by the subquery.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type T.
*
* @param subqueryAlias The alias for the subquery which will be replaced by the actual subquery
* @param expression The expression which will be used as left hand side of a predicate
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator> havingSubquery(String subqueryAlias, String expression);
/**
* Starts a {@link MultipleSubqueryInitiator} for the left hand side of a predicate.
*
*
* All occurrences of subsequently defined subqueryAliases in expression will be replaced by the respective subquery.
* When the builder finishes, the resulting expression is used for the left hand side of the predicate.
*
*
* @param expression The expression which will be used as left hand side of a predicate
* @return The subquery initiator for building multiple subqueries for their respective subqueryAliases
* @since 1.2.0
*/
public MultipleSubqueryInitiator> havingSubqueries(String expression);
/**
* Starts a {@link SubqueryBuilder} base on the given criteria builder for the left hand side of a predicate.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type T.
*
* @param criteriaBuilder The criteria builder to base the subquery on
* @return The subquery builder for building a subquery
* @since 1.2.0
*/
public SubqueryBuilder> havingSubquery(FullQueryBuilder criteriaBuilder);
/**
* Starts a {@link SubqueryBuilder} base on the given criteria builder for the left hand side of a predicate. All occurrences of subqueryAlias in
* expression will be replaced by the subquery.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type T.
*
* @param subqueryAlias The alias for the subquery which will be replaced by the actual subquery
* @param expression The expression which will be used as left hand side of a predicate
* @param criteriaBuilder The criteria builder to base the subquery on
* @return The subquery builder for building a subquery
* @since 1.2.0
*/
public SubqueryBuilder> havingSubquery(String subqueryAlias, String expression, FullQueryBuilder criteriaBuilder);
/**
* Adds the given expression as expression to the having clause.
*
* @param expression The having expression
* @return The builder
* @since 1.4.0
*/
public T havingExpression(String expression);
/**
* Starts a {@link MultipleSubqueryInitiator} for expression of the having clause.
*
*
* All occurrences of subsequently defined subqueryAliases in expression will be replaced by the respective subquery.
* When the builder finishes, the resulting expression is added as expression to the having clause.
*
*
* @param expression The having expression
* @return The subquery initiator for building multiple subqueries for their respective subqueryAliases
* @since 1.4.0
*/
public MultipleSubqueryInitiator havingExpressionSubqueries(String expression);
/**
* Starts a {@link RestrictionBuilder} for a having predicate with the given expression as left hand expression.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type T.
*
* @param expression The left hand expression for a having predicate
* @return The restriction builder for the given expression
*/
public RestrictionBuilder having(String expression);
/**
* Starts a {@link CaseWhenBuilder} for a where predicate.
* When the {@link CaseWhenBuilder} and the restriction builder for the right hand side are finished,
* the predicate is added to the parent predicate container represented by the type T.
*
* @return A {@link CaseWhenBuilder}
*/
public CaseWhenStarterBuilder> havingCase();
/**
* Starts a {@link SimpleCaseWhenBuilder} for a where predicate.
* When the {@link CaseWhenBuilder} and the restriction builder for the right hand side are finished,
* the predicate is added to the parent predicate container represented by the type T.
*
* @param expression Case operand expression
* @return A {@link CaseWhenBuilder}
*/
public SimpleCaseWhenStarterBuilder> havingSimpleCase(String expression);
/**
* Starts an exists predicate for the having clause with a subquery on the right hand side.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type T.
*
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator havingExists();
/**
* Starts an exists predicate for the having clause with a subquery on the right hand side.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type T.
*
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator havingNotExists();
/**
* Starts an exists predicate for the having clause with a subquery on the right hand side based on the given criteria builder.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type T.
*
* @param criteriaBuilder The criteria builder to base the subquery on
* @return The subquery builder for building a subquery
* @since 1.2.0
*/
public SubqueryBuilder havingExists(FullQueryBuilder criteriaBuilder);
/**
* Starts an exists predicate for the having clause with a subquery on the right hand side based on the given criteria builder.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type T.
*
* @param criteriaBuilder The criteria builder to base the subquery on
* @return The subquery builder for building a subquery
* @since 1.2.0
*/
public SubqueryBuilder havingNotExists(FullQueryBuilder criteriaBuilder);
}