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

Class SqmJsonTableFunction<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.expression.SqmSetReturningFunction<T>

org.hibernate.query.sqm.function.SelfRenderingSqmSetReturningFunction<T>

org.hibernate.query.sqm.tree.expression.SqmJsonTableFunction<T>

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaJsonTableColumnsNode, JpaJsonTableFunction, JpaSetReturningFunction<T>, SqmNode, SqmVisitableNode

public class SqmJsonTableFunction<T>
extends SelfRenderingSqmSetReturningFunction<T>
implements JpaJsonTableFunction

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SqmJsonTableFunction.Columns

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

JpaJsonTableFunction.ErrorBehavior

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmJsonTableFunction(SqmSetReturningFunctionDescriptor descriptor, SetReturningFunctionRenderer renderer, @Nullable ArgumentsValidator argumentsValidator, SetReturningFunctionTypeResolver setReturningTypeResolver, NodeBuilder nodeBuilder, SqmExpression<?> document, @Nullable SqmExpression<String> jsonPath)

Method Summary

Modifier and Type	Method	Description
SqmJsonTableFunction<T>	copy(SqmCopyContext context)
protected @Nullable JsonPathPassingClause	createJsonPathPassingClause(SqmToSqlAstConverter walker)
SqmJsonTableFunction<T>	errorOnError()	Sets the JpaJsonTableFunction.ErrorBehavior.ERROR for this json table expression.
JpaJsonExistsNode	existsColumn(String columnName)	Like JpaJsonTableColumnsNode.existsColumn(String, String), but uses the column name as JSON path expression.
JpaJsonExistsNode	existsColumn(String columnName, @Nullable String jsonPath)	Defines a boolean column on the result type with the given name for which the value can be obtained by invoking json_exists with the given JSON path.
JpaJsonTableFunction.ErrorBehavior	getErrorBehavior()	Get the JpaJsonTableFunction.ErrorBehavior of this json table expression.
Map<String,SqmExpression<?>>	getPassingExpressions()
JpaJsonTableColumnsNode	nested(String jsonPath)	Defines nested columns that are accessible by the given JSON path.
SqmJsonTableFunction<T>	nullOnError()	Sets the JpaJsonTableFunction.ErrorBehavior.NULL for this json table expression.
JpaJsonTableFunction	ordinalityColumn(String columnName)	Defines a long typed column on the result type with the given name which is set to the ordinality i.e.
JpaJsonTableFunction	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
JpaJsonQueryNode	queryColumn(String columnName)	Like JpaJsonTableColumnsNode.queryColumn(String, String), but uses the column name as JSON path expression.
JpaJsonQueryNode	queryColumn(String columnName, @Nullable String jsonPath)	Defines a string column on the result type with the given name for which the value can be obtained by invoking json_query with the given JSON path.
protected List<SqlAstNode>	resolveSqlAstArguments(List<? extends SqmTypedNode<?>> sqmArguments, SqmToSqlAstConverter walker)
JpaJsonTableFunction	unspecifiedOnError()	Sets the JpaJsonTableFunction.ErrorBehavior.UNSPECIFIED for this json table expression.
<X> JpaJsonValueNode<X>	valueColumn(String columnName, Class<X> type)	Like JpaJsonTableColumnsNode.valueColumn(String, Class, String) but uses the column name as JSON path expression.
<X> JpaJsonValueNode<X>	valueColumn(String columnName, Class<X> type, String jsonPath)	Defines a column on the result type with the given name and type for which the value can be obtained by the given JSON path expression.
<X> JpaJsonValueNode<X>	valueColumn(String columnName, JpaCastTarget<X> type)	Like JpaJsonTableColumnsNode.valueColumn(String, Class, String) but uses the column name as JSON path expression.
<X> JpaJsonValueNode<X>	valueColumn(String columnName, JpaCastTarget<X> type, String jsonPath)	Defines a column on the result type with the given name and type for which the value can be obtained by the given JSON path expression.

Methods inherited from class org.hibernate.query.sqm.function.SelfRenderingSqmSetReturningFunction

convertToSqlAst, getArgumentsValidator, getFunctionRenderer, getSetReturningTypeResolver, getType, isTypeResolved

Methods inherited from class org.hibernate.query.sqm.tree.expression.SqmSetReturningFunction

accept, appendHqlString, equals, getArguments, getFunctionDescriptor, getFunctionName, hashCode

Methods inherited from class org.hibernate.query.sqm.tree.AbstractSqmNode

nodeBuilder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode

toHqlString

Constructor Details

SqmJsonTableFunction

public SqmJsonTableFunction(SqmSetReturningFunctionDescriptor descriptor,
 SetReturningFunctionRenderer renderer,
 @Nullable ArgumentsValidator argumentsValidator,
 SetReturningFunctionTypeResolver setReturningTypeResolver,
 NodeBuilder nodeBuilder,
 SqmExpression<?> document,
 @Nullable SqmExpression<String> jsonPath)

Method Details

getPassingExpressions

public Map<String,SqmExpression<?>> getPassingExpressions()

passing

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

Description copied from interface: JpaJsonTableFunction

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

Specified by:

passing in interface JpaJsonTableFunction

Returns:

this for method chaining

copy

public SqmJsonTableFunction<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmNode

Overrides:

copy in class SelfRenderingSqmSetReturningFunction<T>

resolveSqlAstArguments

protected List<SqlAstNode> resolveSqlAstArguments(List<? extends SqmTypedNode<?>> sqmArguments,
 SqmToSqlAstConverter walker)

Overrides:

resolveSqlAstArguments in class SelfRenderingSqmSetReturningFunction<T>

createJsonPathPassingClause

protected @Nullable JsonPathPassingClause createJsonPathPassingClause(SqmToSqlAstConverter walker)

getErrorBehavior

public JpaJsonTableFunction.ErrorBehavior getErrorBehavior()

Description copied from interface: JpaJsonTableFunction

Get the JpaJsonTableFunction.ErrorBehavior of this json table expression.

Specified by:

getErrorBehavior in interface JpaJsonTableFunction

Returns:

the error behavior

unspecifiedOnError

public JpaJsonTableFunction unspecifiedOnError()

Description copied from interface: JpaJsonTableFunction

Sets the JpaJsonTableFunction.ErrorBehavior.UNSPECIFIED for this json table expression.

Specified by:

unspecifiedOnError in interface JpaJsonTableFunction

Returns:

this for method chaining

nullOnError

public SqmJsonTableFunction<T> nullOnError()

Description copied from interface: JpaJsonTableFunction

Sets the JpaJsonTableFunction.ErrorBehavior.NULL for this json table expression.

Specified by:

nullOnError in interface JpaJsonTableFunction

Returns:

this for method chaining

errorOnError

public SqmJsonTableFunction<T> errorOnError()

Description copied from interface: JpaJsonTableFunction

Sets the JpaJsonTableFunction.ErrorBehavior.ERROR for this json table expression.

Specified by:

errorOnError in interface JpaJsonTableFunction

Returns:

this for method chaining

existsColumn

public JpaJsonExistsNode existsColumn(String columnName)

Description copied from interface: JpaJsonTableColumnsNode

Like JpaJsonTableColumnsNode.existsColumn(String, String), but uses the column name as JSON path expression.

Specified by:

existsColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonExistsNode for the column

existsColumn

public JpaJsonExistsNode existsColumn(String columnName,
 @Nullable String jsonPath)

Description copied from interface: JpaJsonTableColumnsNode

Defines a boolean column on the result type with the given name for which the value can be obtained by invoking json_exists with the given JSON path.

Specified by:

existsColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonExistsNode for the column

queryColumn

public JpaJsonQueryNode queryColumn(String columnName)

Description copied from interface: JpaJsonTableColumnsNode

Like JpaJsonTableColumnsNode.queryColumn(String, String), but uses the column name as JSON path expression.

Specified by:

queryColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonQueryNode for the column

queryColumn

public JpaJsonQueryNode queryColumn(String columnName,
 @Nullable String jsonPath)

Description copied from interface: JpaJsonTableColumnsNode

Defines a string column on the result type with the given name for which the value can be obtained by invoking json_query with the given JSON path.

Specified by:

queryColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonQueryNode for the column

valueColumn

public <X> JpaJsonValueNode<X> valueColumn(String columnName,
 Class<X> type)

Description copied from interface: JpaJsonTableColumnsNode

Like JpaJsonTableColumnsNode.valueColumn(String, Class, String) but uses the column name as JSON path expression.

Specified by:

valueColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonValueNode for the column

valueColumn

public <X> JpaJsonValueNode<X> valueColumn(String columnName,
 Class<X> type,
 String jsonPath)

Description copied from interface: JpaJsonTableColumnsNode

Defines a column on the result type with the given name and type for which the value can be obtained by the given JSON path expression.

Specified by:

valueColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonValueNode for the column

valueColumn

public <X> JpaJsonValueNode<X> valueColumn(String columnName,
 JpaCastTarget<X> type,
 String jsonPath)

Description copied from interface: JpaJsonTableColumnsNode

Defines a column on the result type with the given name and type for which the value can be obtained by the given JSON path expression.

Specified by:

valueColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonValueNode for the column

valueColumn

public <X> JpaJsonValueNode<X> valueColumn(String columnName,
 JpaCastTarget<X> type)

Description copied from interface: JpaJsonTableColumnsNode

Like JpaJsonTableColumnsNode.valueColumn(String, Class, String) but uses the column name as JSON path expression.

Specified by:

valueColumn in interface JpaJsonTableColumnsNode

Returns:

The JpaJsonValueNode for the column

nested

public JpaJsonTableColumnsNode nested(String jsonPath)

Description copied from interface: JpaJsonTableColumnsNode

Defines nested columns that are accessible by the given JSON path.

Specified by:

nested in interface JpaJsonTableColumnsNode

Returns:

a new columns node for the nested JSON path

ordinalityColumn

public JpaJsonTableFunction ordinalityColumn(String columnName)

Description copied from interface: JpaJsonTableColumnsNode

Defines a long typed column on the result type with the given name which is set to the ordinality i.e. the 1-based position of the processed element. Ordinality starts again at 1 within nested paths.

Specified by:

ordinalityColumn in interface JpaJsonTableColumnsNode

Specified by:

ordinalityColumn in interface JpaJsonTableFunction

Returns:

this for method chaining