Interface JpaQueryStructure<T>

All Superinterfaces:

JpaCriteriaNode, JpaQueryPart<T>, Serializable

All Known Implementing Classes:

SqmQuerySpec

public interface JpaQueryStructure<T>
extends JpaQueryPart<T>

Models a SELECT query. Used as a delegate in implementing CriteriaQuery and Subquery.

See Also:

• JpaCriteriaQuery
• JpaSubQuery

API Note:

Internally (HQL and SQM) Hibernate supports ordering and limiting for both root- and sub- criteria even though JPA only defines support for them on a root.

Method Summary

Modifier and Type	Method	Description
JpaQueryStructure<T>	addRoot(JpaRoot<?> root)	Add a query root.
List<? extends JpaExpression<?>>	getGroupingExpressions()	Return the grouping expressions.
JpaPredicate	getGroupRestriction()	Return the group restriction.
JpaPredicate	getRestriction()	Set the restriction.
List<? extends JpaRoot<?>>	getRootList()	Return the query roots as a list.
Set<? extends JpaRoot<?>>	getRoots()	Return the query roots.
JpaSelection<T>	getSelection()	Return the query selection.
boolean	isDistinct()	Return whether duplicate query results are eliminated.
JpaQueryStructure<T>	setDistinct(boolean distinct)	Set whether duplicate query results are eliminated.
JpaQueryStructure<T>	setFetch(JpaExpression<? extends Number> fetch)	Set the query fetch limit.
JpaQueryStructure<T>	setFetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)	Set the query fetch limit.
JpaQueryStructure<T>	setGroupingExpressions(Expression<?>... grouping)	Set the grouping expressions.
JpaQueryStructure<T>	setGroupingExpressions(List<? extends Expression<?>> grouping)	Set the grouping expressions.
JpaQueryStructure<T>	setGroupRestriction(BooleanExpression... restrictions)	Set the group restriction.
JpaQueryStructure<T>	setGroupRestriction(Expression<Boolean> restriction)	Set the group restriction.
JpaQueryStructure<T>	setGroupRestriction(Predicate... restrictions)	Set the group restriction.
JpaQueryStructure<T>	setGroupRestriction(List<Predicate> restrictions)	Set the group restriction.
JpaQueryStructure<T>	setGroupRestriction(JpaPredicate restrictions)	Set the group restriction.
JpaQueryStructure<T>	setOffset(JpaExpression<? extends Number> offset)	Set the query offset.
JpaQueryStructure<T>	setRestriction(BooleanExpression... restrictions)	Set the restriction.
JpaQueryStructure<T>	setRestriction(Expression<Boolean> restriction)	Set the restriction.
JpaQueryStructure<T>	setRestriction(Predicate... restrictions)	Set the restriction.
JpaQueryStructure<T>	setRestriction(List<Predicate> restrictions)	Set the restriction.
JpaQueryStructure<T>	setRestriction(JpaPredicate restriction)
JpaQueryStructure<T>	setSelection(JpaSelection<T> selection)	Set the query selection.
JpaQueryStructure<T>	setSortSpecifications(List<? extends JpaOrder> sortSpecifications)	Set the ordering specifications.

Methods inherited from interface JpaQueryPart

getFetch, getFetchClauseType, getOffset, getSortSpecifications

Method Details

isDistinct

boolean isDistinct()

Return whether duplicate query results are eliminated.

setDistinct

@Nonnull
JpaQueryStructure<T> setDistinct(boolean distinct)

Set whether duplicate query results are eliminated.

getSelection

@Nonnull
JpaSelection<T> getSelection()

Return the query selection.

setSelection

@Nonnull
JpaQueryStructure<T> setSelection(@Nonnull
 JpaSelection<T> selection)

Set the query selection.

getRoots

@Nonnull
Set<? extends JpaRoot<?>> getRoots()

Return the query roots.

getRootList

@Nonnull
List<? extends JpaRoot<?>> getRootList()

Return the query roots as a list.

addRoot

@Nonnull
JpaQueryStructure<T> addRoot(@Nonnull
 JpaRoot<?> root)

Add a query root.

getRestriction

@Nullable
JpaPredicate getRestriction()

Set the restriction.

setRestriction

@Nonnull
JpaQueryStructure<T> setRestriction(@Nullable
 JpaPredicate restriction)

setRestriction

@Nonnull
JpaQueryStructure<T> setRestriction(@Nullable
 Expression<Boolean> restriction)

Set the restriction.

setRestriction

@Nonnull
JpaQueryStructure<T> setRestriction(@Nonnull
 BooleanExpression... restrictions)

Set the restriction.

setRestriction

@Nonnull
JpaQueryStructure<T> setRestriction(@Nonnull
 Predicate... restrictions)

Set the restriction.

setRestriction

@Nonnull
JpaQueryStructure<T> setRestriction(@Nonnull
 List<Predicate> restrictions)

Set the restriction.

getGroupingExpressions

@Nonnull
List<? extends JpaExpression<?>> getGroupingExpressions()

Return the grouping expressions.

setGroupingExpressions

@Nonnull
JpaQueryStructure<T> setGroupingExpressions(@Nonnull
 List<? extends Expression<?>> grouping)

Set the grouping expressions.

setGroupingExpressions

@Nonnull
JpaQueryStructure<T> setGroupingExpressions(@Nonnull
 Expression<?>... grouping)

Set the grouping expressions.

getGroupRestriction

@Nullable
JpaPredicate getGroupRestriction()

Return the group restriction.

setGroupRestriction

@Nonnull
JpaQueryStructure<T> setGroupRestriction(@Nullable
 JpaPredicate restrictions)

Set the group restriction.

setGroupRestriction

@Nonnull
JpaQueryStructure<T> setGroupRestriction(@Nullable
 Expression<Boolean> restriction)

Set the group restriction.

setGroupRestriction

@Nonnull
JpaQueryStructure<T> setGroupRestriction(@Nullable
 Predicate... restrictions)

Set the group restriction.

setGroupRestriction

@Nonnull
JpaQueryStructure<T> setGroupRestriction(@Nullable
 BooleanExpression... restrictions)

Set the group restriction.

setGroupRestriction

@Nonnull
JpaQueryStructure<T> setGroupRestriction(@Nonnull
 List<Predicate> restrictions)

Set the group restriction.

setSortSpecifications

@Nonnull
JpaQueryStructure<T> setSortSpecifications(@Nonnull
 List<? extends JpaOrder> sortSpecifications)

Set the ordering specifications.

Specified by:

setSortSpecifications in interface JpaQueryPart<T>

setOffset

@Nonnull
JpaQueryStructure<T> setOffset(@Nullable
 JpaExpression<? extends Number> offset)

Set the query offset.

Specified by:

setOffset in interface JpaQueryPart<T>

setFetch

@Nonnull
JpaQueryStructure<T> setFetch(@Nullable
 JpaExpression<? extends Number> fetch)

Set the query fetch limit.

Specified by:

setFetch in interface JpaQueryPart<T>

setFetch

@Nonnull
JpaQueryStructure<T> setFetch(@Nullable
 JpaExpression<? extends Number> fetch,
 @Nonnull
 FetchClauseType fetchClauseType)

Set the query fetch limit.

Specified by:

setFetch in interface JpaQueryPart<T>