Package org.hibernate.query.criteria

Interface JpaJsonQueryExpression

All Superinterfaces:

Expression<String>, JpaCriteriaNode, JpaExpression<String>, JpaJsonQueryNode, JpaSelection<String>, JpaTupleElement<String>, Selection<String>, Serializable, TupleElement<String>

All Known Implementing Classes:

SqmJsonQueryExpression

@Incubating
public interface JpaJsonQueryExpression
extends JpaExpression<String>, JpaJsonQueryNode

A special expression for the json_query function.

Since:

7.0

Nested Class Summary

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

JpaJsonQueryNode.EmptyBehavior, JpaJsonQueryNode.ErrorBehavior, JpaJsonQueryNode.WrapMode

Method Summary

Modifier and Type	Method	Description
JpaJsonQueryExpression	emptyArrayOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_ARRAY for this json query expression.
JpaJsonQueryExpression	emptyArrayOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_ARRAY for this json query expression.
JpaJsonQueryExpression	emptyObjectOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_OBJECT for this json query expression.
JpaJsonQueryExpression	emptyObjectOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_OBJECT for this json query expression.
JpaJsonQueryExpression	errorOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.ERROR for this json query expression.
JpaJsonQueryExpression	errorOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.ERROR for this json query expression.
JpaJsonQueryExpression	nullOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.NULL for this json query expression.
JpaJsonQueryExpression	nullOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.NULL for this json query expression.
JpaJsonQueryExpression	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
JpaJsonQueryExpression	unspecifiedOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.UNSPECIFIED for this json query expression.
JpaJsonQueryExpression	unspecifiedOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.UNSPECIFIED for this json query expression.
JpaJsonQueryExpression	unspecifiedWrapper()	Sets the JpaJsonQueryNode.WrapMode.UNSPECIFIED for this json query expression.
JpaJsonQueryExpression	withConditionalWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITH_CONDITIONAL_WRAPPER for this json query expression.
JpaJsonQueryExpression	withoutWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITHOUT_WRAPPER for this json query expression.
JpaJsonQueryExpression	withWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITH_WRAPPER for this json query expression.

Methods inherited from interface org.hibernate.query.criteria.JpaExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo

Methods inherited from interface org.hibernate.query.criteria.JpaJsonQueryNode

getEmptyBehavior, getErrorBehavior, getWrapMode

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 jakarta.persistence.TupleElement

getAlias

Method Details

passing

JpaJsonQueryExpression passing(String parameterName,
 Expression<?> expression)

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

Returns:

this for method chaining

withoutWrapper

JpaJsonQueryExpression withoutWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.WITHOUT_WRAPPER for this json query expression.

Specified by:

withoutWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withWrapper

JpaJsonQueryExpression withWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.WITH_WRAPPER for this json query expression.

Specified by:

withWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withConditionalWrapper

JpaJsonQueryExpression withConditionalWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.WITH_CONDITIONAL_WRAPPER for this json query expression.

Specified by:

withConditionalWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedWrapper

JpaJsonQueryExpression unspecifiedWrapper()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.WrapMode.UNSPECIFIED for this json query expression.

Specified by:

unspecifiedWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnError

JpaJsonQueryExpression unspecifiedOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.UNSPECIFIED for this json query expression.

Specified by:

unspecifiedOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnError

JpaJsonQueryExpression errorOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.ERROR for this json query expression.

Specified by:

errorOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnError

JpaJsonQueryExpression nullOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.NULL for this json query expression.

Specified by:

nullOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnError

JpaJsonQueryExpression emptyArrayOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_ARRAY for this json query expression.

Specified by:

emptyArrayOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnError

JpaJsonQueryExpression emptyObjectOnError()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_OBJECT for this json query expression.

Specified by:

emptyObjectOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnEmpty

JpaJsonQueryExpression unspecifiedOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.UNSPECIFIED for this json query expression.

Specified by:

unspecifiedOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnEmpty

JpaJsonQueryExpression errorOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.ERROR for this json query expression.

Specified by:

errorOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnEmpty

JpaJsonQueryExpression nullOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.NULL for this json query expression.

Specified by:

nullOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnEmpty

JpaJsonQueryExpression emptyArrayOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_ARRAY for this json query expression.

Specified by:

emptyArrayOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnEmpty

JpaJsonQueryExpression emptyObjectOnEmpty()

Description copied from interface: JpaJsonQueryNode

Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_OBJECT for this json query expression.

Specified by:

emptyObjectOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining