com.blazebit.persistence

Interface BaseWhereBuilder<T extends BaseWhereBuilder<T>>

Type Parameters:

T - The concrete builder type

All Known Subinterfaces:

BaseCriteriaBuilder<T,X>, BaseCTECriteriaBuilder<X>, BaseDeleteCriteriaBuilder<T,X>, BaseInsertCriteriaBuilder<T,X>, BaseModificationCriteriaBuilder<X>, BaseQueryBuilder<T,X>, BaseSubqueryBuilder<X>, BaseUpdateCriteriaBuilder<T,X>, CriteriaBuilder<T>, DeleteCriteriaBuilder<T>, FullQueryBuilder<T,X>, FullSelectCTECriteriaBuilder<X>, InsertCriteriaBuilder<T>, LeafOngoingSetOperationCriteriaBuilder<X>, LeafOngoingSetOperationCTECriteriaBuilder<X>, LeafOngoingSetOperationSubqueryBuilder<X>, ModificationCriteriaBuilder<X>, OngoingSetOperationCriteriaBuilder<T,Y>, OngoingSetOperationCTECriteriaBuilder<T,Y>, OngoingSetOperationSubqueryBuilder<T,Y>, PaginatedCriteriaBuilder<T>, QueryBuilder<T,X>, ReturningDeleteCriteriaBuilder<T,X>, ReturningInsertCriteriaBuilder<T,X>, ReturningModificationCriteriaBuilder<X,Y>, ReturningUpdateCriteriaBuilder<T,X>, SelectBaseCTECriteriaBuilder<X>, SelectCTECriteriaBuilder<X>, SelectRecursiveCTECriteriaBuilder<X>, StartOngoingSetOperationCriteriaBuilder<X,Y>, StartOngoingSetOperationCTECriteriaBuilder<X,Y>, StartOngoingSetOperationSubqueryBuilder<X,Y>, SubqueryBuilder<T>, UpdateCriteriaBuilder<T>, WhereAndBuilder<T>, WhereBuilder<T>, WhereOrBuilder<T>

public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>>

A base interface for builders that support filtering. This is related to the fact, that a query builder supports where clauses.

Since:

1.0.0

Author:

Christian Beikov

Method Summary

Methods

Modifier and Type	Method and Description
RestrictionBuilder<T>	where(String expression) Starts a RestrictionBuilder for a where predicate with the given expression as left hand expression.
CaseWhenStarterBuilder<RestrictionBuilder<T>>	whereCase() Starts a CaseWhenBuilder for a where predicate.
SubqueryInitiator<T>	whereExists() Starts an exists predicate for the where clause with a subquery on the right hand side.
SubqueryBuilder<T>	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.
SubqueryInitiator<T>	whereNotExists() Starts an not exists predicate for the where clause with a subquery on the right hand side.
SubqueryBuilder<T>	whereNotExists(FullQueryBuilder<?,?> criteriaBuilder) Starts an exists predicate for the where clause with a subquery on the right hand side based on the given criteria builder.
SimpleCaseWhenStarterBuilder<RestrictionBuilder<T>>	whereSimpleCase(String expression) Starts a SimpleCaseWhenBuilder for a where predicate.
MultipleSubqueryInitiator<RestrictionBuilder<T>>	whereSubqueries(String expression) Starts a MultipleSubqueryInitiator for the left hand side of a predicate.
SubqueryInitiator<RestrictionBuilder<T>>	whereSubquery() Starts a SubqueryInitiator for the left hand side of a predicate.
SubqueryBuilder<RestrictionBuilder<T>>	whereSubquery(FullQueryBuilder<?,?> criteriaBuilder) Starts a SubqueryBuilder based on the given criteria builder for the left hand side of a predicate.
SubqueryInitiator<RestrictionBuilder<T>>	whereSubquery(String subqueryAlias, String expression) Starts a SubqueryInitiator for the left hand side of a predicate.
SubqueryBuilder<RestrictionBuilder<T>>	whereSubquery(String subqueryAlias, String expression, FullQueryBuilder<?,?> criteriaBuilder) Starts a SubqueryBuilder based on the given criteria builder for the left hand side of a predicate.

Method Detail

whereSubquery

SubqueryInitiator<RestrictionBuilder<T>> whereSubquery()

Starts a 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.

Returns:

The subquery initiator for building a subquery

whereSubquery

SubqueryInitiator<RestrictionBuilder<T>> whereSubquery(String subqueryAlias,
                                                     String expression)

Starts a 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.

Parameters:

subqueryAlias - The alias for the subquery which will be replaced by the actual subquery

expression - The expression which will be used as left hand side of a predicate. This expression contains the subqueryAlias to define the insertion points for the subquery.

Returns:

The subquery initiator for building a subquery

whereSubqueries

MultipleSubqueryInitiator<RestrictionBuilder<T>> whereSubqueries(String expression)

Starts a 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.

Parameters:

expression - The expression which will be used as left hand side of a predicate

Returns:

The subquery initiator for building multiple subqueries for their respective subqueryAliases

Since:

1.2.0

whereSubquery

SubqueryBuilder<RestrictionBuilder<T>> whereSubquery(FullQueryBuilder<?,?> criteriaBuilder)

Starts a 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.

Parameters:

criteriaBuilder - The criteria builder to base the subquery on

Returns:

The subquery builder for building a subquery

Since:

1.2.0

whereSubquery

SubqueryBuilder<RestrictionBuilder<T>> whereSubquery(String subqueryAlias,
                                                   String expression,
                                                   FullQueryBuilder<?,?> criteriaBuilder)

Starts a 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.

Parameters:

subqueryAlias - The alias for the subquery which will be replaced by the actual subquery

expression - The expression which will be used as left hand side of a predicate

criteriaBuilder - The criteria builder to base the subquery on

Returns:

The subquery builder for building a subquery

Since:

1.2.0

where

RestrictionBuilder<T> where(String expression)

Starts a 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.

Parameters:

expression - The left hand expression for a where predicate

Returns:

The restriction builder for the given expression

whereCase

CaseWhenStarterBuilder<RestrictionBuilder<T>> whereCase()

Starts a CaseWhenBuilder for a where predicate. When the 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.

Returns:

A CaseWhenBuilder

whereSimpleCase

SimpleCaseWhenStarterBuilder<RestrictionBuilder<T>> whereSimpleCase(String expression)

Starts a SimpleCaseWhenBuilder for a where predicate. When the 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.

Parameters:

expression - Case operand expression

Returns:

A CaseWhenBuilder

whereExists

SubqueryInitiator<T> whereExists()

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.

Returns:

The subquery initiator for building a subquery

whereNotExists

SubqueryInitiator<T> whereNotExists()

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.

Returns:

The subquery initiator for building a subquery

whereExists

SubqueryBuilder<T> 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.

Parameters:

criteriaBuilder - The criteria builder to base the subquery on

Returns:

The subquery builder for building a subquery

Since:

1.2.0

whereNotExists

SubqueryBuilder<T> whereNotExists(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.

Parameters:

criteriaBuilder - The criteria builder to base the subquery on

Returns:

The subquery builder for building a subquery

Since:

1.2.0