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
,Comparable<SqmParameter<T>>
,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 theSqmParameter
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SqmJpaCriteriaParameterWrapper(BindableType<T> type, JpaCriteriaParameter<T> jpaCriteriaParameter, NodeBuilder criteriaBuilder)
-
Method Summary
All Methods Instance Methods Concrete Methods 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)
int
compareTo(SqmParameter anotherParameter)
SqmParameter<T>
copy()
Make a copySqmJpaCriteriaParameterWrapper<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 returnnull
.Class<T>
getParameterType()
Integer
getPosition()
If this represents a positional parameter, return that parameter position; otherwise returnnull
.void
visitSubSelectableNodes(Consumer<SqmSelectableNode<?>> jpaSelectionConsumer)
Visit each of this selectable's direct sub-selectables - used to support JPA'sSelection
model (which is really a "selectable", just poorly named and poorly defined-
Methods inherited from class org.hibernate.query.sqm.tree.expression.AbstractSqmExpression
applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder
-
Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection
alias, 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, getJavaTypeName, isEnum
-
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, cast, castAs, equalTo, equalTo, getNodeType, 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.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
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 interfaceSqmExpression<T>
- Specified by:
copy
in interfaceSqmNode
- Specified by:
copy
in interfaceSqmParameter<T>
- Specified by:
copy
in interfaceSqmSelectableNode<T>
- Specified by:
copy
in interfaceSqmTypedNode<T>
-
getName
public String getName()
Description copied from interface:SqmParameter
If this represents a named parameter, return that parameter name; otherwise returnnull
.
-
getPosition
public Integer getPosition()
Description copied from interface:SqmParameter
If this represents a positional parameter, return that parameter position; otherwise returnnull
.- Specified by:
getPosition
in interfaceParameter<T>
- Specified by:
getPosition
in interfaceSqmParameter<T>
- Returns:
- The parameter position
-
getJpaCriteriaParameter
public JpaCriteriaParameter<T> getJpaCriteriaParameter()
-
getParameterType
public Class<T> getParameterType()
- Specified by:
getParameterType
in interfaceParameter<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:
- as the value of an IN predicate if the only value is a single param
- (in non-strict JPA mode) as the final vararg to a function
- Specified by:
allowMultiValuedBinding
in interfaceSqmParameter<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 interfaceSqmParameter<T>
- Returns:
- The anticipated Type.
-
copy
public SqmParameter<T> copy()
Description copied from interface:SqmParameter
Make a copy- Specified by:
copy
in interfaceSqmParameter<T>
-
accept
public <X> X accept(SemanticQueryWalker<X> walker)
Unsupported. Visitation for a criteria parameter should be handled as part ofSemanticQueryWalker.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 theQueryParameter
toSqmParameter
toJdbcParameter
transformation. Each occurrence requires a unique SqmParameter to make sure we ultimately get the complete set of JdbcParameter references- Specified by:
accept
in interfaceSqmVisitableNode
-
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'sSelection
model (which is really a "selectable", just poorly named and poorly defined- Specified by:
visitSubSelectableNodes
in interfaceSqmExpression<T>
- Specified by:
visitSubSelectableNodes
in interfaceSqmSelectableNode<T>
- See Also:
JpaSelection.getSelectionItems()
,Selection.getCompoundSelectionItems()
-
appendHqlString
public void appendHqlString(StringBuilder sb)
- Specified by:
appendHqlString
in interfaceSqmVisitableNode
-
compareTo
public int compareTo(SqmParameter anotherParameter)
- Specified by:
compareTo
in interfaceComparable<T>
- Specified by:
compareTo
in interfaceSqmParameter<T>
-
-