Class JpaCriteriaParameter<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.JpaCriteriaParameter<T>

All Implemented Interfaces:

Expression<T>, ParameterExpression<T>, Selection<T>, Parameter<T>, TupleElement<T>, Serializable, JpaCriteriaNode, JpaExpression<T>, JpaParameterExpression<T>, JpaSelection<T>, JpaTupleElement<T>, QueryParameter<T>, QueryParameterImplementor<T>, SqmExpression<T>, SqmParameter<T>, SqmSelectableNode<T>, SqmCacheable, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

Direct Known Subclasses:

ValueBindJpaCriteriaParameter

public class JpaCriteriaParameter<T>
extends AbstractSqmExpression<T>
implements SqmParameter<T>, QueryParameterImplementor<T>

JpaParameterExpression created via JPA CriteriaBuilder.

Each occurrence of a JpaParameterExpression results in a unique SqmParameter.

See Also:

• ParameterMetadata
• NodeBuilder.parameter(Class)
• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Fields inherited from interface SqmParameter

COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
	JpaCriteriaParameter(@Nullable String name, @Nullable BindableType<? super T> type, boolean allowsMultiValuedBinding, NodeBuilder nodeBuilder)
protected	JpaCriteriaParameter(JpaCriteriaParameter<T> original)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
boolean	allowMultiValuedBinding()	Can a collection/array of values be bound to this parameter?
boolean	allowsMultiValuedBinding()	Does this parameter allow multi-valued (collection, array, etc) binding?
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
void	applyAnticipatedType(BindableType type)
int	cacheHashCode()
SqmParameter<T>	copy()	Make a copy
JpaCriteriaParameter<T>	copy(SqmCopyContext context)
void	disallowMultiValuedBinding()
boolean	equals(@Nullable Object object)
@Nullable BindableType<T>	getAnticipatedType()	Based on the context it is declared, what is the anticipated type for bind values?
@Nullable BindableType<T>	getHibernateType()	Get the Hibernate Type associated with this parameter, if one.
@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()
@Nullable T	getValue()
int	hashCode()
protected void	internalApplyInferableType(@Nullable SqmBindableType<?> newType)
boolean	isCompatible(Object object)
NamedCallableQueryMemento.ParameterMemento	toMemento()

Methods inherited from class AbstractSqmExpression

applyInferableType, as, cast, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, 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 QueryParameter

isNamed, isOrdinal

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, visitSubSelectableNodes

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

JpaCriteriaParameter

public JpaCriteriaParameter(@Nullable String name,
 @Nullable BindableType<? super T> type,
 boolean allowsMultiValuedBinding,
 NodeBuilder nodeBuilder)

JpaCriteriaParameter

protected JpaCriteriaParameter(JpaCriteriaParameter<T> original)

Method Details

copy

public JpaCriteriaParameter<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

getValue

public @Nullable T getValue()

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

getTupleLength

public @Nullable Integer getTupleLength()

Specified by:

getTupleLength in interface SqmSelectableNode<T>

allowsMultiValuedBinding

public boolean allowsMultiValuedBinding()

Description copied from interface: QueryParameter

Does this parameter allow multi-valued (collection, array, etc) binding?

This is only valid for HQL/JPQL and (I think) Criteria queries, and is determined based on the context of the parameters declaration.

Specified by:

allowsMultiValuedBinding in interface QueryParameter<T>

Returns:

true indicates that multi-valued binding is allowed for this parameter

disallowMultiValuedBinding

public void disallowMultiValuedBinding()

Specified by:

disallowMultiValuedBinding in interface QueryParameterImplementor<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.

applyAnticipatedType

public void applyAnticipatedType(BindableType type)

Specified by:

applyAnticipatedType in interface QueryParameterImplementor<T>

copy

public SqmParameter<T> copy()

Description copied from interface: SqmParameter

Make a copy

Specified by:

copy in interface SqmParameter<T>

getHibernateType

public @Nullable BindableType<T> getHibernateType()

Description copied from interface: QueryParameter

Get the Hibernate Type associated with this parameter, if one. May return null.

Specified by:

getHibernateType in interface QueryParameter<T>

Returns:

The associated Hibernate Type, may be null.

getParameterType

public @Nullable Class<T> getParameterType()

Specified by:

getParameterType in interface Parameter<T>

internalApplyInferableType

protected void internalApplyInferableType(@Nullable SqmBindableType<?> newType)

Overrides:

internalApplyInferableType in class AbstractSqmExpression<T>

accept

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

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

toMemento

public NamedCallableQueryMemento.ParameterMemento toMemento()

Specified by:

toMemento in interface QueryParameterImplementor<T>

appendHqlString

public void appendHqlString(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

equals

public boolean equals(@Nullable Object object)

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