Class AbstractSqmParameter<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.AbstractSqmParameter<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

Direct Known Subclasses:

SqmNamedParameter, SqmPositionalParameter

public abstract class AbstractSqmParameter<T>
extends AbstractSqmExpression<T>
implements SqmParameter<T>

Common support for SqmParameter impls

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Fields inherited from interface SqmParameter

COMPARATOR

Constructor Summary

Constructors

Constructor	Description
AbstractSqmParameter(boolean canBeMultiValued, @Nullable SqmBindableType<T> inherentType, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
boolean	allowMultiValuedBinding()	Can a collection/array of values be bound to this parameter?
void	applyInferableType(@Nullable SqmBindableType<?> type)	Used to apply type information based on the expression's usage within the query.
void	disallowMultiValuedBinding()
@Nullable BindableType<T>	getAnticipatedType()	Based on the context it is declared, what is the anticipated type for bind values?
@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.
@Nullable Integer	getTupleLength()

Methods inherited from class AbstractSqmExpression

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, equals, finalize, getClass, hashCode, 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 SqmCacheable

cacheHashCode, isCompatible

Methods inherited from interface SqmExpression

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

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmParameter

copy, copy

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

accept, appendHqlString, toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

AbstractSqmParameter

public AbstractSqmParameter(boolean canBeMultiValued,
 @Nullable SqmBindableType<T> inherentType,
 NodeBuilder nodeBuilder)

Method Details

applyInferableType

public void applyInferableType(@Nullable SqmBindableType<?> type)

Description copied from interface: SqmExpression

Used to apply type information based on the expression's usage within the query.

Specified by:

applyInferableType in interface SqmExpression<T>

Overrides:

applyInferableType in class AbstractSqmExpression<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

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.

disallowMultiValuedBinding

public void disallowMultiValuedBinding()

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.

getParameterType

public @Nullable Class<T> getParameterType()

Specified by:

getParameterType in interface Parameter<T>

getTupleLength

public @Nullable Integer getTupleLength()

Specified by:

getTupleLength in interface SqmSelectableNode<T>