All Superinterfaces:: Expression<T>, JpaCriteriaNode, JpaSelection<T>, JpaTupleElement<T>, Selection<T>, Serializable, TupleElement<T>

All Known Subinterfaces:: DiscriminatorSqmPath<T>, JpaCoalesce<T>, JpaCollectionJoin<O,T>, JpaCrossJoin<L,T>, JpaDerivedFrom<T>, JpaDerivedJoin<T>, JpaDerivedRoot<T>, JpaEntityJoin<L,R>, JpaFrom<O,T>, JpaFunction<T>, JpaFunctionFrom<O,T>, JpaFunctionJoin<E>, JpaFunctionRoot<E>, JpaJoin<L,R>, JpaJsonExistsExpression, JpaJsonQueryExpression, JpaJsonValueExpression<T>, JpaListJoin<O,T>, JpaMapJoin<O,K,V>, JpaPath<T>, JpaPluralExpression<C,E>, JpaPluralJoin<O,C,E>, JpaRoot<T>, JpaSearchedCase<T>, JpaSetJoin<O,T>, JpaSimpleCase<C,R>, JpaSubQuery<T>, JpaTreatedFrom<L,R,R1>, JpaTreatedJoin<L,R,R1>, JpaTreatedPath<T,S>, JpaXmlElementExpression, SqmAggregateFunction<T>, SqmAttributeJoin<O,T>, SqmBooleanExpression, SqmBooleanExpressionImplementor, SqmBooleanPath, SqmComparableExpression<C>, SqmComparableExpressionImplementor<C>, SqmCorrelatedJoin<L,R>, SqmCorrelatedSingularValuedJoin<L,R>, SqmCorrelation<L,R>, SqmExpression<T>, SqmExpressionWrapper<T>, SqmFrom<L,R>, SqmInPredicate<T>, SqmJoin<L,R>, SqmNegatablePredicate, SqmNumericExpression<N>, SqmNumericExpressionImplementor<N>, SqmNumericPath<N>, SqmOrderedSetAggregateFunction<T>, SqmParameter<T>, SqmPath<T>, SqmPathWrapper<W,T>, SqmPluralPath<C,E>, SqmPredicate, SqmSimplePath<T>, SqmSingularValuedJoin<L,R>, SqmTemporalExpression<T>, SqmTemporalExpressionImplementor<T>, SqmTemporalPath<T>, SqmTextExpression, SqmTextExpressionImplementor, SqmTextPath, SqmTreatedAttributeJoin<L,R,R1>, SqmTreatedFrom<L,R,R1>, SqmTreatedJoin<L,R,R1>, SqmTreatedPath<T,S>, SqmWindowFunction<T>

All Known Implementing Classes:: AbstractNegatableSqmPredicate, AbstractSqmAttributeJoin, AbstractSqmExpression, AbstractSqmFrom, AbstractSqmJoin, AbstractSqmJsonPathExpression, AbstractSqmParameter, AbstractSqmPath, AbstractSqmPluralJoin, AbstractSqmPredicate, AbstractSqmSimplePath, AbstractSqmSpecificPluralPartPath, AsWrapperSqmExpression, FormatFunction.FormatSqmFunction, InverseDistributionFunction.SelfRenderingInverseDistributionFunction, JpaCriteriaParameter, NonAggregatedCompositeSimplePath, SelfRenderingSqmAggregateFunction, SelfRenderingSqmFunction, SelfRenderingSqmOrderedSetAggregateFunction, SelfRenderingSqmWindowFunction, SqmAliasedNodeRef, SqmAny, SqmAnyDiscriminatorValue, SqmAnyValuedSimplePath, SqmBagJoin, SqmBasicValuedSimplePath, SqmBetweenPredicate, SqmBinaryArithmetic, SqmBooleanExpressionPredicate, SqmBooleanExpressionWrapper, SqmBooleanValuedSimplePath, SqmByUnit, SqmCaseSearched, SqmCaseSimple, SqmCoalesce, SqmCollation, SqmCollectionSize, SqmComparableExpressionWrapper, SqmComparableValuedSimplePath, SqmComparisonPredicate, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedCteJoin, SqmCorrelatedDerivedJoin, SqmCorrelatedDerivedRoot, SqmCorrelatedDerivedRootJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmCteJoin, SqmCteRoot, SqmDerivedJoin, SqmDerivedRoot, SqmElementAggregateFunction, SqmEmbeddedValuedSimplePath, SqmEmptinessPredicate, SqmEntityJoin, SqmEntityValuedSimplePath, SqmEnumLiteral, SqmEvery, SqmExistsPredicate, SqmFieldLiteral, SqmFkExpression, SqmFormat, SqmFunction, SqmFunctionJoin, SqmFunctionPath, SqmFunctionRoot, SqmGroupedPredicate, SqmHqlNumericLiteral, SqmIndexAggregateFunction, SqmIndexedCollectionAccessPath, SqmInListPredicate, SqmInSubQueryPredicate, SqmJpaCompoundSelection, SqmJpaCriteriaParameterWrapper, SqmJsonExistsExpression, SqmJsonQueryExpression, SqmJsonValueExpression, SqmJunctionPredicate, SqmLikePredicate, SqmListJoin, SqmLiteral, SqmLiteralEmbeddableType, SqmLiteralEntityType, SqmLiteralNull, SqmMapJoin, SqmMemberOfPredicate, SqmModifiedSubQueryExpression, SqmNamedExpression, SqmNamedParameter, SqmNegatedPredicate, SqmNullnessPredicate, SqmNumericExpressionWrapper, SqmNumericValuedSimplePath, SqmOver, SqmOverflow, SqmParameterizedEntityType, SqmPluralPartJoin, SqmPluralPartSelectionPath, SqmPluralValuedSimplePath, SqmPositionalParameter, SqmRoot, SqmSelfRenderingExpression, SqmSetJoin, SqmSingularJoin, SqmStar, SqmSubQuery, SqmSummarization, SqmTemporalExpressionWrapper, SqmTemporalValuedSimplePath, SqmTextExpressionWrapper, SqmTextValuedSimplePath, SqmToDuration, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEmbeddedValuedSimplePath, SqmTreatedEntityJoin, SqmTreatedEntityValuedSimplePath, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSimplePath, SqmTreatedSingularJoin, SqmTruthnessPredicate, SqmTuple, SqmUnaryOperation, SqmXmlElementExpression, ValueBindJpaCriteriaParameter

public interface JpaExpression<T> extends JpaSelection<T>, Expression<T>

API extension to the JPA Expression contract

Method Summary

Modifier and Type

Method

Description

<X> JpaExpression<X>

as(Class<X> type)

Narrow this expression to the given Java type.

JpaExpression<BigDecimal>

asBigDecimal()

Convert this expression to BigDecimal.

JpaExpression<BigInteger>

asBigInteger()

Convert this expression to BigInteger.

JpaExpression<Double>

asDouble()

Convert this expression to Double.

JpaExpression<Float>

asFloat()

Convert this expression to Float.

JpaExpression<Integer>

asInteger()

Convert this expression to Integer.

JpaExpression<Long>

asLong()

Convert this expression to Long.

JpaExpression<String>

asString()

Convert this expression to String.

<X> JpaExpression<X>

cast(Class<X> type)

Create a cast expression for this expression.

JpaExpression<T>

coalesce(Expression<? extends T> y)

Create a coalesce expression using this expression.

JpaExpression<T>

coalesce(T y)

Create a coalesce expression using this expression.

JpaNumericExpression<Long>

count()

Create a count expression for this expression.

JpaNumericExpression<Long>

countDistinct()

Create a distinct count expression for this expression.

JpaPredicate

equalTo(Expression<?> value)

Create a predicate testing equality with this expression.

JpaPredicate

equalTo(Object value)

Create a predicate testing equality with this expression.

JpaPredicate

in(Expression<?>... values)

Create an in predicate for this expression.

JpaPredicate

in(Expression<Collection<?>> values)

Create an in predicate for this expression.

JpaPredicate

in(Subquery<T> subquery)

Create an in predicate for this expression.

JpaPredicate

in(Object... values)

Create an in predicate for this expression.

JpaPredicate

in(Collection<?> values)

Create an in predicate for this expression.

JpaPredicate

isMember(Expression<? extends Collection<? super T>> collection)

Create a predicate testing whether this expression is a member of a collection.

JpaPredicate

isNotMember(Expression<? extends Collection<? super T>> collection)

Create a predicate testing whether this expression is not a member of a collection.

JpaPredicate

isNotNull()

Create a predicate testing whether this expression is not null.

JpaPredicate

isNull()

Create a predicate testing whether this expression is null.

JpaPredicate

notEqualTo(Expression<?> value)

Create a predicate testing inequality with this expression.

JpaPredicate

notEqualTo(Object value)

Create a predicate testing inequality with this expression.

JpaExpression<T>

nullif(Expression<? extends T> y)

Create a nullif expression using this expression.

JpaExpression<T>

nullif(T y)

Create a nullif expression using this expression.

<R> JpaSimpleCase<T,R>

selectCase()

Create a simple case expression based on this expression.

<R> JpaSimpleCase<T,R>

selectCase(Class<R> resultType)

Create a simple case expression based on this expression.

Methods inherited from interface JpaSelection
alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement
getJavaType, getJavaTypeDescriptor, getJavaTypeIfKnown, getJavaTypeName, isEnum

Methods inherited from interface Selection
isCompoundSelection

Methods inherited from interface TupleElement
getAlias

Method Details
- asLong
  
  @Nonnull JpaExpression<Long> asLong()
  
  Convert this expression to Long.
- asInteger
  
  @Nonnull JpaExpression<Integer> asInteger()
  
  Convert this expression to Integer.
- asFloat
  
  @Nonnull JpaExpression<Float> asFloat()
  
  Convert this expression to Float.
- asDouble
  
  @Nonnull JpaExpression<Double> asDouble()
  
  Convert this expression to Double.
- asBigDecimal
  
  @Nonnull JpaExpression<BigDecimal> asBigDecimal()
  
  Convert this expression to BigDecimal.
- asBigInteger
  
  @Nonnull JpaExpression<BigInteger> asBigInteger()
  
  Convert this expression to BigInteger.
- asString
  
  @Nonnull JpaExpression<String> asString()
  
  Convert this expression to String.
- as
  
  @Nonnull <X> JpaExpression<X> as(@Nonnull Class<X> type)
  
  Narrow this expression to the given Java type.
  
  Specified by:
  
  as in interface Expression<T>
- isNull
  
  @Nonnull JpaPredicate isNull()
  
  Create a predicate testing whether this expression is null.
  
  Specified by:
  
  isNull in interface Expression<T>
- isNotNull
  
  @Nonnull JpaPredicate isNotNull()
  
  Create a predicate testing whether this expression is not null.
  
  Specified by:
  
  isNotNull in interface Expression<T>
- in
  
  @Nonnull JpaPredicate in(@Nonnull Object... values)
  
  Create an in predicate for this expression.
  
  Specified by:
  
  in in interface Expression<T>
- in
  
  @Nonnull JpaPredicate in(@Nonnull Expression<?>... values)
  
  Create an in predicate for this expression.
  
  Specified by:
  
  in in interface Expression<T>
- in
  
  @Nonnull JpaPredicate in(@Nonnull Collection<?> values)
  
  Create an in predicate for this expression.
  
  Specified by:
  
  in in interface Expression<T>
- in
  
  @Nonnull JpaPredicate in(@Nonnull Expression<Collection<?>> values)
  
  Create an in predicate for this expression.
  
  Specified by:
  
  in in interface Expression<T>
- in
  
  @Nonnull JpaPredicate in(@Nonnull Subquery<T> subquery)
  
  Create an in predicate for this expression.
  
  Specified by:
  
  in in interface Expression<T>
- coalesce
  
  @Nonnull JpaExpression<T> coalesce(@Nonnull Expression<? extends T> y)
  
  Create a coalesce expression using this expression.
  
  Specified by:
  
  coalesce in interface Expression<T>
- coalesce
  
  @Nonnull JpaExpression<T> coalesce(@Nonnull T y)
  
  Create a coalesce expression using this expression.
  
  Specified by:
  
  coalesce in interface Expression<T>
- selectCase
  
  @Nonnull <R> JpaSimpleCase<T,R> selectCase()
  
  Create a simple case expression based on this expression.
- selectCase
  
  @Nonnull <R> JpaSimpleCase<T,R> selectCase(@Nonnull Class<R> resultType)
  
  Create a simple case expression based on this expression.
  
  Specified by:
  
  selectCase in interface Expression<T>
- count
  
  @Nonnull JpaNumericExpression<Long> count()
  
  Create a count expression for this expression.
  
  Specified by:
  
  count in interface Expression<T>
- countDistinct
  
  @Nonnull JpaNumericExpression<Long> countDistinct()
  
  Create a distinct count expression for this expression.
  
  Specified by:
  
  countDistinct in interface Expression<T>
- nullif
  
  @Nonnull JpaExpression<T> nullif(@Nonnull Expression<? extends T> y)
  
  Create a nullif expression using this expression.
  
  Specified by:
  
  nullif in interface Expression<T>
- nullif
  
  @Nonnull JpaExpression<T> nullif(@Nonnull T y)
  
  Create a nullif expression using this expression.
  
  Specified by:
  
  nullif in interface Expression<T>
- isMember
  
  @Nonnull JpaPredicate isMember(@Nonnull Expression<? extends Collection<? super T>> collection)
  
  Create a predicate testing whether this expression is a member of a collection.
  
  Specified by:
  
  isMember in interface Expression<T>
- isNotMember
  
  @Nonnull JpaPredicate isNotMember(@Nonnull Expression<? extends Collection<? super T>> collection)
  
  Create a predicate testing whether this expression is not a member of a collection.
  
  Specified by:
  
  isNotMember in interface Expression<T>
- equalTo
  
  @Nonnull JpaPredicate equalTo(@Nonnull Expression<?> value)
  
  Create a predicate testing equality with this expression.
  
  Specified by:
  
  equalTo in interface Expression<T>
- equalTo
  
  @Nonnull JpaPredicate equalTo(@Nonnull Object value)
  
  Create a predicate testing equality with this expression.
  
  Specified by:
  
  equalTo in interface Expression<T>
- cast
  
  @Nonnull <X> JpaExpression<X> cast(@Nonnull Class<X> type)
  
  Create a cast expression for this expression.
  
  Specified by:
  
  cast in interface Expression<T>
- notEqualTo
  
  @Nonnull JpaPredicate notEqualTo(@Nonnull Expression<?> value)
  
  Create a predicate testing inequality with this expression.
  
  Specified by:
  
  notEqualTo in interface Expression<T>
- notEqualTo
  
  @Nonnull JpaPredicate notEqualTo(@Nonnull Object value)
  
  Create a predicate testing inequality with this expression.
  
  Specified by:
  
  notEqualTo in interface Expression<T>

Interface JpaExpression<T>

Method Summary

Methods inherited from interface JpaSelection

Methods inherited from interface JpaTupleElement

Methods inherited from interface Selection

Methods inherited from interface TupleElement

Method Details

asLong

asInteger

asFloat

asDouble

asBigDecimal

asBigInteger

asString

as

isNull

isNotNull

in

in

in

in

in

coalesce

coalesce

selectCase

selectCase

count

countDistinct

nullif

nullif

isMember

isNotMember

equalTo

equalTo

cast

notEqualTo

notEqualTo