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:

Expression<T>, ParameterExpression<T>, Selection<T>, Parameter<T>, TupleElement<T>, Serializable, JpaCriteriaNode, JpaExpression<T>, JpaParameterExpression<T>, JpaSelection<T>, JpaTupleElement<T>, SqmExpression<T>, SqmParameter<T>, SqmSelectableNode<T>, SqmCacheable, 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(Class)).

JpaCriteriaParameter is the "domain query parameter" (QueryParameter while SqmJpaCriteriaParameterWrapper is the SqmParameter

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Fields inherited from interface SqmParameter

COMPARATOR

Constructor Summary

Constructors

Constructor	Description
SqmJpaCriteriaParameterWrapper(@Nullable BindableType<T> type, JpaCriteriaParameter<T> jpaCriteriaParameter, int criteriaParameterId, int unnamedParameterId, 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 hql, SqmRenderContext context)
int	cacheHashCode()
SqmParameter<T>	copy()	Make a copy
SqmJpaCriteriaParameterWrapper<T>	copy(SqmCopyContext context)
final boolean	equals(@Nullable Object o)
@Nullable BindableType<T>	getAnticipatedType()	Based on the context it is declared, what is the anticipated type for bind values?
int	getCriteriaParameterId()	The 0-based encounter of a JpaCriteriaParameter instance in a SqmQuerySource.CRITERIA query.
JpaCriteriaParameter<T>	getJpaCriteriaParameter()
@Nullable String	getName()	If this represents a named parameter, return that parameter name; otherwise return null.
@Nullable Class<T>	getParameterType()
@Nullable Integer	getPosition()	If this represents a positional parameter, return that parameter position; otherwise return null.
int	getUnnamedParameterId()	The 0-based encounter of an unnamed JpaCriteriaParameter instance in a SqmQuerySource.CRITERIA query.
int	hashCode()
boolean	isCompatible(Object object)
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 AbstractSqmExpression

applyInferableType, as, cast, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo

Methods inherited from class AbstractJpaSelection

alias, getSelectionItems, isCompoundSelection

Methods inherited from class AbstractJpaTupleElement

copyTo, getAlias, getNodeType, setAlias, setExpressibleType

Methods inherited from class Object

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

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface SqmExpression

applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, castAs, equalTo, equalTo, getNodeType, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

SqmJpaCriteriaParameterWrapper

public SqmJpaCriteriaParameterWrapper(@Nullable BindableType<T> type,
 JpaCriteriaParameter<T> jpaCriteriaParameter,
 int criteriaParameterId,
 int unnamedParameterId,
 NodeBuilder criteriaBuilder)

Method Details

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 @Nullable 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 Parameter<T>

Specified by:

getName in interface SqmParameter<T>

Returns:

The parameter name, or null if not a named parameter

getPosition

public @Nullable 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 Parameter<T>

Specified by:

getPosition in interface SqmParameter<T>

Returns:

The parameter position

getJpaCriteriaParameter

public JpaCriteriaParameter<T> getJpaCriteriaParameter()

getCriteriaParameterId

public int getCriteriaParameterId()

The 0-based encounter of a JpaCriteriaParameter instance in a SqmQuerySource.CRITERIA query.

See Also:

• ParameterCollector

getUnnamedParameterId

public int getUnnamedParameterId()

The 0-based encounter of an unnamed JpaCriteriaParameter instance in a SqmQuerySource.CRITERIA query. If the getJpaCriteriaParameter() has a name, returns -1.

See Also:

• ParameterCollector

getParameterType

public @Nullable Class<T> getParameterType()

Specified by:

getParameterType in interface 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 @Nullable 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(JpaCriteriaParameter). This wrapper is intended just for representing unique SqmParameter references for each JpaCriteriaParameter occurrence in the SQM tree as part of the QueryParameter to SqmParameter to 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 hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

equals

public final boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable