Class SqmJsonExistsExpression

java.lang.Object

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

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

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

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

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

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

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

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

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

JpaJsonExistsNode.ErrorBehavior

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmJsonExistsExpression(SqmFunctionDescriptor descriptor, FunctionRenderer renderer, List<? extends SqmTypedNode<?>> arguments, ReturnableType<Boolean> 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)
SqmJsonExistsExpression	copy(SqmCopyContext context)
boolean	equals(Object other)
SqmJsonExistsExpression	errorOnError()	Use the JSON error behavior that raises an error.
SqmJsonExistsExpression	falseOnError()	Use the JSON error behavior that returns false.
JpaJsonExistsNode.ErrorBehavior	getErrorBehavior()	Get the JpaJsonExistsNode.ErrorBehavior of this json exists expression.
int	hashCode()
boolean	isCompatible(Object other)
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()	Use the JSON error behavior that returns true.
SqmJsonExistsExpression	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

SqmJsonExistsExpression

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

Method Details

copy

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

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

@Nonnull
public SqmJsonExistsExpression unspecifiedOnError()

Description copied from interface: JpaJsonExistsExpression

Use the unspecified JSON error behavior.

Specified by:

unspecifiedOnError in interface JpaJsonExistsExpression

Specified by:

unspecifiedOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

errorOnError

@Nonnull
public SqmJsonExistsExpression errorOnError()

Description copied from interface: JpaJsonExistsExpression

Use the JSON error behavior that raises an error.

Specified by:

errorOnError in interface JpaJsonExistsExpression

Specified by:

errorOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

trueOnError

@Nonnull
public SqmJsonExistsExpression trueOnError()

Description copied from interface: JpaJsonExistsExpression

Use the JSON error behavior that returns true.

Specified by:

trueOnError in interface JpaJsonExistsExpression

Specified by:

trueOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

falseOnError

@Nonnull
public SqmJsonExistsExpression falseOnError()

Description copied from interface: JpaJsonExistsExpression

Use the JSON error behavior that returns false.

Specified by:

falseOnError in interface JpaJsonExistsExpression

Specified by:

falseOnError in interface JpaJsonExistsNode

Returns:

this for method chaining

passing

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

@Nonnull
public Expression convertToSqlAst(@Nonnull
 SqmToSqlAstConverter walker)

Overrides:

convertToSqlAst in class SelfRenderingSqmFunction<Boolean>

appendHqlString

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

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmFunction<Boolean>

equals

public boolean equals(@Nullable
 Object other)

Overrides:

equals in class AbstractSqmJsonPathExpression<Boolean>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSqmJsonPathExpression<Boolean>

isCompatible

public boolean isCompatible(@Nullable
 Object other)

Specified by:

isCompatible in interface SqmCacheable

Overrides:

isCompatible in class AbstractSqmJsonPathExpression<Boolean>

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable

Overrides:

cacheHashCode in class AbstractSqmJsonPathExpression<Boolean>