com.blazebit.persistence

Interface QueryBuilder<T,X extends QueryBuilder<T,X>>

Type Parameters:

T - The query result type

X - The concrete builder type

All Superinterfaces:

BaseQueryBuilder<T,X>, BaseWhereBuilder<X>, OrderByBuilder<X>, SelectBuilder<T,X>, WhereBuilder<X>

All Known Subinterfaces:

CriteriaBuilder<T>, PaginatedCriteriaBuilder<T>

public interface QueryBuilder<T,X extends QueryBuilder<T,X>>
extends BaseQueryBuilder<T,X>

A base interface for builders that support normal query functionality. This interface is shared between the criteria builder and paginated criteria builder.

Since:

1.0

Author:

Christian Beikov

Method Summary

Methods

Modifier and Type	Method and Description
X	fetch(String... paths) Adds an implicit join fetch for every given path to the query.
X	fetch(String path) Adds an implicit join fetch to the query.
javax.persistence.TypedQuery<T>	getQuery() Returns the JPA typed query for the built query.
List<T>	getResultList() Execute the query and return the result as a type List.
T	getSingleResult() Execute the query expecting a single result.
X	innerJoinFetch(String path, String alias) Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.INNER and fetch set to true.
X	innerJoinFetchDefault(String path, String alias) Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.INNER and fetch set to true.
X	join(String path, String alias, JoinType type, boolean fetch) Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias.
X	joinDefault(String path, String alias, JoinType type, boolean fetch) Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias.
X	leftJoinFetch(String path, String alias) Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.LEFT and fetch set to true.
X	leftJoinFetchDefault(String path, String alias) Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.LEFT and fetch set to true.
PaginatedCriteriaBuilder<T>	page(int firstResult, int maxResults) Paginates the results of this query.
PaginatedCriteriaBuilder<T>	page(KeysetPage keysetPage, int firstResult, int maxResults) Like page(int, int) but additionally uses key set pagination when possible.
PaginatedCriteriaBuilder<T>	page(Object entityId, int maxResults) Paginates the results of this query and navigates to the page on which the entity with the given entity id is located.
X	rightJoinFetch(String path, String alias) Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.RIGHT and fetch set to true.
X	rightJoinFetchDefault(String path, String alias) Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.RIGHT and fetch set to true.
QueryBuilder<T,?>	select(String expression) Adds a select clause with the given expression to the query.
QueryBuilder<T,?>	select(String expression, String alias) Adds a select clause with the given expression and alias to the query.
CaseWhenStarterBuilder<? extends QueryBuilder<T,?>>	selectCase() Like SelectBuilder.selectCase(java.lang.String) but without an alias.
CaseWhenStarterBuilder<? extends QueryBuilder<T,?>>	selectCase(String alias) Starts a CaseWhenBuilder with the given alias as select alias.
<Y> SelectObjectBuilder<? extends QueryBuilder<Y,?>>	selectNew(Class<Y> clazz) Starts a SelectObjectBuilder for the given class.
<Y> SelectObjectBuilder<? extends QueryBuilder<Y,?>>	selectNew(Constructor<Y> constructor) Starts a SelectObjectBuilder for the given constructor.
<Y> QueryBuilder<Y,?>	selectNew(ObjectBuilder<Y> builder) Applies the given object builder to this query.
SimpleCaseWhenStarterBuilder<? extends QueryBuilder<T,?>>	selectSimpleCase(String expression) Like SelectBuilder.selectSimpleCase(java.lang.String, java.lang.String) but without an alias.
SimpleCaseWhenStarterBuilder<? extends QueryBuilder<T,?>>	selectSimpleCase(String expression, String alias) Starts a SimpleCaseWhenBuilder with the given alias as select alias.
SubqueryInitiator<? extends QueryBuilder<T,?>>	selectSubquery() Like SelectBuilder.selectSubquery(java.lang.String) but without an alias.
SubqueryInitiator<? extends QueryBuilder<T,?>>	selectSubquery(String alias) Starts a SubqueryInitiator for the select item with the given alias.
SubqueryInitiator<? extends QueryBuilder<T,?>>	selectSubquery(String subqueryAlias, String expression) Like SelectBuilder.selectSubquery(java.lang.String,java.lang.String,java.lang.String) but without a select alias.
SubqueryInitiator<? extends QueryBuilder<T,?>>	selectSubquery(String subqueryAlias, String expression, String selectAlias) Starts a SubqueryInitiator for a new select item with the given select alias.

Methods inherited from interface com.blazebit.persistence.BaseQueryBuilder

afterKeyset, afterKeyset, afterKeyset, beforeKeyset, beforeKeyset, beforeKeyset, containsParameter, from, from, getCriteriaBuilderFactory, getMetamodel, getParameter, getParameters, getParameterValue, getQueryString, getResultType, innerJoin, innerJoinDefault, innerJoinDefaultOn, innerJoinOn, isParameterSet, join, joinDefault, joinDefaultOn, joinOn, leftJoin, leftJoinDefault, leftJoinDefaultOn, leftJoinOn, rightJoin, rightJoinDefault, rightJoinDefaultOn, rightJoinOn, setParameter, setParameter, setParameter

Methods inherited from interface com.blazebit.persistence.WhereBuilder

whereOr

Methods inherited from interface com.blazebit.persistence.BaseWhereBuilder

where, whereCase, whereExists, whereNotExists, whereSimpleCase, whereSubquery, whereSubquery

Methods inherited from interface com.blazebit.persistence.OrderByBuilder

orderBy, orderByAsc, orderByAsc, orderByDesc, orderByDesc

Method Detail

getQuery

javax.persistence.TypedQuery<T> getQuery()

Returns the JPA typed query for the built query. The returned query is already parameterized with all known parameters.

Returns:

The typed query for the built query

getResultList

List<T> getResultList()

Execute the query and return the result as a type List.

Returns:

The list of the results

getSingleResult

T getSingleResult()

Execute the query expecting a single result.

Returns:

The single result

page

PaginatedCriteriaBuilder<T> page(int firstResult,
                               int maxResults)

Paginates the results of this query.

Please note: The pagination only works on entity level and NOT on row level. This means that for queries which yield multiple result set rows per entity (i.e. rows with the same entity id), the multiple rows are treated as 1 page entry during the pagination process. Hence, the result size of such paginated queries might be greater than the specified page size.

An example for such queries would be a query that joins a collection: SELECT d.id, contacts.name FROM Document d LEFT JOIN d.contacts contacts If one Document has associated multiple contacts, the above query will produce multiple result set rows for this document.

Since the pagination works on entity id level, the results are implicitely grouped by id and distinct. Therefore calling distinct() or groupBy() on a PaginatedCriteriaBuilder is not allowed.

Parameters:

firstResult - The position of the first result to retrieve, numbered from 0

maxResults - The maximum number of results to retrieve

Returns:

This query builder as paginated query builder

page

PaginatedCriteriaBuilder<T> page(Object entityId,
                               int maxResults)

Paginates the results of this query and navigates to the page on which the entity with the given entity id is located. Beware that the same limitations like for page(int, int) apply. If the entity with the given entity id does not exist in the result list:

• The result of PaginatedCriteriaBuilder.getResultList() will contain the first page
• PagedList.getFirstResult() will return -1

Parameters:

entityId - The id of the entity which should be located on the page

maxResults - The maximum number of results to retrieve

Returns:

This query builder as paginated query builder

page

PaginatedCriteriaBuilder<T> page(KeysetPage keysetPage,
                               int firstResult,
                               int maxResults)

Like page(int, int) but additionally uses key set pagination when possible. Beware that keyset pagination should not be used as a direct replacement for offset pagination. Since entries that have a lower rank than some keyset might be added or removed, the calculations for the firstResult might be wrong. If strict pagination is required, then a keyset should be thrown away when the count of lower ranked items changes to make use of offset pagination again.

Key set pagination is possible if and only if the following conditions are met:

• This keyset reference values fit the order by expressions of this query builder AND
• KeysetPage.getMaxResults() and maxResults evaluate to the same value AND
• One of the following conditions is met:
  • The absolute value of KeysetPage.getFirstResult() - firstResult is 0
  • The absolute value of KeysetPage.getFirstResult() - firstResult is equal to the value of maxResults

Parameters:

keysetPage - The key set from a previous result, may be null

firstResult - The position of the first result to retrieve, numbered from 0

maxResults - The maximum number of results to retrieve

Returns:

This query builder as paginated query builder

See Also:

PagedList.getKeysetPage()

join

X join(String path,
     String alias,
     JoinType type,
     boolean fetch)

Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias. If fetch is set to true, a join fetch will be added.

Parameters:

path - The path to join

alias - The alias for the joined element

type - The join type

fetch - True if a join fetch should be added

Returns:

The query builder for chaining calls

joinDefault

X joinDefault(String path,
            String alias,
            JoinType type,
            boolean fetch)

Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias. The resulting join will be the default join meaning that expressions which use the absolute path will refer to this join. If fetch is set to true, a join fetch will be added.

Parameters:

path - The path to join

alias - The alias for the joined element

type - The join type

fetch - True if a join fetch should be added

Returns:

The query builder for chaining calls

fetch

X fetch(String path)

Adds an implicit join fetch to the query.

Parameters:

path - The path to join fetch

Returns:

The query builder for chaining calls

fetch

X fetch(String... paths)

Adds an implicit join fetch for every given path to the query.

Parameters:

paths - The paths to join fetch

Returns:

The query builder for chaining calls

innerJoinFetch

X innerJoinFetch(String path,
               String alias)

Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.INNER and fetch set to true.

Parameters:

path - The path to join

alias - The alias for the joined element

Returns:

The query builder for chaining calls

innerJoinFetchDefault

X innerJoinFetchDefault(String path,
                      String alias)

Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.INNER and fetch set to true.

Parameters:

path - The path to join

alias - The alias for the joined element

Returns:

The query builder for chaining calls

leftJoinFetch

X leftJoinFetch(String path,
              String alias)

Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.LEFT and fetch set to true.

Parameters:

path - The path to join

alias - The alias for the joined element

Returns:

The query builder for chaining calls

leftJoinFetchDefault

X leftJoinFetchDefault(String path,
                     String alias)

Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.LEFT and fetch set to true.

Parameters:

path - The path to join

alias - The alias for the joined element

Returns:

The query builder for chaining calls

rightJoinFetch

X rightJoinFetch(String path,
               String alias)

Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.RIGHT and fetch set to true.

Parameters:

path - The path to join

alias - The alias for the joined element

Returns:

The query builder for chaining calls

rightJoinFetchDefault

X rightJoinFetchDefault(String path,
                      String alias)

Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType, boolean) but with JoinType.RIGHT and fetch set to true.

Parameters:

path - The path to join

alias - The alias for the joined element

Returns:

The query builder for chaining calls

selectNew

<Y> SelectObjectBuilder<? extends QueryBuilder<Y,?>> selectNew(Class<Y> clazz)

Starts a SelectObjectBuilder for the given class. The types of the parameter arguments used in the SelectObjectBuilder must match a constructor of the given class.

Type Parameters:

Y - The new query result type specified by the given class

Parameters:

clazz - The class which should be used for the select new select clause

Returns:

The select object builder for the given class

selectNew

<Y> SelectObjectBuilder<? extends QueryBuilder<Y,?>> selectNew(Constructor<Y> constructor)

Starts a SelectObjectBuilder for the given constructor. The types of the parameter arguments used in the SelectObjectBuilder must match the given constructor.

Type Parameters:

Y - The new query result type specified by the given class

Parameters:

constructor - The constructor which should be used for the select new select clause

Returns:

The select object builder for the given class

selectNew

<Y> QueryBuilder<Y,?> selectNew(ObjectBuilder<Y> builder)

Applies the given object builder to this query. The object builder provides the select clauses and is used to transform the result set tuples.

Type Parameters:

Y - The new query result type specified by the given class

Parameters:

builder - The object builder which transforms the result set into objects of type Y

Returns:

The query builder for chaining calls

selectSimpleCase

SimpleCaseWhenStarterBuilder<? extends QueryBuilder<T,?>> selectSimpleCase(String expression)

Description copied from interface: SelectBuilder

Like SelectBuilder.selectSimpleCase(java.lang.String, java.lang.String) but without an alias.

Specified by:

selectSimpleCase in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectSimpleCase in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

expression - The case operand

Returns:

The simple case when builder

selectSimpleCase

SimpleCaseWhenStarterBuilder<? extends QueryBuilder<T,?>> selectSimpleCase(String expression,
                                                                         String alias)

Description copied from interface: SelectBuilder

Starts a SimpleCaseWhenBuilder with the given alias as select alias. The expression is the case operand which will be compared to the when expressions defined in the subsequent SimpleCaseWhenBuilder.

Specified by:

selectSimpleCase in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectSimpleCase in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

expression - The case operand

alias - The select alias for the simple case when expression

Returns:

The simple case when builder

selectCase

CaseWhenStarterBuilder<? extends QueryBuilder<T,?>> selectCase()

Description copied from interface: SelectBuilder

Like SelectBuilder.selectCase(java.lang.String) but without an alias.

Specified by:

selectCase in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectCase in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Returns:

The case when builder

selectCase

CaseWhenStarterBuilder<? extends QueryBuilder<T,?>> selectCase(String alias)

Description copied from interface: SelectBuilder

Starts a CaseWhenBuilder with the given alias as select alias.

Specified by:

selectCase in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectCase in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

alias - The select alias for the case when expression

Returns:

The case when builder

select

QueryBuilder<T,?> select(String expression)

Description copied from interface: SelectBuilder

Adds a select clause with the given expression to the query.

Specified by:

select in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

select in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

expression - The expression for the select clause

Returns:

The query builder for chaining calls

select

QueryBuilder<T,?> select(String expression,
                       String alias)

Description copied from interface: SelectBuilder

Adds a select clause with the given expression and alias to the query.

Specified by:

select in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

select in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

expression - The expression for the select clause

alias - The alias for the expression

Returns:

The query builder for chaining calls

selectSubquery

SubqueryInitiator<? extends QueryBuilder<T,?>> selectSubquery()

Description copied from interface: SelectBuilder

Like SelectBuilder.selectSubquery(java.lang.String) but without an alias.

Specified by:

selectSubquery in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectSubquery in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Returns:

The subquery initiator for building a subquery

selectSubquery

SubqueryInitiator<? extends QueryBuilder<T,?>> selectSubquery(String alias)

Description copied from interface: SelectBuilder

Starts a SubqueryInitiator for the select item with the given alias. When the builder finishes, the select item is added to the parent container represented by the type X.

Specified by:

selectSubquery in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectSubquery in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

alias - The select alias for the subquery

Returns:

The subquery initiator for building a subquery

selectSubquery

SubqueryInitiator<? extends QueryBuilder<T,?>> selectSubquery(String subqueryAlias,
                                                            String expression,
                                                            String selectAlias)

Description copied from interface: SelectBuilder

Starts a SubqueryInitiator for a new select item with the given select alias.

All occurrences of subqueryAlias in expression will be replaced by the subquery. When the builder finishes, the select item is added to the parent container represented by the type X.

Specified by:

selectSubquery in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectSubquery in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

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

expression - The expression which will be added as select item. This expression contains the subqueryAlias to define the insertion points for the subquery.

selectAlias - The select alias for the expression

Returns:

The subquery initiator for building a subquery

selectSubquery

SubqueryInitiator<? extends QueryBuilder<T,?>> selectSubquery(String subqueryAlias,
                                                            String expression)

Description copied from interface: SelectBuilder

Like SelectBuilder.selectSubquery(java.lang.String,java.lang.String,java.lang.String) but without a select alias.

Specified by:

selectSubquery in interface BaseQueryBuilder<T,X extends QueryBuilder<T,X>>

Specified by:

selectSubquery in interface SelectBuilder<T,X extends QueryBuilder<T,X>>

Parameters:

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

expression - The expression which will be added as select item

Returns:

The subquery initiator for building a subquery