Package org.hibernate.query.sqm.tree.expression

Class SqmJpaCriteriaParameterWrapper<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement<T>

org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection<T>

org.hibernate.query.sqm.tree.expression.AbstractSqmExpression<T>

org.hibernate.query.sqm.tree.expression.SqmJpaCriteriaParameterWrapper<T>

All Implemented Interfaces:

jakarta.persistence.criteria.Expression<T>, jakarta.persistence.criteria.ParameterExpression<T>, jakarta.persistence.criteria.Selection<T>, jakarta.persistence.Parameter<T>, jakarta.persistence.TupleElement<T>, Serializable, JpaCriteriaNode, JpaExpression<T>, JpaParameterExpression<T>, JpaSelection<T>, JpaTupleElement<T>, SqmExpression<T>, SqmParameter<T>, SqmSelectableNode<T>, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

public class SqmJpaCriteriaParameterWrapper<T>
extends AbstractSqmExpression<T>
implements SqmParameter<T>

Acts as the per-use wrapper for a JpaCriteriaParameter (CriteriaBuilder.parameter(java.lang.Class<T>)). JpaCriteriaParameter is the "domain query parameter" (QueryParameter while SqmJpaCriteriaParameterWrapper is the SqmParameter

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmJpaCriteriaParameterWrapper(BindableType<T> type, JpaCriteriaParameter<T> jpaCriteriaParameter, NodeBuilder criteriaBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Unsupported.
boolean	allowMultiValuedBinding()	Can a collection/array of values be bound to this parameter?
void	appendHqlString(StringBuilder sb)
SqmParameter<T>	copy()	Make a copy
SqmJpaCriteriaParameterWrapper<T>	copy(SqmCopyContext context)
BindableType<T>	getAnticipatedType()	Based on the context it is declared, what is the anticipated type for bind values?
JpaCriteriaParameter<T>	getJpaCriteriaParameter()
String	getName()	If this represents a named parameter, return that parameter name; otherwise return null.
Class<T>	getParameterType()
Integer	getPosition()	If this represents a positional parameter, return that parameter position; otherwise return null.
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 class org.hibernate.query.sqm.tree.expression.AbstractSqmExpression

alias, applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection

getSelectionItems, isCompoundSelection

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement

copyTo, getAlias, getNodeType, setAlias, setExpressibleType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

alias, getCompoundSelectionItems, getSelectionItems

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

getJavaType, getJavaTypeDescriptor

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

Methods inherited from interface org.hibernate.query.sqm.tree.expression.SqmExpression

applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, castAs, in, in, in, in, isNotNull, isNull

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

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.expression.SqmParameter

getNodeType

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

getExpressible, getNodeJavaType

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

toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Detail

SqmJpaCriteriaParameterWrapper

public SqmJpaCriteriaParameterWrapper(BindableType<T> type,
                                      JpaCriteriaParameter<T> jpaCriteriaParameter,
                                      NodeBuilder criteriaBuilder)

Method Detail

copy

public SqmJpaCriteriaParameterWrapper<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmParameter<T>

Specified by:

copy in interface SqmSelectableNode<T>

Specified by:

copy in interface SqmTypedNode<T>

getName

public String getName()

Description copied from interface: SqmParameter

If this represents a named parameter, return that parameter name; otherwise return null.

Specified by:

getName in interface jakarta.persistence.Parameter<T>

Specified by:

getName in interface SqmParameter<T>

Returns:

The parameter name, or null if not a named parameter

getPosition

public Integer getPosition()

Description copied from interface: SqmParameter

If this represents a positional parameter, return that parameter position; otherwise return null.

Specified by:

getPosition in interface jakarta.persistence.Parameter<T>

Specified by:

getPosition in interface SqmParameter<T>

Returns:

The parameter position

getJpaCriteriaParameter

public JpaCriteriaParameter<T> getJpaCriteriaParameter()

getParameterType

public Class<T> getParameterType()

Specified by:

getParameterType in interface jakarta.persistence.Parameter<T>

allowMultiValuedBinding

public boolean allowMultiValuedBinding()

Description copied from interface: SqmParameter

Can a collection/array of values be bound to this parameter?

This is allowed in very limited contexts within the query:

1. as the value of an IN predicate if the only value is a single param
2. (in non-strict JPA mode) as the final vararg to a function

Specified by:

allowMultiValuedBinding in interface SqmParameter<T>

Returns:

true if binding collection/array of values is allowed for this parameter; false otherwise.

getAnticipatedType

public BindableType<T> getAnticipatedType()

Description copied from interface: SqmParameter

Based on the context it is declared, what is the anticipated type for bind values?

NOTE: If SqmParameter.allowMultiValuedBinding() is true, this will indicate the Type of the individual values.

Specified by:

getAnticipatedType in interface SqmParameter<T>

Returns:

The anticipated Type.

copy

public SqmParameter<T> copy()

Description copied from interface: SqmParameter

Make a copy

Specified by:

copy in interface SqmParameter<T>

accept

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

Unsupported. Visitation for a criteria parameter should be handled as part of SemanticQueryWalker.visitJpaCriteriaParameter(org.hibernate.query.sqm.tree.expression.JpaCriteriaParameter<?>). This wrapper is intended just for representing unique SqmParameter references for each JpaCriteriaParameter occurrence in the SQM true as part of the QueryParameter -> SqmParameter -> JdbcParameter transformation. Each occurrence requires a unique SqmParameter to make sure we ultimately get the complete set of JdbcParameter references

Specified by:

accept in interface SqmVisitableNode

visitSubSelectableNodes

public 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 SqmExpression<T>

Specified by:

visitSubSelectableNodes in interface SqmSelectableNode<T>

See Also:

JpaSelection.getSelectionItems(), Selection.getCompoundSelectionItems()

appendHqlString

public void appendHqlString(StringBuilder sb)

Specified by:

appendHqlString in interface SqmVisitableNode