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

Class SqmJsonQueryExpression

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

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

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

org.hibernate.query.sqm.tree.expression.SqmFunction<String>

org.hibernate.query.sqm.function.SelfRenderingSqmFunction<String>

org.hibernate.query.sqm.tree.expression.AbstractSqmJsonPathExpression<String>

org.hibernate.query.sqm.tree.expression.SqmJsonQueryExpression

All Implemented Interfaces:

Expression<String>, Selection<String>, TupleElement<String>, Serializable, JpaCriteriaNode, JpaExpression<String>, JpaFunction<String>, JpaJsonQueryExpression, JpaJsonQueryNode, JpaSelection<String>, JpaTupleElement<String>, SemanticPathPart, SqmExpression<String>, SqmSelectableNode<String>, SqmExpressibleAccessor<String>, SqmNode, SqmTypedNode<String>, SqmVisitableNode

@Incubating
public class SqmJsonQueryExpression
extends AbstractSqmJsonPathExpression<String>
implements JpaJsonQueryExpression

Special expression for the json_query function that also captures special syntax elements like error and empty behavior.

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.criteria.JpaJsonQueryNode

JpaJsonQueryNode.EmptyBehavior, JpaJsonQueryNode.ErrorBehavior, JpaJsonQueryNode.WrapMode

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmJsonQueryExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<String> impliedResultType, @Nullable ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, NodeBuilder nodeBuilder, String name)

Method Summary

Modifier and Type	Method	Description
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
Expression	convertToSqlAst(SqmToSqlAstConverter walker)
SqmJsonQueryExpression	copy(SqmCopyContext context)
SqmJsonQueryExpression	emptyArrayOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_ARRAY for this json query expression.
SqmJsonQueryExpression	emptyArrayOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_ARRAY for this json query expression.
SqmJsonQueryExpression	emptyObjectOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_OBJECT for this json query expression.
SqmJsonQueryExpression	emptyObjectOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_OBJECT for this json query expression.
SqmJsonQueryExpression	errorOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.ERROR for this json query expression.
SqmJsonQueryExpression	errorOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.ERROR for this json query expression.
JpaJsonQueryNode.EmptyBehavior	getEmptyBehavior()	Get the JpaJsonQueryNode.EmptyBehavior of this json query expression.
JpaJsonQueryNode.ErrorBehavior	getErrorBehavior()	Get the JpaJsonQueryNode.ErrorBehavior of this json query expression.
JpaJsonQueryNode.WrapMode	getWrapMode()	Get the JpaJsonQueryNode.WrapMode of this json query expression.
SqmJsonQueryExpression	nullOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.NULL for this json query expression.
SqmJsonQueryExpression	nullOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.NULL for this json query expression.
SqmJsonQueryExpression	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
SqmJsonQueryExpression	unspecifiedOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.UNSPECIFIED for this json query expression.
SqmJsonQueryExpression	unspecifiedOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.UNSPECIFIED for this json query expression.
SqmJsonQueryExpression	unspecifiedWrapper()	Sets the JpaJsonQueryNode.WrapMode.UNSPECIFIED for this json query expression.
SqmJsonQueryExpression	withConditionalWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITH_CONDITIONAL_WRAPPER for this json query expression.
SqmJsonQueryExpression	withoutWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITHOUT_WRAPPER for this json query expression.
SqmJsonQueryExpression	withWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITH_WRAPPER for this json query expression.

Methods inherited from class org.hibernate.query.sqm.tree.expression.AbstractSqmJsonPathExpression

addPassingExpression, appendPassingExpressionHqlString, copyPassingExpressions, createJsonPathPassingClause, getPassingExpressions

Methods inherited from class org.hibernate.query.sqm.function.SelfRenderingSqmFunction

determineResultType, getArgumentsValidator, getFunctionRenderer, getImpliedResultType, getMappingModelExpressible, getNodeType, getReturnTypeResolver, resolveResultType, resolveSqlAstArguments

Methods inherited from class org.hibernate.query.sqm.tree.expression.SqmFunction

accept, equals, getArguments, getFunctionDescriptor, getFunctionName, hashCode, resolveIndexedAccess, resolvePathPart

Methods inherited from class org.hibernate.query.sqm.tree.expression.AbstractSqmExpression

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

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, setAlias, setExpressibleType

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

castAs, visitSubSelectableNodes

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

asLoggableText

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 Details

SqmJsonQueryExpression

public SqmJsonQueryExpression(SqmFunctionDescriptor descriptor,
 FunctionRenderer renderer,
 List<? extends SqmTypedNode<?>> arguments,
 @Nullable ReturnableType<String> impliedResultType,
 @Nullable ArgumentsValidator argumentsValidator,
 FunctionReturnTypeResolver returnTypeResolver,
 NodeBuilder nodeBuilder,
 String name)

Method Details

copy

public SqmJsonQueryExpression copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<String>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmSelectableNode<String>

Specified by:

copy in interface SqmTypedNode<String>

Overrides:

copy in class SelfRenderingSqmFunction<String>

getWrapMode

public JpaJsonQueryNode.WrapMode getWrapMode()

Description copied from interface: JpaJsonQueryNode

Get the JpaJsonQueryNode.WrapMode of this json query expression.

Specified by:

getWrapMode in interface JpaJsonQueryNode

Returns:

the wrap mode

getErrorBehavior

public JpaJsonQueryNode.ErrorBehavior getErrorBehavior()

Description copied from interface: JpaJsonQueryNode

Get the JpaJsonQueryNode.ErrorBehavior of this json query expression.

Specified by:

getErrorBehavior in interface JpaJsonQueryNode

Returns:

the error behavior

getEmptyBehavior

public JpaJsonQueryNode.EmptyBehavior getEmptyBehavior()

Description copied from interface: JpaJsonQueryNode

Get the JpaJsonQueryNode.EmptyBehavior of this json query expression.

Specified by:

getEmptyBehavior in interface JpaJsonQueryNode

Returns:

the empty behavior

withoutWrapper

public SqmJsonQueryExpression withoutWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.WITHOUT_WRAPPER for this json query expression.

Specified by:

withoutWrapper in interface JpaJsonQueryExpression

Specified by:

withoutWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withWrapper

public SqmJsonQueryExpression withWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.WITH_WRAPPER for this json query expression.

Specified by:

withWrapper in interface JpaJsonQueryExpression

Specified by:

withWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withConditionalWrapper

public SqmJsonQueryExpression withConditionalWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.WITH_CONDITIONAL_WRAPPER for this json query expression.

Specified by:

withConditionalWrapper in interface JpaJsonQueryExpression

Specified by:

withConditionalWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedWrapper

public SqmJsonQueryExpression unspecifiedWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.UNSPECIFIED for this json query expression.

Specified by:

unspecifiedWrapper in interface JpaJsonQueryExpression

Specified by:

unspecifiedWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnError

public SqmJsonQueryExpression unspecifiedOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.UNSPECIFIED for this json query expression.

Specified by:

unspecifiedOnError in interface JpaJsonQueryExpression

Specified by:

unspecifiedOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnError

public SqmJsonQueryExpression errorOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.ERROR for this json query expression.

Specified by:

errorOnError in interface JpaJsonQueryExpression

Specified by:

errorOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnError

public SqmJsonQueryExpression nullOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.NULL for this json query expression.

Specified by:

nullOnError in interface JpaJsonQueryExpression

Specified by:

nullOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnError

public SqmJsonQueryExpression emptyArrayOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_ARRAY for this json query expression.

Specified by:

emptyArrayOnError in interface JpaJsonQueryExpression

Specified by:

emptyArrayOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnError

public SqmJsonQueryExpression emptyObjectOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_OBJECT for this json query expression.

Specified by:

emptyObjectOnError in interface JpaJsonQueryExpression

Specified by:

emptyObjectOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnEmpty

public SqmJsonQueryExpression unspecifiedOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.UNSPECIFIED for this json query expression.

Specified by:

unspecifiedOnEmpty in interface JpaJsonQueryExpression

Specified by:

unspecifiedOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnEmpty

public SqmJsonQueryExpression errorOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.ERROR for this json query expression.

Specified by:

errorOnEmpty in interface JpaJsonQueryExpression

Specified by:

errorOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnEmpty

public SqmJsonQueryExpression nullOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.NULL for this json query expression.

Specified by:

nullOnEmpty in interface JpaJsonQueryExpression

Specified by:

nullOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnEmpty

public SqmJsonQueryExpression emptyArrayOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_ARRAY for this json query expression.

Specified by:

emptyArrayOnEmpty in interface JpaJsonQueryExpression

Specified by:

emptyArrayOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnEmpty

public SqmJsonQueryExpression emptyObjectOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_OBJECT for this json query expression.

Specified by:

emptyObjectOnEmpty in interface JpaJsonQueryExpression

Specified by:

emptyObjectOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

passing

public SqmJsonQueryExpression passing(String parameterName,
 Expression<?> expression)

Description copied from interface: JpaJsonQueryExpression

Passes the given Expression as value for the parameter with the given name in the JSON path.

Specified by:

passing in interface JpaJsonQueryExpression

Returns:

this for method chaining

convertToSqlAst

public Expression convertToSqlAst(SqmToSqlAstConverter walker)

Overrides:

convertToSqlAst in class SelfRenderingSqmFunction<String>

appendHqlString

public void appendHqlString(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmFunction<String>