com.blazebit.persistence.BaseWhereBuilder 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 filtering.
* This is related to the fact, that a query builder supports where clauses.
*
* @param The concrete builder type
* @author Christian Beikov
* @since 1.0.0
*/
public interface BaseWhereBuilder> {
/**
* 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> whereSubquery();
/**
* 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.
* This expression contains the {@code subqueryAlias} to define the insertion points for the subquery.
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator> whereSubquery(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> whereSubqueries(String expression);
/**
* Starts a {@link SubqueryBuilder} based 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> whereSubquery(FullQueryBuilder criteriaBuilder);
/**
* Starts a {@link SubqueryBuilder} based 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> whereSubquery(String subqueryAlias, String expression, FullQueryBuilder criteriaBuilder);
/**
* Adds the given expression as expression for the where clause.
*
* @param expression The where expression
* @return The builder
* @since 1.4.0
*/
public T whereExpression(String expression);
/**
* Starts a {@link MultipleSubqueryInitiator} for expression of the where 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 parent predicate container represented by the type T.
*
*
* @param expression The where expression
* @return The subquery initiator for building multiple subqueries for their respective subqueryAliases
* @since 1.4.0
*/
public MultipleSubqueryInitiator whereExpressionSubqueries(String expression);
/**
* Starts a {@link RestrictionBuilder} for a where 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 where predicate
* @return The restriction builder for the given expression
*/
public RestrictionBuilder where(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> whereCase();
/**
* 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> whereSimpleCase(String expression);
/**
* Starts an exists predicate for the where 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 whereExists();
/**
* Starts an not exists predicate for the where 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 whereNotExists();
/**
* Starts an exists predicate for the where 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 whereExists(FullQueryBuilder criteriaBuilder);
/**
* Starts an exists predicate for the where 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 whereNotExists(FullQueryBuilder criteriaBuilder);
}