Class SqmJsonValueExpression<T>

java.lang.Object

org.hibernate.query.sqm.tree.spi.AbstractSqmNode

org.hibernate.query.sqm.tree.spi.jpa.AbstractJpaTupleElement<T>

org.hibernate.query.sqm.tree.spi.jpa.AbstractJpaSelection<T>

org.hibernate.query.sqm.tree.spi.expression.AbstractSqmExpression<T>

org.hibernate.query.sqm.tree.spi.expression.SqmFunction<T>

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

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

org.hibernate.query.sqm.tree.spi.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>, SqmCacheable, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

@Incubating(since="6.2")
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 JpaJsonValueNode

JpaJsonValueNode.EmptyBehavior, JpaJsonValueNode.ErrorBehavior

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
int	cacheHashCode()
Expression	convertToSqlAst(SqmToSqlAstConverter walker)
SqmJsonValueExpression<T>	copy(SqmCopyContext context)
SqmJsonValueExpression<T>	defaultOnEmpty(Expression<?> expression)	Use the JSON empty behavior that returns the given default value.
SqmJsonValueExpression<T>	defaultOnError(Expression<?> expression)	Use the JSON error behavior that returns the given default value.
boolean	equals(Object other)
SqmJsonValueExpression<T>	errorOnEmpty()	Use the JSON empty behavior that raises an error.
SqmJsonValueExpression<T>	errorOnError()	Use the JSON error behavior that raises an error.
JpaJsonValueNode.EmptyBehavior	getEmptyBehavior()	Get the JpaJsonValueNode.EmptyBehavior of this json value expression.
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.
JpaExpression<T>	getErrorDefault()	Get the JpaExpression that is returned on a json processing error.
int	hashCode()
boolean	isCompatible(Object other)
SqmJsonValueExpression<T>	nullOnEmpty()	Use the JSON empty behavior that returns null.
SqmJsonValueExpression<T>	nullOnError()	Use the JSON error behavior that returns null.
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()	Use the unspecified JSON empty behavior.
SqmJsonValueExpression<T>	unspecifiedOnError()	Use the unspecified JSON error behavior.

Methods inherited from class AbstractSqmJsonPathExpression

addPassingExpression, appendPassingExpressionHqlString, copyPassingExpressions, createJsonPathPassingClause, getPassingExpressions

Methods inherited from class SelfRenderingSqmFunction

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

Methods inherited from class SqmFunction

accept, getArguments, getFunctionDescriptor, getFunctionName, resolveIndexedAccess, resolvePathPart

Methods inherited from class AbstractSqmExpression

applyInferableType, as, cast, coalesce, coalesce, count, countDistinct, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, in, internalApplyInferableType, isMember, isNotMember, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo, nullif, nullif, selectCase, selectCase

Methods inherited from class AbstractJpaSelection

alias, getSelectionItems, isCompoundSelection

Methods inherited from class AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface JpaExpression

coalesce, coalesce, count, countDistinct, in, isMember, isNotMember, nullif, nullif, selectCase, selectCase

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeDescriptor, getJavaTypeIfKnown, getJavaTypeName, isEnum

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface SqmExpression

asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, castAs, visitSubSelectableNodes

Methods inherited from interface SqmNode

asLoggableText

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

SqmJsonValueExpression

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

Method Details

copy

@Nonnull
public SqmJsonValueExpression<T> copy(@Nonnull
 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

@Nonnull
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

@Nonnull
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

@Nullable
public 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

@Nullable
public 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

@Nonnull
public SqmJsonValueExpression<T> unspecifiedOnError()

Description copied from interface: JpaJsonValueExpression

Use the unspecified JSON error behavior.

Specified by:

unspecifiedOnError in interface JpaJsonValueExpression<T>

Specified by:

unspecifiedOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

errorOnError

@Nonnull
public SqmJsonValueExpression<T> errorOnError()

Description copied from interface: JpaJsonValueExpression

Use the JSON error behavior that raises an error.

Specified by:

errorOnError in interface JpaJsonValueExpression<T>

Specified by:

errorOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

nullOnError

@Nonnull
public SqmJsonValueExpression<T> nullOnError()

Description copied from interface: JpaJsonValueExpression

Use the JSON error behavior that returns null.

Specified by:

nullOnError in interface JpaJsonValueExpression<T>

Specified by:

nullOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

defaultOnError

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

Description copied from interface: JpaJsonValueExpression

Use the JSON error behavior that returns the given default value.

Specified by:

defaultOnError in interface JpaJsonValueExpression<T>

Specified by:

defaultOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

unspecifiedOnEmpty

@Nonnull
public SqmJsonValueExpression<T> unspecifiedOnEmpty()

Description copied from interface: JpaJsonValueExpression

Use the unspecified JSON empty behavior.

Specified by:

unspecifiedOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

unspecifiedOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

errorOnEmpty

@Nonnull
public SqmJsonValueExpression<T> errorOnEmpty()

Description copied from interface: JpaJsonValueExpression

Use the JSON empty behavior that raises an error.

Specified by:

errorOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

errorOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

nullOnEmpty

@Nonnull
public SqmJsonValueExpression<T> nullOnEmpty()

Description copied from interface: JpaJsonValueExpression

Use the JSON empty behavior that returns null.

Specified by:

nullOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

nullOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

defaultOnEmpty

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

Description copied from interface: JpaJsonValueExpression

Use the JSON empty behavior that returns the given default value.

Specified by:

defaultOnEmpty in interface JpaJsonValueExpression<T>

Specified by:

defaultOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

passing

@Nonnull
public SqmJsonValueExpression<T> passing(@Nonnull
 String parameterName,
 @Nonnull
 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

@Nonnull
public Expression convertToSqlAst(@Nonnull
 SqmToSqlAstConverter walker)

Overrides:

convertToSqlAst in class SelfRenderingSqmFunction<T>

appendHqlString

public void appendHqlString(@Nonnull
 StringBuilder hql,
 @Nonnull
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmFunction<T>

equals

public boolean equals(@Nullable
 Object other)

Overrides:

equals in class AbstractSqmJsonPathExpression<T>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSqmJsonPathExpression<T>

isCompatible

public boolean isCompatible(@Nullable
 Object other)

Specified by:

isCompatible in interface SqmCacheable

Overrides:

isCompatible in class AbstractSqmJsonPathExpression<T>

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable

Overrides:

cacheHashCode in class AbstractSqmJsonPathExpression<T>