Type Parameters:

T - The Java type of the expression

All Superinterfaces:

Expression<T>, JpaCriteriaNode, JpaExpression<T>, JpaSelection<T>, JpaTupleElement<T>, Selection<T>, Serializable, SqmExpressibleAccessor<T>, SqmNode, SqmSelectableNode<T>, SqmTypedNode<T>, SqmVisitableNode, TupleElement<T>

All Known Subinterfaces:

DiscriminatorSqmPath<T>, SqmAggregateFunction<T>, SqmAttributeJoin<O,T>, SqmCorrelation<O,T>, SqmFrom<O,T>, SqmInPredicate<T>, SqmJoin<O,T>, SqmNegatablePredicate, SqmOrderedSetAggregateFunction<T>, SqmParameter<T>, SqmPath<T>, SqmPathWrapper<W,T>, SqmPredicate, SqmQualifiedJoin<O,T>, SqmSimplePath<T>, SqmTreatedPath<T,S>, SqmWindowFunction<T>

All Known Implementing Classes:

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, 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, SqmFunctionPath, SqmGroupedPredicate, SqmHqlNumericLiteral, SqmIndexAggregateFunction, SqmIndexedCollectionAccessPath, SqmInListPredicate, SqmInSubQueryPredicate, SqmJpaCompoundSelection, SqmJpaCriteriaParameterWrapper, SqmJunctionPredicate, SqmLikePredicate, SqmListJoin, SqmLiteral, SqmLiteralEmbeddableType, SqmLiteralEntityType, SqmLiteralNull, SqmMapJoin, SqmMemberOfPredicate, SqmModifiedSubQueryExpression, SqmNamedParameter, SqmNegatedPredicate, SqmNullnessPredicate, SqmOver, SqmOverflow, SqmParameterizedEntityType, SqmPluralPartJoin, SqmPluralValuedSimplePath, SqmPositionalParameter, SqmRoot, SqmSelfRenderingExpression, SqmSetJoin, SqmSingularJoin, SqmStar, SqmSubQuery, SqmSummarization, SqmToDuration, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEmbeddedValuedSimplePath, SqmTreatedEntityJoin, SqmTreatedEntityValuedSimplePath, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSingularJoin, SqmTruthnessPredicate, SqmTuple, SqmUnaryOperation, ValueBindJpaCriteriaParameter
```
public interface SqmExpression<T>
extends SqmSelectableNode<T>, JpaExpression<T>
```
The base contract for any kind of expression node in the SQM tree. An expression might be a reference to an attribute, a literal, a function, etc.

Field Summary
- Fields inherited from interface org.hibernate.query.sqm.tree.SqmNode
  log

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`applyInferableType(@Nullable SqmExpressible<?> type)`	Used to apply type information based on the expression's usage within the query.
`<X> SqmExpression<X>`	`as(Class<X> type)`
`SqmExpression<BigDecimal>`	`asBigDecimal()`
`SqmExpression<BigInteger>`	`asBigInteger()`
`SqmExpression<Double>`	`asDouble()`
`SqmExpression<Float>`	`asFloat()`
`SqmExpression<Integer>`	`asInteger()`
`SqmExpression<Long>`	`asLong()`
`SqmExpression<String>`	`asString()`
`default <X> SqmExpression<X>`	`cast(Class<X> type)`
`default <X> SqmExpression<X>`	`castAs(DomainType<X> type)`
`SqmExpression<T>`	`copy(SqmCopyContext context)`
`SqmPredicate`	`equalTo(Expression<T> that)`
`SqmPredicate`	`equalTo(T that)`
`@Nullable SqmExpressible<T>`	`getNodeType()`	The expression's type.
`SqmPredicate`	`in(Expression<?>... values)`
`SqmPredicate`	`in(Expression<Collection<?>> values)`
`SqmPredicate`	`in(Object... values)`
`SqmPredicate`	`in(Collection<?> values)`
`SqmPredicate`	`isNotNull()`
`SqmPredicate`	`isNull()`
`default void`	`visitSubSelectableNodes(Consumer<SqmSelectableNode<?>> jpaSelectionConsumer)`	Visit each of this selectable's direct sub-selectables - used to support JPA's `Selection` model (which is really a "selectable", just poorly named and poorly defined

Methods inherited from interface org.hibernate.query.criteria.JpaSelection
alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement
getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum

Methods inherited from interface jakarta.persistence.criteria.Selection
isCompoundSelection

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode
asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectableNode
getTupleLength

Methods inherited from interface org.hibernate.query.sqm.tree.SqmTypedNode
getExpressible, getNodeJavaType

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode
accept, appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement
getAlias

- Method Detail
  - getNodeType
```
@Nullable SqmExpressible<T> getNodeType()
```
    The expression's type.
    Can change as a result of calls to applyInferableType(org.hibernate.query.sqm.SqmExpressible<?>)
    
    Specified by:
    
    getNodeType in interface SqmTypedNode<T>
  - applyInferableType
```
@Internal
void applyInferableType(@Nullable SqmExpressible<?> type)
```
    Used to apply type information based on the expression's usage within the query.
    
    API Note:
    
    The SqmExpressible type parameter is dropped here because the inference could technically cause a change in Java type (i.e. an implicit cast)
  - visitSubSelectableNodes
```
default void visitSubSelectableNodes(Consumer<SqmSelectableNode<?>> jpaSelectionConsumer)
```
    Description copied from interface: SqmSelectableNode
    
    Visit each of this selectable's direct sub-selectables - used to support JPA's Selection model (which is really a "selectable", just poorly named and poorly defined
    
    Specified by:
    
    visitSubSelectableNodes in interface SqmSelectableNode<T>
    
    See Also:
    
    JpaSelection.getSelectionItems(), Selection.getCompoundSelectionItems()
  - asLong
```
SqmExpression<Long> asLong()
```
    Specified by:
    
    asLong in interface JpaExpression<T>
  - asInteger
```
SqmExpression<Integer> asInteger()
```
    Specified by:
    
    asInteger in interface JpaExpression<T>
  - asFloat
```
SqmExpression<Float> asFloat()
```
    Specified by:
    
    asFloat in interface JpaExpression<T>
  - asDouble
```
SqmExpression<Double> asDouble()
```
    Specified by:
    
    asDouble in interface JpaExpression<T>
  - asBigDecimal
```
SqmExpression<BigDecimal> asBigDecimal()
```
    Specified by:
    
    asBigDecimal in interface JpaExpression<T>
  - asBigInteger
```
SqmExpression<BigInteger> asBigInteger()
```
    Specified by:
    
    asBigInteger in interface JpaExpression<T>
  - asString
```
SqmExpression<String> asString()
```
    Specified by:
    
    asString in interface JpaExpression<T>
  - as
```
<X> SqmExpression<X> as(Class<X> type)
```
    Specified by:
    
    as in interface Expression<T>
    
    Specified by:
    
    as in interface JpaExpression<T>
  - isNull
```
SqmPredicate isNull()
```
    Specified by:
    
    isNull in interface Expression<T>
    
    Specified by:
    
    isNull in interface JpaExpression<T>
  - isNotNull
```
SqmPredicate isNotNull()
```
    Specified by:
    
    isNotNull in interface Expression<T>
    
    Specified by:
    
    isNotNull in interface JpaExpression<T>
  - equalTo
```
SqmPredicate equalTo(Expression<T> that)
```
    Specified by:
    
    equalTo in interface JpaExpression<T>
  - equalTo
```
SqmPredicate equalTo(T that)
```
    Specified by:
    
    equalTo in interface JpaExpression<T>
  - in
```
SqmPredicate in(Object... values)
```
    Specified by:
    
    in in interface Expression<T>
    
    Specified by:
    
    in in interface JpaExpression<T>
  - in
```
SqmPredicate in(Expression<?>... values)
```
    Specified by:
    
    in in interface Expression<T>
    
    Specified by:
    
    in in interface JpaExpression<T>
  - in
```
SqmPredicate in(Collection<?> values)
```
    Specified by:
    
    in in interface Expression<T>
    
    Specified by:
    
    in in interface JpaExpression<T>
  - in
```
SqmPredicate in(Expression<Collection<?>> values)
```
    Specified by:
    
    in in interface Expression<T>
    
    Specified by:
    
    in in interface JpaExpression<T>
  - copy
```
SqmExpression<T> copy(SqmCopyContext context)
```
    Specified by:
    
    copy in interface SqmNode
    
    Specified by:
    
    copy in interface SqmSelectableNode<T>
    
    Specified by:
    
    copy in interface SqmTypedNode<T>
  - castAs
```
default <X> SqmExpression<X> castAs(DomainType<X> type)
```
  - cast
```
default <X> SqmExpression<X> cast(Class<X> type)
```
    Specified by:
    
    cast in interface JpaExpression<T>

Interface SqmExpression<T>

Field Summary

Fields inherited from interface org.hibernate.query.sqm.tree.SqmNode

Method Summary

Methods inherited from interface org.hibernate.query.criteria.JpaSelection

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement

Methods inherited from interface jakarta.persistence.criteria.Selection

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectableNode

Methods inherited from interface org.hibernate.query.sqm.tree.SqmTypedNode

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode

Methods inherited from interface jakarta.persistence.TupleElement

Method Detail

getNodeType

applyInferableType

visitSubSelectableNodes

asLong

asInteger

asFloat

asDouble

asBigDecimal

asBigInteger

asString

as

isNull

isNotNull

equalTo

equalTo

in

in

in

in

copy

castAs

cast