Package org.hibernate.query.criteria

Interface JpaSubQuery<T>

All Superinterfaces:
AbstractQuery<T>, CommonAbstractCriteria, Expression<T>, JpaCriteriaBase, JpaCriteriaNode, JpaCteContainer, JpaExpression<T>, JpaSelectCriteria<T>, JpaSelection<T>, JpaTupleElement<T>, Selection<T>, Serializable, Subquery<T>, TupleElement<T>
All Known Implementing Classes:
SqmSubQuery
public interface JpaSubQuery<T> extends Subquery<T>, JpaSelectCriteria<T>, JpaExpression<T>, JpaCteContainer
Author:
Steve Ebersole

  • Method Details

    • multiselect

      JpaSubQuery<T> multiselect(Selection<?>... selections)

    • multiselect

      JpaSubQuery<T> multiselect(List<Selection<?>> selectionList)

    • correlate

      <X> JpaCrossJoin<X> correlate(JpaCrossJoin<X> parentCrossJoin)

    • correlate

      <X> JpaEntityJoin<X> correlate(JpaEntityJoin<X> parentEntityJoin)

    • getOffset

      JpaExpression<Number> getOffset()

    • offset

      JpaSubQuery<T> offset(JpaExpression<? extends Number> offset)

    • offset

      JpaSubQuery<T> offset(Number offset)

    • getFetch

      JpaExpression<Number> getFetch()

    • fetch

      JpaSubQuery<T> fetch(JpaExpression<? extends Number> fetch)

    • fetch

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

    • fetch

      JpaSubQuery<T> fetch(Number fetch)

    • fetch

      JpaSubQuery<T> fetch(Number fetch, FetchClauseType fetchClauseType)

    • getFetchClauseType

      FetchClauseType getFetchClauseType()

    • getOrderList

      List<JpaOrder> getOrderList()

    • orderBy

      JpaSubQuery<T> orderBy(Order... o)

    • orderBy

      JpaSubQuery<T> orderBy(List<Order> o)

    • distinct

      JpaSubQuery<T> distinct(boolean distinct)
      Description copied from interface: Subquery
      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.
      Specified by:
      distinct in interface AbstractQuery<T>
      Specified by:
      distinct in interface JpaSelectCriteria<T>
      Specified by:
      distinct in interface Subquery<T>
      Parameters:
      distinct - boolean value specifying whether duplicate results must be eliminated from the subquery result or whether they must be retained
      Returns:
      the modified subquery.

    • getSelection

      JpaExpression<T> getSelection()
      Description copied from interface: Subquery
      Return the selection expression.
      Specified by:
      getSelection in interface AbstractQuery<T>
      Specified by:
      getSelection in interface JpaSelectCriteria<T>
      Specified by:
      getSelection in interface Subquery<T>
      Returns:
      the item to be returned in the subquery result

    • select

      JpaSubQuery<T> select(Expression<T> expression)
      Description copied from interface: Subquery
      Specify the item that is to be returned as the subquery result. Replaces the previously specified selection, if any.
      Specified by:
      select in interface Subquery<T>
      Parameters:
      expression - expression specifying the item that is to be returned as the subquery result
      Returns:
      the modified subquery

    • where

      JpaSubQuery<T> where(Expression<Boolean> restriction)
      Description copied from interface: Subquery
      Modify the subquery to restrict the 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.
      Specified by:
      where in interface AbstractQuery<T>
      Specified by:
      where in interface JpaSelectCriteria<T>
      Specified by:
      where in interface Subquery<T>
      Parameters:
      restriction - a simple or compound boolean expression
      Returns:
      the modified subquery

    • where

      JpaSubQuery<T> where(Predicate... restrictions)
      Description copied from interface: Subquery
      Modify the subquery to restrict the 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.
      Specified by:
      where in interface AbstractQuery<T>
      Specified by:
      where in interface JpaSelectCriteria<T>
      Specified by:
      where in interface Subquery<T>
      Parameters:
      restrictions - zero or more restriction predicates
      Returns:
      the modified subquery

    • groupBy

      JpaSubQuery<T> groupBy(Expression<?>... grouping)
      Description copied from interface: Subquery
      Specify the expressions that are used to form groups over the subquery 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.
      Specified by:
      groupBy in interface AbstractQuery<T>
      Specified by:
      groupBy in interface JpaSelectCriteria<T>
      Specified by:
      groupBy in interface Subquery<T>
      Parameters:
      grouping - zero or more grouping expressions
      Returns:
      the modified subquery

    • groupBy

      JpaSubQuery<T> groupBy(List<Expression<?>> grouping)
      Description copied from interface: Subquery
      Specify the expressions that are used to form groups over the subquery 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.
      Specified by:
      groupBy in interface AbstractQuery<T>
      Specified by:
      groupBy in interface JpaSelectCriteria<T>
      Specified by:
      groupBy in interface Subquery<T>
      Parameters:
      grouping - list of zero or more grouping expressions
      Returns:
      the modified subquery

    • having

      JpaSubQuery<T> having(Expression<Boolean> restriction)
      Description copied from interface: Subquery
      Specify a restriction over the groups of the subquery. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.
      Specified by:
      having in interface AbstractQuery<T>
      Specified by:
      having in interface JpaSelectCriteria<T>
      Specified by:
      having in interface Subquery<T>
      Parameters:
      restriction - a simple or compound boolean expression
      Returns:
      the modified subquery

    • having

      JpaSubQuery<T> having(Predicate... restrictions)
      Description copied from interface: Subquery
      Specify restrictions over the groups of the subquery 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.
      Specified by:
      having in interface AbstractQuery<T>
      Specified by:
      having in interface JpaSelectCriteria<T>
      Specified by:
      having in interface Subquery<T>
      Parameters:
      restrictions - zero or more restriction predicates
      Returns:
      the modified subquery

    • correlate

      <Y> JpaRoot<Y> correlate(Root<Y> parentRoot)
      Description copied from interface: Subquery
      Create a subquery root correlated to a root of the enclosing query.
      Specified by:
      correlate in interface Subquery<T>
      Parameters:
      parentRoot - a root of the containing query
      Returns:
      subquery root

    • correlate

      <X, Y> JpaJoin<X,Y> correlate(Join<X,Y> parentJoin)
      Description copied from interface: Subquery
      Create a subquery join object correlated to a join object of the enclosing query.
      Specified by:
      correlate in interface Subquery<T>
      Parameters:
      parentJoin - join object of the containing query
      Returns:
      subquery join

    • correlate

      <X, Y> JpaCollectionJoin<X,Y> correlate(CollectionJoin<X,Y> parentCollection)
      Description copied from interface: Subquery
      Create a subquery collection join object correlated to a collection join object of the enclosing query.
      Specified by:
      correlate in interface Subquery<T>
      Parameters:
      parentCollection - join object of the containing query
      Returns:
      subquery join

    • correlate

      <X, Y> JpaSetJoin<X,Y> correlate(SetJoin<X,Y> parentSet)
      Description copied from interface: Subquery
      Create a subquery set join object correlated to a set join object of the enclosing query.
      Specified by:
      correlate in interface Subquery<T>
      Parameters:
      parentSet - join object of the containing query
      Returns:
      subquery join

    • correlate

      <X, Y> JpaListJoin<X,Y> correlate(ListJoin<X,Y> parentList)
      Description copied from interface: Subquery
      Create a subquery list join object correlated to a list join object of the enclosing query.
      Specified by:
      correlate in interface Subquery<T>
      Parameters:
      parentList - join object of the containing query
      Returns:
      subquery join

    • correlate

      <X, K, V> JpaMapJoin<X,K,V> correlate(MapJoin<X,K,V> parentMap)
      Description copied from interface: Subquery
      Create a subquery map join object correlated to a map join object of the enclosing query.
      Specified by:
      correlate in interface Subquery<T>
      Parameters:
      parentMap - join object of the containing query
      Returns:
      subquery join