Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.query.sqm.tree.select.SqmSelectStatement

Modifier and Type	Field and Description
private Set<SqmParameter<?>>	parameters
private final SqmQuerySource	querySource

Access	Constructor and Description
public	SqmSelectStatement(NodeBuilder nodeBuilder)
public	SqmSelectStatement(SqmQuerySource querySource, NodeBuilder nodeBuilder)
public	SqmSelectStatement(Class<T> resultJavaType, SqmQuerySource querySource, NodeBuilder nodeBuilder)
public	SqmSelectStatement(SqmQueryPart<T> queryPart, Class<T> resultType, SqmQuerySource querySource, NodeBuilder builder)
public	SqmSelectStatement(SqmQueryPart<T> queryPart, Class<T> resultType, Map<String, SqmCteStatement<?>> cteStatements, SqmQuerySource querySource, NodeBuilder builder)
public	SqmSelectStatement(Class<T> resultJavaType, NodeBuilder nodeBuilder)
public	SqmSelectStatement(SqmSelectStatement<T> original)
private	SqmSelectStatement(NodeBuilder builder, Map<String, SqmCteStatement<?>> cteStatements, Class<T> resultType, SqmQuerySource querySource, Set<SqmParameter<?>> parameters)

Modifier and Type	Method and Description
public <X> X	accept(SemanticQueryWalker<X> walker) Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept. Accept the walker per visitation
public void	addParameter(SqmParameter<?> parameter) Implements org.hibernate.query.sqm.internal.ParameterCollector.addParameter.
private void	checkSelectionIsJpaCompliant(Selection<?> selection)
public boolean	containsCollectionFetches()
private boolean	containsCollectionFetches(SqmQueryPart<?> queryPart)
public SqmSelectStatement<T>	copy(SqmCopyContext context) Implements org.hibernate.query.sqm.tree.SqmStatement.copy, org.hibernate.query.sqm.tree.select.SqmSelectQuery.copy, org.hibernate.query.sqm.tree.SqmNode.copy.
public JpaCriteriaQuery<Long>	createCountQuery() Implements org.hibernate.query.criteria.JpaCriteriaQuery.createCountQuery. Wraps this query in a subquery and returns a count query based on that subquery in the from clause.
public SqmSelectStatement<T>	distinct(boolean boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained distinct) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.distinct. Implements org.hibernate.query.criteria.JpaCriteriaQuery.distinct, org.hibernate.query.sqm.tree.select.SqmSelectQuery.distinct. Specify whether duplicate query results will be eliminated.
public JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.
public JpaCriteriaQuery<T>	fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.
public JpaCriteriaQuery<T>	fetch(Number fetch) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.
public JpaCriteriaQuery<T>	fetch(Number fetch, FetchClauseType fetchClauseType) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.
public JpaExpression<Number>	getFetch() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getFetch.
public FetchClauseType	getFetchClauseType() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getFetchClauseType.
public JpaExpression<Number>	getOffset() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getOffset.
public Set<ParameterExpression<?>>	getParameters() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getParameters. Return the parameters of the query.
public SqmQuerySource	getQuerySource() Implements org.hibernate.query.sqm.tree.SqmStatement.getQuerySource.
public SqmQuerySpec<T>	getQuerySpec() Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.getQuerySpec. Implements org.hibernate.query.criteria.JpaSelectCriteria.getQuerySpec, org.hibernate.query.sqm.tree.select.SqmSelectQuery.getQuerySpec. The query structure.
public Set<SqmParameter<?>>	getSqmParameters() Implements org.hibernate.query.sqm.tree.SqmStatement.getSqmParameters. Access to the (potentially still growing) collection of parameters for the statement.
public SqmSelectStatement<T>	groupBy(Expression<?>... zero or more grouping expressions expressions) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.groupBy. Implements org.hibernate.query.criteria.JpaCriteriaQuery.groupBy, org.hibernate.query.criteria.JpaSelectCriteria.groupBy. Specify the expressions that are used to form groups over the query results.
public SqmSelectStatement<T>	groupBy(List<Expression<?>> list of zero or more grouping expressions grouping) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.groupBy. Implements org.hibernate.query.criteria.JpaCriteriaQuery.groupBy, org.hibernate.query.criteria.JpaSelectCriteria.groupBy. Specify the expressions that are used to form groups over the query results.
public SqmSelectStatement<T>	having(Expression<Boolean> a simple or compound boolean expression booleanExpression) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.having. Implements org.hibernate.query.criteria.JpaCriteriaQuery.having, org.hibernate.query.criteria.JpaSelectCriteria.having. Specify a restriction over the groups of the query.
public SqmSelectStatement<T>	having(Predicate... zero or more restriction predicates predicates) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.having. Implements org.hibernate.query.criteria.JpaCriteriaQuery.having, org.hibernate.query.criteria.JpaSelectCriteria.having. Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
public SqmSelectStatement<T>	multiselect(Selection<?>... selection items corresponding to the results to be returned by the query selections) Implements org.hibernate.query.criteria.JpaCriteriaQuery.multiselect. Specify the selection items that are to be returned in the query result.
public SqmSelectStatement<T>	multiselect(List<Selection<?>> list of selection items corresponding to the results to be returned by the query selectionList) Implements org.hibernate.query.criteria.JpaCriteriaQuery.multiselect. Specify the selection items that are to be returned in the query result.
public JpaCriteriaQuery<T>	offset(JpaExpression<? extends Number> offset) Implements org.hibernate.query.criteria.JpaCriteriaQuery.offset.
public JpaCriteriaQuery<T>	offset(Number offset) Implements org.hibernate.query.criteria.JpaCriteriaQuery.offset.
public SqmSelectStatement<T>	orderBy(Order... zero or more ordering expressions orders) Implements org.hibernate.query.criteria.JpaCriteriaQuery.orderBy. Specify the ordering expressions that are used to order the query results.
public SqmSelectStatement<T>	orderBy(List<Order> list of zero or more ordering expressions orders) Implements org.hibernate.query.criteria.JpaCriteriaQuery.orderBy. Specify the ordering expressions that are used to order the query results.
public boolean	producesUniqueResults()
private boolean	producesUniqueResults(SqmQueryPart<?> queryPart)
private void	resetSelections(SqmQueryPart<?> queryPart)
private void	resetSelections(SqmQuerySpec<?> querySpec)
public SqmStatement.ParameterResolutions	resolveParameters() Implements org.hibernate.query.sqm.tree.SqmStatement.resolveParameters.
public SqmSelectStatement<T>	select(Selection<? extends T> selection specifying the item that is to be returned in the query result selection) Implements org.hibernate.query.criteria.JpaCriteriaQuery.select. Specify the item that is to be returned in the query result.
public <U> SqmSubQuery<U>	subquery(Class<U> the subquery result type type) Implements jakarta.persistence.criteria.CommonAbstractCriteria.subquery, org.hibernate.query.criteria.JpaCriteriaBase.subquery. Create a subquery of the query.
public boolean	usesDistinct()
private boolean	usesDistinct(SqmQueryPart<?> queryPart)
private void	validateComplianceFetchOffset()
public SqmSelectStatement<T>	where(Expression<Boolean> a simple or compound boolean expression restriction) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.where. Implements org.hibernate.query.criteria.JpaCriteriaQuery.where, org.hibernate.query.criteria.JpaSelectCriteria.where. Modify the query to restrict the query result according to the specified boolean expression.
public SqmSelectStatement<T>	where(Predicate... zero or more restriction predicates restrictions) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.where. Implements org.hibernate.query.criteria.JpaCriteriaQuery.where, org.hibernate.query.criteria.JpaSelectCriteria.where. Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.

parameters	back to summary
private Set<SqmParameter<?>> parameters

querySource	back to summary
private final SqmQuerySource querySource

SqmSelectStatement	back to summary
public SqmSelectStatement(NodeBuilder nodeBuilder)

SqmSelectStatement	back to summary
public SqmSelectStatement(SqmQuerySource querySource, NodeBuilder nodeBuilder)

SqmSelectStatement	back to summary
public SqmSelectStatement(Class<T> resultJavaType, SqmQuerySource querySource, NodeBuilder nodeBuilder)

SqmSelectStatement	back to summary
public SqmSelectStatement(SqmQueryPart<T> queryPart, Class<T> resultType, SqmQuerySource querySource, NodeBuilder builder)

SqmSelectStatement	back to summary
public SqmSelectStatement(SqmQueryPart<T> queryPart, Class<T> resultType, Map<String, SqmCteStatement<?>> cteStatements, SqmQuerySource querySource, NodeBuilder builder)

SqmSelectStatement	back to summary
public SqmSelectStatement(Class<T> resultJavaType, NodeBuilder nodeBuilder) Implementation Note This form is used from the criteria query API.

SqmSelectStatement	back to summary
public SqmSelectStatement(SqmSelectStatement<T> original) Implementation Note This form is used when transforming HQL to criteria. All it does is change the SqmQuerySource to CRITERIA in order to allow correct parameter handing.

SqmSelectStatement	back to summary
private SqmSelectStatement(NodeBuilder builder, Map<String, SqmCteStatement<?>> cteStatements, Class<T> resultType, SqmQuerySource querySource, Set<SqmParameter<?>> parameters)

Method Detail

accept	back to summary
public <X> X accept(SemanticQueryWalker<X> walker) Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept. Doc from org.hibernate.query.sqm.tree.SqmVisitableNode.accept. Accept the walker per visitation Annotations @Override

back to summary

public <X> X accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Doc from org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation

Annotations

@Override

addParameter	back to summary
public void addParameter(SqmParameter<?> parameter) Implements org.hibernate.query.sqm.internal.ParameterCollector.addParameter. Annotations @Override

addParameter

back to summary

public void addParameter(SqmParameter<?> parameter)

Implements org.hibernate.query.sqm.internal.ParameterCollector.addParameter.

Annotations

@Override

checkSelectionIsJpaCompliant	back to summary
private void checkSelectionIsJpaCompliant(Selection<?> selection)

containsCollectionFetches	back to summary
public boolean containsCollectionFetches()

containsCollectionFetches	back to summary
private boolean containsCollectionFetches(SqmQueryPart<?> queryPart)

copy	back to summary
public SqmSelectStatement<T> copy(SqmCopyContext context) Implements org.hibernate.query.sqm.tree.SqmStatement.copy, org.hibernate.query.sqm.tree.select.SqmSelectQuery.copy, org.hibernate.query.sqm.tree.SqmNode.copy. Annotations @Override

copy

back to summary

public SqmSelectStatement<T> copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.SqmStatement.copy, org.hibernate.query.sqm.tree.select.SqmSelectQuery.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

Annotations

@Override

createCountQuery	back to summary
public JpaCriteriaQuery<Long> createCountQuery() Implements org.hibernate.query.criteria.JpaCriteriaQuery.createCountQuery. Doc from org.hibernate.query.criteria.JpaCriteriaQuery.createCountQuery. Wraps this query in a subquery and returns a count query based on that subquery in the from clause. Annotations @Override

createCountQuery

back to summary

public JpaCriteriaQuery<Long> createCountQuery()

Implements org.hibernate.query.criteria.JpaCriteriaQuery.createCountQuery.

Doc from org.hibernate.query.criteria.JpaCriteriaQuery.createCountQuery.

Wraps this query in a subquery and returns a count query based on that subquery in the from clause.

Annotations

@Override

distinct back to summary

distinct	back to summary
public SqmSelectStatement<T> distinct(boolean distinct) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.distinct. Implements org.hibernate.query.criteria.JpaCriteriaQuery.distinct, org.hibernate.query.sqm.tree.select.SqmSelectQuery.distinct. Doc from jakarta.persistence.criteria.CriteriaQuery.distinct. Specify whether duplicate query results will be eliminated. A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained. This method only overrides the return type of the corresponding `AbstractQuery` method. Parameters distinct:boolean boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained Returns:SqmSelectStatement<T> the modified query. Annotations @Override

public SqmSelectStatement<T> distinct(boolean distinct)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.distinct.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.distinct, org.hibernate.query.sqm.tree.select.SqmSelectQuery.distinct.

Doc from jakarta.persistence.criteria.CriteriaQuery.distinct.

Specify whether duplicate query results will be eliminated. A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained. This method only overrides the return type of the corresponding AbstractQuery method.

Parameters

distinct:boolean: boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained

Returns:SqmSelectStatement<T>

the modified query.

Annotations

@Override

fetch	back to summary
public JpaCriteriaQuery<T> fetch(JpaExpression<? extends Number> fetch) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch. Annotations @Override

fetch

back to summary

public JpaCriteriaQuery<T> fetch(JpaExpression<? extends Number> fetch)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.

Annotations

@Override

fetch	back to summary
public JpaCriteriaQuery<T> fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch. Annotations @Override

fetch

back to summary

public JpaCriteriaQuery<T> fetch(JpaExpression<? extends Number> fetch, FetchClauseType fetchClauseType)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.

Annotations

@Override

fetch	back to summary
public JpaCriteriaQuery<T> fetch(Number fetch) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch. Annotations @Override

fetch

back to summary

public JpaCriteriaQuery<T> fetch(Number fetch)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.

Annotations

@Override

fetch	back to summary
public JpaCriteriaQuery<T> fetch(Number fetch, FetchClauseType fetchClauseType) Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch. Annotations @Override

fetch

back to summary

public JpaCriteriaQuery<T> fetch(Number fetch, FetchClauseType fetchClauseType)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.fetch.

Annotations

@Override

getFetch	back to summary
public JpaExpression<Number> getFetch() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getFetch. Annotations @Override

getFetch

back to summary

public JpaExpression<Number> getFetch()

Implements org.hibernate.query.criteria.JpaCriteriaQuery.getFetch.

Annotations

@Override

getFetchClauseType	back to summary
public FetchClauseType getFetchClauseType() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getFetchClauseType. Annotations @Override

getFetchClauseType

back to summary

public FetchClauseType getFetchClauseType()

Implements org.hibernate.query.criteria.JpaCriteriaQuery.getFetchClauseType.

Annotations

@Override

getOffset	back to summary
public JpaExpression<Number> getOffset() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getOffset. Annotations @Override

getOffset

back to summary

public JpaExpression<Number> getOffset()

Implements org.hibernate.query.criteria.JpaCriteriaQuery.getOffset.

Annotations

@Override

getParameters	back to summary
public Set<ParameterExpression<?>> getParameters() Implements org.hibernate.query.criteria.JpaCriteriaQuery.getParameters. Doc from org.hibernate.query.criteria.JpaCriteriaQuery.getParameters. Return the parameters of the query. Returns empty set if there are no parameters. Modifications to the set do not affect the query. Returns:Set<ParameterExpression<?>> Doc from jakarta.persistence.criteria.CriteriaQuery.getParameters. the query parameters Annotations @Override

getParameters

back to summary

public Set<ParameterExpression<?>> getParameters()

Implements org.hibernate.query.criteria.JpaCriteriaQuery.getParameters.

Doc from org.hibernate.query.criteria.JpaCriteriaQuery.getParameters.

Return the parameters of the query. Returns empty set if there are no parameters. Modifications to the set do not affect the query.

Returns:Set<ParameterExpression<?>>

Doc from jakarta.persistence.criteria.CriteriaQuery.getParameters.

the query parameters

Annotations

@Override

getQuerySource	back to summary
public SqmQuerySource getQuerySource() Implements org.hibernate.query.sqm.tree.SqmStatement.getQuerySource. Annotations @Override

getQuerySource

back to summary

public SqmQuerySource getQuerySource()

Implements org.hibernate.query.sqm.tree.SqmStatement.getQuerySource.

Annotations

@Override

getQuerySpec back to summary

getQuerySpec	back to summary
public SqmQuerySpec<T> getQuerySpec() Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.getQuerySpec. Implements org.hibernate.query.criteria.JpaSelectCriteria.getQuerySpec, org.hibernate.query.sqm.tree.select.SqmSelectQuery.getQuerySpec. Doc from org.hibernate.query.criteria.JpaSelectCriteria.getQuerySpec. The query structure. See `JpaQueryStructure` for details Annotations @Override

public SqmQuerySpec<T> getQuerySpec()

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.getQuerySpec.

Implements org.hibernate.query.criteria.JpaSelectCriteria.getQuerySpec, org.hibernate.query.sqm.tree.select.SqmSelectQuery.getQuerySpec.

Doc from org.hibernate.query.criteria.JpaSelectCriteria.getQuerySpec.

The query structure. See JpaQueryStructure for details

Annotations

@Override

getSqmParameters	back to summary
public Set<SqmParameter<?>> getSqmParameters() Implements org.hibernate.query.sqm.tree.SqmStatement.getSqmParameters. Doc from org.hibernate.query.sqm.tree.SqmStatement.getSqmParameters. Access to the (potentially still growing) collection of parameters for the statement. Annotations @Override

getSqmParameters

back to summary

public Set<SqmParameter<?>> getSqmParameters()

Implements org.hibernate.query.sqm.tree.SqmStatement.getSqmParameters.

Doc from org.hibernate.query.sqm.tree.SqmStatement.getSqmParameters.

Access to the (potentially still growing) collection of parameters for the statement.

Annotations

@Override

groupBy back to summary

groupBy	back to summary
public SqmSelectStatement<T> groupBy(Expression<?>... expressions) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.groupBy. Implements org.hibernate.query.criteria.JpaCriteriaQuery.groupBy, org.hibernate.query.criteria.JpaSelectCriteria.groupBy. Doc from jakarta.persistence.criteria.CriteriaQuery.groupBy. Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding `AbstractQuery` method. Parameters expressions:Expression<?>[] zero or more grouping expressions Returns:SqmSelectStatement<T> the modified query Annotations @Override

public SqmSelectStatement<T> groupBy(Expression<?>... expressions)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.groupBy.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.groupBy, org.hibernate.query.criteria.JpaSelectCriteria.groupBy.

Doc from jakarta.persistence.criteria.CriteriaQuery.groupBy.

Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.

Parameters

expressions:Expression<?>[]: zero or more grouping expressions

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

groupBy back to summary

groupBy	back to summary
public SqmSelectStatement<T> groupBy(List<Expression<?>> grouping) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.groupBy. Implements org.hibernate.query.criteria.JpaCriteriaQuery.groupBy, org.hibernate.query.criteria.JpaSelectCriteria.groupBy. Doc from jakarta.persistence.criteria.CriteriaQuery.groupBy. Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding `AbstractQuery` method. Parameters grouping:List<Expression<?>> list of zero or more grouping expressions Returns:SqmSelectStatement<T> the modified query Annotations @Override

public SqmSelectStatement<T> groupBy(List<Expression<?>> grouping)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.groupBy.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.groupBy, org.hibernate.query.criteria.JpaSelectCriteria.groupBy.

Doc from jakarta.persistence.criteria.CriteriaQuery.groupBy.

Parameters

grouping:List<Expression<?>>: list of zero or more grouping expressions

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

having back to summary

having	back to summary
public SqmSelectStatement<T> having(Expression<Boolean> booleanExpression) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.having. Implements org.hibernate.query.criteria.JpaCriteriaQuery.having, org.hibernate.query.criteria.JpaSelectCriteria.having. Doc from jakarta.persistence.criteria.CriteriaQuery.having. Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding `AbstractQuery` method. Parameters booleanExpression:Expression<Boolean> a simple or compound boolean expression Returns:SqmSelectStatement<T> the modified query Annotations @Override

public SqmSelectStatement<T> having(Expression<Boolean> booleanExpression)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.having.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.having, org.hibernate.query.criteria.JpaSelectCriteria.having.

Doc from jakarta.persistence.criteria.CriteriaQuery.having.

Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.

Parameters

booleanExpression:Expression<Boolean>: a simple or compound boolean expression

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

having back to summary

having	back to summary
public SqmSelectStatement<T> having(Predicate... predicates) Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.having. Implements org.hibernate.query.criteria.JpaCriteriaQuery.having, org.hibernate.query.criteria.JpaSelectCriteria.having. Doc from jakarta.persistence.criteria.CriteriaQuery.having. Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously added having restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding `AbstractQuery` method. Parameters predicates:Predicate[] zero or more restriction predicates Returns:SqmSelectStatement<T> the modified query Annotations @Override

public SqmSelectStatement<T> having(Predicate... predicates)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.having.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.having, org.hibernate.query.criteria.JpaSelectCriteria.having.

Doc from jakarta.persistence.criteria.CriteriaQuery.having.

Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously added having restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.

Parameters

predicates:Predicate[]: zero or more restriction predicates

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

multiselect back to summary

multiselect	back to summary
public SqmSelectStatement<T> multiselect(Selection<?>... selections) Implements org.hibernate.query.criteria.JpaCriteriaQuery.multiselect. Doc from jakarta.persistence.criteria.CriteriaQuery.multiselect. Specify the selection items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the type of the criteria query object created as well as the arguments to the multiselect method. An argument to the multiselect method must not be a tuple- or array-valued compound selection item. The semantics of this method are as follows: If the type of the criteria query is `CriteriaQuery<Tuple>` (i.e., a criteria query object created by either the `createTupleQuery` method or by passing a `Tuple` class argument to the `createQuery` method), a `Tuple` object corresponding to the arguments of the `multiselect` method, in the specified order, will be instantiated and returned for each row that results from the query execution. If the type of the criteria query is `CriteriaQuery<X>` for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the `createQuery` method), the arguments to the `multiselect` method will be passed to the X constructor and an instance of type X will be returned for each row. If the type of the criteria query is `CriteriaQuery<X[]>` for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the arguments of the `multiselect` method, in the specified order. If the type of the criteria query is `CriteriaQuery<Object>` or if the criteria query was created without specifying a type, and only a single argument is passed to the `multiselect` method, an instance of type `Object` will be returned for each row. If the type of the criteria query is `CriteriaQuery<Object>` or if the criteria query was created without specifying a type, and more than one argument is passed to the `multiselect` method, an instance of type `Object[]` will be instantiated and returned for each row. The elements of the array will correspond to the arguments to the `multiselect` method, in the specified order. Parameters selections:Selection<?>[] selection items corresponding to the results to be returned by the query Returns:SqmSelectStatement<T> the modified query Annotations @Override

public SqmSelectStatement<T> multiselect(Selection<?>... selections)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.multiselect.

Doc from jakarta.persistence.criteria.CriteriaQuery.multiselect.

Specify the selection items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the type of the criteria query object created as well as the arguments to the multiselect method.

An argument to the multiselect method must not be a tuple- or array-valued compound selection item.

The semantics of this method are as follows:

If the type of the criteria query is CriteriaQuery<Tuple> (i.e., a criteria query object created by either the createTupleQuery method or by passing a Tuple class argument to the createQuery method), a Tuple object corresponding to the arguments of the multiselect method, in the specified order, will be instantiated and returned for each row that results from the query execution.
If the type of the criteria query is CriteriaQuery<X> for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the createQuery method), the arguments to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row.
If the type of the criteria query is CriteriaQuery<X[]> for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the arguments of the multiselect method, in the specified order.
If the type of the criteria query is CriteriaQuery<Object> or if the criteria query was created without specifying a type, and only a single argument is passed to the multiselect method, an instance of type Object will be returned for each row.
If the type of the criteria query is CriteriaQuery<Object> or if the criteria query was created without specifying a type, and more than one argument is passed to the multiselect method, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the arguments to the multiselect method, in the specified order.

Parameters

selections:Selection<?>[]: selection items corresponding to the results to be returned by the query

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

multiselect back to summary

multiselect	back to summary
public SqmSelectStatement<T> multiselect(List<Selection<?>> selectionList) Implements org.hibernate.query.criteria.JpaCriteriaQuery.multiselect. Doc from jakarta.persistence.criteria.CriteriaQuery.multiselect. Specify the selection items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the type of the criteria query object created as well as the argument to the `multiselect` method. An element of the list passed to the `multiselect` method must not be a tuple- or array-valued compound selection item. The semantics of this method are as follows: If the type of the criteria query is `CriteriaQuery<Tuple>` (i.e., a criteria query object created by either the `createTupleQuery` method or by passing a `Tuple` class argument to the `createQuery` method), a `Tuple` object corresponding to the elements of the list passed to the `multiselect` method, in the specified order, will be instantiated and returned for each row that results from the query execution. If the type of the criteria query is `CriteriaQuery<X>` for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the `createQuery` method), the elements of the list passed to the `multiselect` method will be passed to the X constructor and an instance of type X will be returned for each row. If the type of the criteria query is `CriteriaQuery<X[]>` for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the elements of the list passed to the `multiselect` method, in the specified order. If the type of the criteria query is `CriteriaQuery<Object>` or if the criteria query was created without specifying a type, and the list passed to the `multiselect` method contains only a single element, an instance of type `Object` will be returned for each row. If the type of the criteria query is `CriteriaQuery<Object>` or if the criteria query was created without specifying a type, and the list passed to the `multiselect` method contains more than one element, an instance of type `Object[]` will be instantiated and returned for each row. The elements of the array will correspond to the elements of the list passed to the `multiselect` method, in the specified order. Parameters selectionList:List<Selection<?>> list of selection items corresponding to the results to be returned by the query Returns:SqmSelectStatement<T> the modified query Annotations @Override @SuppressWarnings:unchecked

public SqmSelectStatement<T> multiselect(List<Selection<?>> selectionList)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.multiselect.

Doc from jakarta.persistence.criteria.CriteriaQuery.multiselect.

Specify the selection items that are to be returned in the query result. Replaces the previously specified selection(s), if any.

The type of the result of the query execution depends on the specification of the type of the criteria query object created as well as the argument to the multiselect method. An element of the list passed to the multiselect method must not be a tuple- or array-valued compound selection item.

The semantics of this method are as follows:

If the type of the criteria query is CriteriaQuery<Tuple> (i.e., a criteria query object created by either the createTupleQuery method or by passing a Tuple class argument to the createQuery method), a Tuple object corresponding to the elements of the list passed to the multiselect method, in the specified order, will be instantiated and returned for each row that results from the query execution.
If the type of the criteria query is CriteriaQuery<X> for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the createQuery method), the elements of the list passed to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row.
If the type of the criteria query is CriteriaQuery<X[]> for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the elements of the list passed to the multiselect method, in the specified order.
If the type of the criteria query is CriteriaQuery<Object> or if the criteria query was created without specifying a type, and the list passed to the multiselect method contains only a single element, an instance of type Object will be returned for each row.
If the type of the criteria query is CriteriaQuery<Object> or if the criteria query was created without specifying a type, and the list passed to the multiselect method contains more than one element, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the elements of the list passed to the multiselect method, in the specified order.

Parameters

selectionList:List<Selection<?>>: list of selection items corresponding to the results to be returned by the query

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override
@SuppressWarnings:unchecked

offset	back to summary
public JpaCriteriaQuery<T> offset(JpaExpression<? extends Number> offset) Implements org.hibernate.query.criteria.JpaCriteriaQuery.offset. Annotations @Override

offset

back to summary

public JpaCriteriaQuery<T> offset(JpaExpression<? extends Number> offset)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.offset.

Annotations

@Override

offset	back to summary
public JpaCriteriaQuery<T> offset(Number offset) Implements org.hibernate.query.criteria.JpaCriteriaQuery.offset. Annotations @Override

offset

back to summary

public JpaCriteriaQuery<T> offset(Number offset)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.offset.

Annotations

@Override

orderBy	back to summary
public SqmSelectStatement<T> orderBy(Order... orders) Implements org.hibernate.query.criteria.JpaCriteriaQuery.orderBy. Doc from jakarta.persistence.criteria.CriteriaQuery.orderBy. Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The left-to-right sequence of the ordering expressions determines the precedence, whereby the leftmost has highest precedence. Parameters orders:Order[] zero or more ordering expressions Returns:SqmSelectStatement<T> the modified query Annotations @Override

orderBy

back to summary

public SqmSelectStatement<T> orderBy(Order... orders)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.orderBy.

Doc from jakarta.persistence.criteria.CriteriaQuery.orderBy.

Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The left-to-right sequence of the ordering expressions determines the precedence, whereby the leftmost has highest precedence.

Parameters

orders:Order[]: zero or more ordering expressions

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

orderBy	back to summary
public SqmSelectStatement<T> orderBy(List<Order> orders) Implements org.hibernate.query.criteria.JpaCriteriaQuery.orderBy. Doc from jakarta.persistence.criteria.CriteriaQuery.orderBy. Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The order of the ordering expressions in the list determines the precedence, whereby the first element in the list has highest precedence. Parameters orders:List<Order> list of zero or more ordering expressions Returns:SqmSelectStatement<T> the modified query Annotations @Override

orderBy

back to summary

public SqmSelectStatement<T> orderBy(List<Order> orders)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.orderBy.

Doc from jakarta.persistence.criteria.CriteriaQuery.orderBy.

Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The order of the ordering expressions in the list determines the precedence, whereby the first element in the list has highest precedence.

Parameters

orders:List<Order>: list of zero or more ordering expressions

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

producesUniqueResults	back to summary
public boolean producesUniqueResults()

producesUniqueResults	back to summary
private boolean producesUniqueResults(SqmQueryPart<?> queryPart)

resetSelections	back to summary
private void resetSelections(SqmQueryPart<?> queryPart)

resetSelections	back to summary
private void resetSelections(SqmQuerySpec<?> querySpec)

resolveParameters	back to summary
public SqmStatement.ParameterResolutions resolveParameters() Implements org.hibernate.query.sqm.tree.SqmStatement.resolveParameters. Annotations @Override

resolveParameters

back to summary

public SqmStatement.ParameterResolutions resolveParameters()

Implements org.hibernate.query.sqm.tree.SqmStatement.resolveParameters.

Annotations

@Override

select	back to summary
public SqmSelectStatement<T> select(Selection<? extends T> selection) Implements org.hibernate.query.criteria.JpaCriteriaQuery.select. Doc from jakarta.persistence.criteria.CriteriaQuery.select. Specify the item that is to be returned in the query result. Replaces the previously specified selection(s), if any. Note Applications using the string-based API may need to specify the type of the select item when it results from a get or join operation and the query result type is specified. For example: CriteriaQuery<String> q = cb.createQuery(String.class); Root<Order> order = q.from(Order.class); q.select(order.get("shippingAddress").<String>get("state")); CriteriaQuery<Product> q2 = cb.createQuery(Product.class); q2.select(q2.from(Order.class) .join("items") .<Item,Product>join("product")); Parameters selection:Selection<? extends T> selection specifying the item that is to be returned in the query result Returns:SqmSelectStatement<T> the modified query Annotations @Override @SuppressWarnings:unchecked

select

back to summary

public SqmSelectStatement<T> select(Selection<? extends T> selection)

Implements org.hibernate.query.criteria.JpaCriteriaQuery.select.

Doc from jakarta.persistence.criteria.CriteriaQuery.select.

Specify the item that is to be returned in the query result. Replaces the previously specified selection(s), if any.

Note

Applications using the string-based API may need to specify the type of the select item when it results from a get or join operation and the query result type is specified.

    For example:

    CriteriaQuery<String> q = cb.createQuery(String.class);
    Root<Order> order = q.from(Order.class);
    q.select(order.get("shippingAddress").<String>get("state"));

    CriteriaQuery<Product> q2 = cb.createQuery(Product.class);
    q2.select(q2.from(Order.class)
                .join("items")
                .<Item,Product>join("product"));

Parameters

selection:Selection<? extends T>: selection specifying the item that is to be returned in the query result

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override
@SuppressWarnings:unchecked

subquery	back to summary
public <U> SqmSubQuery<U> subquery(Class<U> type) Implements jakarta.persistence.criteria.CommonAbstractCriteria.subquery, org.hibernate.query.criteria.JpaCriteriaBase.subquery. Doc from jakarta.persistence.criteria.CommonAbstractCriteria.subquery. Create a subquery of the query. Parameters type:Class<U> the subquery result type Returns:SqmSubQuery<U> subquery Annotations @Override

subquery

back to summary

public SqmSubQuery subquery(Class type)

Implements jakarta.persistence.criteria.CommonAbstractCriteria.subquery, org.hibernate.query.criteria.JpaCriteriaBase.subquery.

Doc from jakarta.persistence.criteria.CommonAbstractCriteria.subquery.

Create a subquery of the query.

Parameters

type:Class: the subquery result type

Returns:SqmSubQuery

subquery

Annotations

@Override

usesDistinct	back to summary
public boolean usesDistinct()

usesDistinct	back to summary
private boolean usesDistinct(SqmQueryPart<?> queryPart)

validateComplianceFetchOffset	back to summary
private void validateComplianceFetchOffset()

where back to summary

public SqmSelectStatement<T> where(Expression<Boolean> restriction)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.where.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.where, org.hibernate.query.criteria.JpaSelectCriteria.where.

Doc from jakarta.persistence.criteria.CriteriaQuery.where.

Modify the query to restrict the query result according to the specified boolean expression. Replaces the previously added restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.

Parameters

restriction:Expression<Boolean>: a simple or compound boolean expression

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

where back to summary

public SqmSelectStatement<T> where(Predicate... restrictions)

Overrides org.hibernate.query.sqm.tree.select.AbstractSqmSelectQuery.where.

Implements org.hibernate.query.criteria.JpaCriteriaQuery.where, org.hibernate.query.criteria.JpaSelectCriteria.where.

Doc from jakarta.persistence.criteria.CriteriaQuery.where.

Modify the query to restrict the query result according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.

Parameters

restrictions:Predicate[]: zero or more restriction predicates

Returns:SqmSelectStatement<T>

the modified query

Annotations

@Override

public Class SqmSelectStatement<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail