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

Class SqmJsonValueExpression<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.SqmFunction<T>

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

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

org.hibernate.query.sqm.tree.expression.SqmJsonValueExpression<T>

All Implemented Interfaces:

Expression<T>, Selection<T>, TupleElement<T>, Serializable, JpaCriteriaNode, JpaExpression<T>, JpaFunction<T>, JpaJsonValueExpression<T>, JpaJsonValueNode<T>, JpaSelection<T>, JpaTupleElement<T>, SemanticPathPart, SqmExpression<T>, SqmSelectableNode<T>, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

@Incubating
public class SqmJsonValueExpression<T>
extends AbstractSqmJsonPathExpression<T>
implements JpaJsonValueExpression<T>

Special expression for the json_value 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.JpaJsonValueNode

JpaJsonValueNode.EmptyBehavior, JpaJsonValueNode.ErrorBehavior

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmJsonValueExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<T> 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)
SqmJsonValueExpression<T>	copy(SqmCopyContext context)
SqmJsonValueExpression<T>	defaultOnEmpty(Expression<?> expression)	Sets the JpaJsonValueNode.EmptyBehavior.DEFAULT for this json value expression.
SqmJsonValueExpression<T>	defaultOnError(Expression<?> expression)	Sets the JpaJsonValueNode.ErrorBehavior.DEFAULT for this json value expression.
SqmJsonValueExpression<T>	errorOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.ERROR for this json value expression.
SqmJsonValueExpression<T>	errorOnError()	Sets the JpaJsonValueNode.ErrorBehavior.ERROR for this json value expression.
JpaJsonValueNode.EmptyBehavior	getEmptyBehavior()	Get the JpaJsonValueNode.EmptyBehavior of this json value expression.
@Nullable JpaExpression<T>	getEmptyDefault()	Get the JpaExpression that is returned when the JSON path does not resolve for a JSON document.
JpaJsonValueNode.ErrorBehavior	getErrorBehavior()	Get the JpaJsonValueNode.ErrorBehavior of this json value expression.
@Nullable JpaExpression<T>	getErrorDefault()	Get the JpaExpression that is returned on a json processing error.
SqmJsonValueExpression<T>	nullOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.NULL for this json value expression.
SqmJsonValueExpression<T>	nullOnError()	Sets the JpaJsonValueNode.ErrorBehavior.NULL for this json value expression.
SqmJsonValueExpression<T>	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
SqmJsonValueExpression<T>	unspecifiedOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.UNSPECIFIED for this json value expression.
SqmJsonValueExpression<T>	unspecifiedOnError()	Sets the JpaJsonValueNode.ErrorBehavior.UNSPECIFIED for this json value 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

SqmJsonValueExpression

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

Method Details

copy

public SqmJsonValueExpression<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmSelectableNode<T>

Specified by:

copy in interface SqmTypedNode<T>

Overrides:

copy in class SelfRenderingSqmFunction<T>

getErrorBehavior

public JpaJsonValueNode.ErrorBehavior getErrorBehavior()

Description copied from interface: JpaJsonValueNode

Get the JpaJsonValueNode.ErrorBehavior of this json value expression.

Specified by:

getErrorBehavior in interface JpaJsonValueNode<T>

Returns:

the error behavior

getEmptyBehavior

public JpaJsonValueNode.EmptyBehavior getEmptyBehavior()

Description copied from interface: JpaJsonValueNode

Get the JpaJsonValueNode.EmptyBehavior of this json value expression.

Specified by:

getEmptyBehavior in interface JpaJsonValueNode<T>

Returns:

the empty behavior

getErrorDefault

public @Nullable JpaExpression<T> getErrorDefault()

Description copied from interface: JpaJsonValueNode

Get the JpaExpression that is returned on a json processing error. Returns null if JpaJsonValueNode.getErrorBehavior() is not JpaJsonValueNode.ErrorBehavior.DEFAULT.

Specified by:

getErrorDefault in interface JpaJsonValueNode<T>

Returns:

the value to return on a json processing error

getEmptyDefault

public @Nullable JpaExpression<T> getEmptyDefault()

Description copied from interface: JpaJsonValueNode

Get the JpaExpression that is returned when the JSON path does not resolve for a JSON document. Returns null if JpaJsonValueNode.getEmptyBehavior() is not JpaJsonValueNode.EmptyBehavior.DEFAULT.

Specified by:

getEmptyDefault in interface JpaJsonValueNode<T>

Returns:

the value to return on a json processing error

unspecifiedOnError

public SqmJsonValueExpression<T> unspecifiedOnError()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.UNSPECIFIED for this json value expression.

Specified by:

unspecifiedOnError in interface JpaJsonValueExpression<T>

Specified by:

unspecifiedOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

errorOnError

public SqmJsonValueExpression<T> errorOnError()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.ERROR for this json value expression.

Specified by:

errorOnError in interface JpaJsonValueExpression<T>

Specified by:

errorOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

nullOnError

public SqmJsonValueExpression<T> nullOnError()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.NULL for this json value expression.

Specified by:

nullOnError in interface JpaJsonValueExpression<T>

Specified by:

nullOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

defaultOnError

public SqmJsonValueExpression<T> defaultOnError(Expression<?> expression)

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.DEFAULT for this json value expression.

Specified by:

defaultOnError in interface JpaJsonValueExpression<T>

Specified by:

defaultOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

unspecifiedOnEmpty

public SqmJsonValueExpression<T> unspecifiedOnEmpty()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.UNSPECIFIED for this json value expression.

Specified by:

unspecifiedOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

unspecifiedOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

errorOnEmpty

public SqmJsonValueExpression<T> errorOnEmpty()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.ERROR for this json value expression.

Specified by:

errorOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

errorOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

nullOnEmpty

public SqmJsonValueExpression<T> nullOnEmpty()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.NULL for this json value expression.

Specified by:

nullOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

nullOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

defaultOnEmpty

public SqmJsonValueExpression<T> defaultOnEmpty(Expression<?> expression)

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.DEFAULT for this json value expression.

Specified by:

defaultOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

defaultOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

passing

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

Description copied from interface: JpaJsonValueExpression

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

Specified by:

passing in interface JpaJsonValueExpression<T>

Returns:

this for method chaining

convertToSqlAst

public Expression convertToSqlAst(SqmToSqlAstConverter walker)

Overrides:

convertToSqlAst in class SelfRenderingSqmFunction<T>

appendHqlString

public void appendHqlString(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmFunction<T>