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(since="6.3")
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 JpaJsonQueryNode

JpaJsonQueryNode.EmptyBehavior, JpaJsonQueryNode.ErrorBehavior, JpaJsonQueryNode.WrapMode

Method Summary

Modifier and Type	Method	Description
JpaJsonQueryExpression	emptyArrayOnEmpty()	Use the JSON empty behavior that returns an empty array.
JpaJsonQueryExpression	emptyArrayOnError()	Use the JSON error behavior that returns an empty array.
JpaJsonQueryExpression	emptyObjectOnEmpty()	Use the JSON empty behavior that returns an empty object.
JpaJsonQueryExpression	emptyObjectOnError()	Use the JSON error behavior that returns an empty object.
JpaJsonQueryExpression	errorOnEmpty()	Use the JSON empty behavior that raises an error.
JpaJsonQueryExpression	errorOnError()	Use the JSON error behavior that raises an error.
JpaJsonQueryExpression	nullOnEmpty()	Use the JSON empty behavior that returns null.
JpaJsonQueryExpression	nullOnError()	Use the JSON error behavior that returns null.
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()	Use the unspecified JSON empty behavior.
JpaJsonQueryExpression	unspecifiedOnError()	Use the unspecified JSON error behavior.
JpaJsonQueryExpression	unspecifiedWrapper()	Use the unspecified JSON query wrapper mode.
JpaJsonQueryExpression	withConditionalWrapper()	Use the JSON query wrapper mode with a conditional wrapper.
JpaJsonQueryExpression	withoutWrapper()	Use the JSON query wrapper mode without a wrapper.
JpaJsonQueryExpression	withWrapper()	Use the JSON query wrapper mode with a wrapper.

Methods inherited from interface JpaExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, coalesce, coalesce, count, countDistinct, equalTo, equalTo, in, in, in, in, in, isMember, isNotMember, isNotNull, isNull, notEqualTo, notEqualTo, nullif, nullif, selectCase, selectCase

Methods inherited from interface JpaJsonQueryNode

getEmptyBehavior, getErrorBehavior, getWrapMode

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 TupleElement

getAlias

Method Details

passing

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

@Nonnull
JpaJsonQueryExpression withoutWrapper()

Use the JSON query wrapper mode without a wrapper.

Specified by:

withoutWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withWrapper

@Nonnull
JpaJsonQueryExpression withWrapper()

Use the JSON query wrapper mode with a wrapper.

Specified by:

withWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

withConditionalWrapper

@Nonnull
JpaJsonQueryExpression withConditionalWrapper()

Use the JSON query wrapper mode with a conditional wrapper.

Specified by:

withConditionalWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedWrapper

@Nonnull
JpaJsonQueryExpression unspecifiedWrapper()

Use the unspecified JSON query wrapper mode.

Specified by:

unspecifiedWrapper in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnError

@Nonnull
JpaJsonQueryExpression unspecifiedOnError()

Use the unspecified JSON error behavior.

Specified by:

unspecifiedOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnError

@Nonnull
JpaJsonQueryExpression errorOnError()

Use the JSON error behavior that raises an error.

Specified by:

errorOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnError

@Nonnull
JpaJsonQueryExpression nullOnError()

Use the JSON error behavior that returns null.

Specified by:

nullOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnError

@Nonnull
JpaJsonQueryExpression emptyArrayOnError()

Use the JSON error behavior that returns an empty array.

Specified by:

emptyArrayOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnError

@Nonnull
JpaJsonQueryExpression emptyObjectOnError()

Use the JSON error behavior that returns an empty object.

Specified by:

emptyObjectOnError in interface JpaJsonQueryNode

Returns:

this for method chaining

unspecifiedOnEmpty

@Nonnull
JpaJsonQueryExpression unspecifiedOnEmpty()

Use the unspecified JSON empty behavior.

Specified by:

unspecifiedOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

errorOnEmpty

@Nonnull
JpaJsonQueryExpression errorOnEmpty()

Use the JSON empty behavior that raises an error.

Specified by:

errorOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

nullOnEmpty

@Nonnull
JpaJsonQueryExpression nullOnEmpty()

Use the JSON empty behavior that returns null.

Specified by:

nullOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyArrayOnEmpty

@Nonnull
JpaJsonQueryExpression emptyArrayOnEmpty()

Use the JSON empty behavior that returns an empty array.

Specified by:

emptyArrayOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining

emptyObjectOnEmpty

@Nonnull
JpaJsonQueryExpression emptyObjectOnEmpty()

Use the JSON empty behavior that returns an empty object.

Specified by:

emptyObjectOnEmpty in interface JpaJsonQueryNode

Returns:

this for method chaining