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

Class SqmJsonExistsExpression

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

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

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

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

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

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

org.hibernate.query.sqm.tree.expression.SqmJsonExistsExpression

All Implemented Interfaces:

Expression<Boolean>, Selection<Boolean>, TupleElement<Boolean>, Serializable, JpaCriteriaNode, JpaExpression<Boolean>, JpaFunction<Boolean>, JpaJsonExistsExpression, JpaJsonExistsNode, JpaSelection<Boolean>, JpaTupleElement<Boolean>, SemanticPathPart, SqmExpression<Boolean>, SqmSelectableNode<Boolean>, SqmExpressibleAccessor<Boolean>, SqmNode, SqmTypedNode<Boolean>, SqmVisitableNode

@Incubating
public class SqmJsonExistsExpression
extends AbstractSqmJsonPathExpression<Boolean>
implements JpaJsonExistsExpression

Special expression for the json_exists function that also captures special syntax elements like error behavior and passing variables.

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

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

JpaJsonExistsNode.ErrorBehavior

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmJsonExistsExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, @Nullable ReturnableType<Boolean> 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)
SqmJsonExistsExpression	copy(SqmCopyContext context)
SqmJsonExistsExpression	errorOnError()	Sets the JpaJsonExistsNode.ErrorBehavior.ERROR for this json exists expression.
SqmJsonExistsExpression	falseOnError()	Sets the JpaJsonExistsNode.ErrorBehavior.FALSE for this json exists expression.
JpaJsonExistsNode.ErrorBehavior	getErrorBehavior()	Get the JpaJsonExistsNode.ErrorBehavior of this json exists expression.
SqmJsonExistsExpression	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
SqmJsonExistsExpression	trueOnError()	Sets the JpaJsonExistsNode.ErrorBehavior.TRUE for this json exists expression.
SqmJsonExistsExpression	unspecifiedOnError()	Sets the JpaJsonExistsNode.ErrorBehavior.UNSPECIFIED for this json exists 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

SqmJsonExistsExpression

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

Method Details

copy

public SqmJsonExistsExpression copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<Boolean>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmSelectableNode<Boolean>

Specified by:

copy in interface SqmTypedNode<Boolean>

Overrides:

copy in class SelfRenderingSqmFunction<Boolean>

getErrorBehavior

public JpaJsonExistsNode.ErrorBehavior getErrorBehavior()

Description copied from interface: JpaJsonExistsNode

Get the JpaJsonExistsNode.ErrorBehavior of this json exists expression.

Specified by:

getErrorBehavior in interface JpaJsonExistsNode

Returns:

the error behavior

unspecifiedOnError

public SqmJsonExistsExpression unspecifiedOnError()

Description copied from interface: JpaJsonExistsNode

Sets the JpaJsonExistsNode.ErrorBehavior.UNSPECIFIED for this json exists expression.

Specified by:

unspecifiedOnError in interface JpaJsonExistsExpression

Specified by:

unspecifiedOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

errorOnError

public SqmJsonExistsExpression errorOnError()

Description copied from interface: JpaJsonExistsNode

Sets the JpaJsonExistsNode.ErrorBehavior.ERROR for this json exists expression.

Specified by:

errorOnError in interface JpaJsonExistsExpression

Specified by:

errorOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

trueOnError

public SqmJsonExistsExpression trueOnError()

Description copied from interface: JpaJsonExistsNode

Sets the JpaJsonExistsNode.ErrorBehavior.TRUE for this json exists expression.

Specified by:

trueOnError in interface JpaJsonExistsExpression

Specified by:

trueOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

falseOnError

public SqmJsonExistsExpression falseOnError()

Description copied from interface: JpaJsonExistsNode

Sets the JpaJsonExistsNode.ErrorBehavior.FALSE for this json exists expression.

Specified by:

falseOnError in interface JpaJsonExistsExpression

Specified by:

falseOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

passing

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

Description copied from interface: JpaJsonExistsExpression

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

Specified by:

passing in interface JpaJsonExistsExpression

Returns:

this for method chaining

convertToSqlAst

public Expression convertToSqlAst(SqmToSqlAstConverter walker)

Overrides:

convertToSqlAst in class SelfRenderingSqmFunction<Boolean>

appendHqlString

public void appendHqlString(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmFunction<Boolean>