Class SqmJsonQueryExpression

java.lang.Object

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

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

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

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

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

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

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

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

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

JpaJsonQueryNode.EmptyBehavior, JpaJsonQueryNode.ErrorBehavior, JpaJsonQueryNode.WrapMode

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmJsonQueryExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, ReturnableType<String> 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)
SqmJsonQueryExpression	copy(SqmCopyContext context)
SqmJsonQueryExpression	emptyArrayOnEmpty()	Use the JSON empty behavior that returns an empty array.
SqmJsonQueryExpression	emptyArrayOnError()	Use the JSON error behavior that returns an empty array.
SqmJsonQueryExpression	emptyObjectOnEmpty()	Use the JSON empty behavior that returns an empty object.
SqmJsonQueryExpression	emptyObjectOnError()	Use the JSON error behavior that returns an empty object.
boolean	equals(Object other)
SqmJsonQueryExpression	errorOnEmpty()	Use the JSON empty behavior that raises an error.
SqmJsonQueryExpression	errorOnError()	Use the JSON error behavior that raises an error.
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.
int	hashCode()
boolean	isCompatible(Object other)
SqmJsonQueryExpression	nullOnEmpty()	Use the JSON empty behavior that returns null.
SqmJsonQueryExpression	nullOnError()	Use the JSON error behavior that returns null.
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()	Use the unspecified JSON empty behavior.
SqmJsonQueryExpression	unspecifiedOnError()	Use the unspecified JSON error behavior.
SqmJsonQueryExpression	unspecifiedWrapper()	Use the unspecified JSON query wrapper mode.
SqmJsonQueryExpression	withConditionalWrapper()	Use the JSON query wrapper mode with a conditional wrapper.
SqmJsonQueryExpression	withoutWrapper()	Use the JSON query wrapper mode without a wrapper.
SqmJsonQueryExpression	withWrapper()	Use the JSON query wrapper mode with a wrapper.

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

SqmJsonQueryExpression

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

Method Details

copy

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

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

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

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

@Nonnull
public SqmJsonQueryExpression withoutWrapper()

Description copied from interface: JpaJsonQueryExpression

Use the JSON query wrapper mode without a wrapper.

Specified by:

withoutWrapper in interface JpaJsonQueryExpression

Specified by:

withoutWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withWrapper

@Nonnull
public SqmJsonQueryExpression withWrapper()

Description copied from interface: JpaJsonQueryExpression

Use the JSON query wrapper mode with a wrapper.

Specified by:

withWrapper in interface JpaJsonQueryExpression

Specified by:

withWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withConditionalWrapper

@Nonnull
public SqmJsonQueryExpression withConditionalWrapper()

Description copied from interface: JpaJsonQueryExpression

Use the JSON query wrapper mode with a conditional wrapper.

Specified by:

withConditionalWrapper in interface JpaJsonQueryExpression

Specified by:

withConditionalWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedWrapper

@Nonnull
public SqmJsonQueryExpression unspecifiedWrapper()

Description copied from interface: JpaJsonQueryExpression

Use the unspecified JSON query wrapper mode.

Specified by:

unspecifiedWrapper in interface JpaJsonQueryExpression

Specified by:

unspecifiedWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnError

@Nonnull
public SqmJsonQueryExpression unspecifiedOnError()

Description copied from interface: JpaJsonQueryExpression

Use the unspecified JSON error behavior.

Specified by:

unspecifiedOnError in interface JpaJsonQueryExpression

Specified by:

unspecifiedOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnError

@Nonnull
public SqmJsonQueryExpression errorOnError()

Description copied from interface: JpaJsonQueryExpression

Use the JSON error behavior that raises an error.

Specified by:

errorOnError in interface JpaJsonQueryExpression

Specified by:

errorOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnError

@Nonnull
public SqmJsonQueryExpression nullOnError()

Description copied from interface: JpaJsonQueryExpression

Use the JSON error behavior that returns null.

Specified by:

nullOnError in interface JpaJsonQueryExpression

Specified by:

nullOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnError

@Nonnull
public SqmJsonQueryExpression emptyArrayOnError()

Description copied from interface: JpaJsonQueryExpression

Use the JSON error behavior that returns an empty array.

Specified by:

emptyArrayOnError in interface JpaJsonQueryExpression

Specified by:

emptyArrayOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnError

@Nonnull
public SqmJsonQueryExpression emptyObjectOnError()

Description copied from interface: JpaJsonQueryExpression

Use the JSON error behavior that returns an empty object.

Specified by:

emptyObjectOnError in interface JpaJsonQueryExpression

Specified by:

emptyObjectOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnEmpty

@Nonnull
public SqmJsonQueryExpression unspecifiedOnEmpty()

Description copied from interface: JpaJsonQueryExpression

Use the unspecified JSON empty behavior.

Specified by:

unspecifiedOnEmpty in interface JpaJsonQueryExpression

Specified by:

unspecifiedOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnEmpty

@Nonnull
public SqmJsonQueryExpression errorOnEmpty()

Description copied from interface: JpaJsonQueryExpression

Use the JSON empty behavior that raises an error.

Specified by:

errorOnEmpty in interface JpaJsonQueryExpression

Specified by:

errorOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnEmpty

@Nonnull
public SqmJsonQueryExpression nullOnEmpty()

Description copied from interface: JpaJsonQueryExpression

Use the JSON empty behavior that returns null.

Specified by:

nullOnEmpty in interface JpaJsonQueryExpression

Specified by:

nullOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnEmpty

@Nonnull
public SqmJsonQueryExpression emptyArrayOnEmpty()

Description copied from interface: JpaJsonQueryExpression

Use the JSON empty behavior that returns an empty array.

Specified by:

emptyArrayOnEmpty in interface JpaJsonQueryExpression

Specified by:

emptyArrayOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnEmpty

@Nonnull
public SqmJsonQueryExpression emptyObjectOnEmpty()

Description copied from interface: JpaJsonQueryExpression

Use the JSON empty behavior that returns an empty object.

Specified by:

emptyObjectOnEmpty in interface JpaJsonQueryExpression

Specified by:

emptyObjectOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

passing

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

@Nonnull
public Expression convertToSqlAst(@Nonnull
 SqmToSqlAstConverter walker)

Overrides:

convertToSqlAst in class SelfRenderingSqmFunction<String>

appendHqlString

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

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmFunction<String>

equals

public boolean equals(@Nullable
 Object other)

Overrides:

equals in class AbstractSqmJsonPathExpression<String>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSqmJsonPathExpression<String>

isCompatible

public boolean isCompatible(@Nullable
 Object other)

Specified by:

isCompatible in interface SqmCacheable

Overrides:

isCompatible in class AbstractSqmJsonPathExpression<String>

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable

Overrides:

cacheHashCode in class AbstractSqmJsonPathExpression<String>