Package org.hibernate.query.criteria

Interface JpaJsonTableColumnsNode

All Known Subinterfaces:

JpaJsonTableFunction

All Known Implementing Classes:

SqmJsonTableFunction, SqmJsonTableFunction.Columns

@Incubating
public interface JpaJsonTableColumnsNode

A special expression for the definition of columns within the json_table function.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
JpaJsonExistsNode	existsColumn(String columnName)	Like existsColumn(String, String), but uses the column name as JSON path expression.
JpaJsonExistsNode	existsColumn(String columnName, 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.
JpaJsonTableColumnsNode	nested(String jsonPath)	Defines nested columns that are accessible by the given JSON path.
JpaJsonTableColumnsNode	ordinalityColumn(String columnName)	Defines a long typed column on the result type with the given name which is set to the ordinality i.e.
JpaJsonQueryNode	queryColumn(String columnName)	Like queryColumn(String, String), but uses the column name as JSON path expression.
JpaJsonQueryNode	queryColumn(String columnName, 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.
<T> JpaJsonValueNode<T>	valueColumn(String columnName, Class<T> type)	Like valueColumn(String, Class, String) but uses the column name as JSON path expression.
<T> JpaJsonValueNode<T>	valueColumn(String columnName, Class<T> 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.
<T> JpaJsonValueNode<T>	valueColumn(String columnName, JpaCastTarget<T> type)	Like valueColumn(String, Class, String) but uses the column name as JSON path expression.
<T> JpaJsonValueNode<T>	valueColumn(String columnName, JpaCastTarget<T> 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.

Method Details

existsColumn

JpaJsonExistsNode existsColumn(String columnName)

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

Returns:

The JpaJsonExistsNode for the column

existsColumn

JpaJsonExistsNode existsColumn(String columnName,
 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.

Returns:

The JpaJsonExistsNode for the column

queryColumn

JpaJsonQueryNode queryColumn(String columnName)

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

Returns:

The JpaJsonQueryNode for the column

queryColumn

JpaJsonQueryNode queryColumn(String columnName,
 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.

Returns:

The JpaJsonQueryNode for the column

valueColumn

<T> JpaJsonValueNode<T> valueColumn(String columnName,
 Class<T> type)

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

Returns:

The JpaJsonValueNode for the column

valueColumn

<T> JpaJsonValueNode<T> valueColumn(String columnName,
 Class<T> 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.

Returns:

The JpaJsonValueNode for the column

valueColumn

<T> JpaJsonValueNode<T> valueColumn(String columnName,
 JpaCastTarget<T> type)

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

Returns:

The JpaJsonValueNode for the column

valueColumn

<T> JpaJsonValueNode<T> valueColumn(String columnName,
 JpaCastTarget<T> 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.

Returns:

The JpaJsonValueNode for the column

nested

JpaJsonTableColumnsNode nested(String jsonPath)

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

Returns:

a new columns node for the nested JSON path

ordinalityColumn

JpaJsonTableColumnsNode ordinalityColumn(String columnName)

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.

Returns:

this for method chaining