Package jakarta.persistence.criteria

Interface Selection<X>

Type Parameters:
X - the type of the selection item
All Superinterfaces:
TupleElement<X>
All Known Subinterfaces:
CollectionJoin<Z,E>, CompoundSelection<X>, CriteriaBuilder.Case<R>, CriteriaBuilder.Coalesce<T>, CriteriaBuilder.In<T>, CriteriaBuilder.SimpleCase<C,R>, DiscriminatorSqmPath<T>, Expression<T>, From<Z,X>, Join<Z,X>, JpaCoalesce<T>, JpaCollectionJoin<O,T>, JpaCompoundSelection<T>, JpaCrossJoin<T>, JpaDerivedFrom<T>, JpaDerivedJoin<T>, JpaDerivedRoot<T>, JpaEntityJoin<T>, JpaExpression<T>, JpaFrom<O,T>, JpaFunction<T>, JpaInPredicate<T>, JpaJoin<O,T>, JpaJoinedFrom<O,T>, JpaListJoin<O,T>, JpaMapJoin<O,K,V>, JpaParameterExpression<T>, JpaPath<T>, JpaPluralJoin<O,C,E>, JpaPredicate, JpaRoot<T>, JpaSearchedCase<T>, JpaSelection<T>, JpaSetJoin<O,T>, JpaSimpleCase<C,R>, JpaSubQuery<T>, ListJoin<Z,E>, MapJoin<Z,K,V>, ParameterExpression<T>, Path<X>, PluralJoin<Z,C,E>, Predicate, Root<X>, SetJoin<Z,E>, SqmAggregateFunction<T>, SqmAttributeJoin<O,T>, SqmCorrelation<O,T>, SqmExpression<T>, SqmFrom<O,T>, SqmInPredicate<T>, SqmJoin<O,T>, SqmNegatablePredicate, SqmOrderedSetAggregateFunction<T>, SqmParameter<T>, SqmPath<T>, SqmPathWrapper<W,T>, SqmPredicate, SqmQualifiedJoin<O,T>, SqmSelectableNode<T>, SqmSimplePath<T>, SqmTreatedPath<T,S>, SqmWindowFunction<T>, Subquery<T>
All Known Implementing Classes:
AbstractJpaSelection, AbstractNegatableSqmPredicate, AbstractSqmAttributeJoin, AbstractSqmExpression, AbstractSqmFrom, AbstractSqmJoin, AbstractSqmParameter, AbstractSqmPath, AbstractSqmPluralJoin, AbstractSqmPredicate, AbstractSqmQualifiedJoin, AbstractSqmSimplePath, AbstractSqmSpecificPluralPartPath, AnyDiscriminatorSqmPath, AsWrapperSqmExpression, EmbeddedDiscriminatorSqmPath, EntityDiscriminatorSqmPath, FormatFunction.FormatSqmFunction, FullyQualifiedReflectivePathTerminal, InverseDistributionFunction.SelfRenderingInverseDistributionFunction, JpaCriteriaParameter, NonAggregatedCompositeSimplePath, SelfRenderingSqmAggregateFunction, SelfRenderingSqmFunction, SelfRenderingSqmOrderedSetAggregateFunction, SelfRenderingSqmWindowFunction, SqmAliasedNodeRef, SqmAny, SqmAnyDiscriminatorValue, SqmAnyValuedSimplePath, SqmBagJoin, SqmBasicValuedSimplePath, SqmBetweenPredicate, SqmBinaryArithmetic, SqmBooleanExpressionPredicate, SqmByUnit, SqmCaseSearched, SqmCaseSimple, SqmCoalesce, SqmCollation, SqmCollectionSize, SqmComparisonPredicate, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmCteJoin, SqmCteRoot, SqmDerivedJoin, SqmDerivedRoot, SqmDynamicInstantiation, SqmElementAggregateFunction, SqmEmbeddedValuedSimplePath, SqmEmptinessPredicate, SqmEntityJoin, SqmEntityValuedSimplePath, SqmEnumLiteral, SqmEvery, SqmExistsPredicate, SqmFieldLiteral, SqmFkExpression, SqmFormat, SqmFunction, SqmFunctionPath, SqmGroupedPredicate, SqmHqlNumericLiteral, SqmIndexAggregateFunction, SqmIndexedCollectionAccessPath, SqmInListPredicate, SqmInSubQueryPredicate, SqmJpaCompoundSelection, SqmJpaCriteriaParameterWrapper, SqmJunctionPredicate, SqmLikePredicate, SqmListJoin, SqmLiteral, SqmLiteralEmbeddableType, SqmLiteralEntityType, SqmLiteralNull, SqmMapEntryReference, SqmMapJoin, SqmMemberOfPredicate, SqmModifiedSubQueryExpression, SqmNamedParameter, SqmNegatedPredicate, SqmNullnessPredicate, SqmOver, SqmOverflow, SqmParameterizedEntityType, SqmPluralPartJoin, SqmPluralValuedSimplePath, SqmPositionalParameter, SqmRoot, SqmSelectClause, SqmSelfRenderingExpression, SqmSetJoin, SqmSingularJoin, SqmStar, SqmSubQuery, SqmSummarization, SqmToDuration, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEmbeddedValuedSimplePath, SqmTreatedEntityJoin, SqmTreatedEntityValuedSimplePath, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSingularJoin, SqmTruthnessPredicate, SqmTuple, SqmUnaryOperation, ValueBindJpaCriteriaParameter
public interface Selection<X> extends TupleElement<X>
The Selection interface defines an item that is to be returned in a query result.
Since:
2.0

  • Method Details

    • alias

      Selection<X> alias(String name)
      Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.
      Parameters:
      name - alias
      Returns:
      selection item

    • isCompoundSelection

      boolean isCompoundSelection()
      Whether the selection item is a compound selection.
      Returns:
      boolean indicating whether the selection is a compound selection

    • getCompoundSelectionItems

      List<Selection<?>> getCompoundSelectionItems()
      Return the selection items composing a compound selection. Modifications to the list do not affect the query.
      Returns:
      list of selection items
      Throws:
      IllegalStateException - if selection is not a compound selection