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

Class SqmJsonTableFunction.Columns

java.lang.Object

org.hibernate.query.sqm.tree.expression.SqmJsonTableFunction.Columns

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaJsonTableColumnsNode, SqmExpressibleAccessor<Object>, SqmNode, SqmTypedNode<Object>, SqmVisitableNode

Enclosing class:

SqmJsonTableFunction<T>

public static final class SqmJsonTableFunction.Columns
extends Object
implements SqmTypedNode<Object>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final ArrayList<org.hibernate.query.sqm.tree.expression.SqmJsonTableFunction.ColumnDefinition>	columnDefinitions
protected final String	jsonPath
protected final SqmJsonTableFunction<?>	table

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

log

Constructor Summary

Constructors

Constructor	Description
Columns(SqmJsonTableFunction<?> table)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
JsonTableColumnDefinition	convertToSqlAst(SqmToSqlAstConverter walker)
SqmJsonTableFunction.Columns	copy(SqmCopyContext context)
AnonymousTupleType<?>	createTupleType()
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.
@Nullable SqmBindableType<Object>	getNodeType()
JpaJsonTableColumnsNode	nested(String jsonPath)	Defines nested columns that are accessible by the given JSON path.
NodeBuilder	nodeBuilder()
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.
int	populateTupleType(int offset, String[] componentNames, SqmExpressible<?>[] componentTypes)
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.
<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 java.lang.Object

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

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

asLoggableText

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

getExpressible, getNodeJavaType

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

accept, toHqlString

Field Details

jsonPath

protected final String jsonPath

table

protected final SqmJsonTableFunction<?> table

columnDefinitions

protected final ArrayList<org.hibernate.query.sqm.tree.expression.SqmJsonTableFunction.ColumnDefinition> columnDefinitions

Constructor Details

Columns

public Columns(SqmJsonTableFunction<?> table)

Method Details

createTupleType

public AnonymousTupleType<?> createTupleType()

copy

public SqmJsonTableFunction.Columns copy(SqmCopyContext context)

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmTypedNode<Object>

getNodeType

public @Nullable SqmBindableType<Object> getNodeType()

Specified by:

getNodeType in interface SqmTypedNode<Object>

nodeBuilder

public NodeBuilder nodeBuilder()

Specified by:

nodeBuilder in interface SqmNode

appendHqlString

public void appendHqlString(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

populateTupleType

public int populateTupleType(int offset,
 String[] componentNames,
 SqmExpressible<?>[] componentTypes)

convertToSqlAst

public JsonTableColumnDefinition convertToSqlAst(SqmToSqlAstConverter walker)

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)

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,
 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

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 JpaJsonTableColumnsNode 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

Returns:

this for method chaining

accept

public <X> X accept(SemanticQueryWalker<X> walker)