Class SqmJsonTableFunction.Columns

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

SqmJsonTableFunction<T>

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

Since:

7.0

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
Columns(SqmJsonTableFunction<?> table)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
int	cacheHashCode()
JsonTableColumnDefinition	convertToSqlAst(SqmToSqlAstConverter walker)
SqmJsonTableFunction.Columns	copy(SqmCopyContext context)
org.hibernate.query.sqm.tuple.internal.AnonymousTupleType<?>	createTupleType()
boolean	equals(Object object)
JpaJsonExistsNode	existsColumn(String columnName)	Like JpaJsonTableColumnsNode.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.
SqmBindableType<Object>	getNodeType()
int	hashCode()
boolean	isCompatible(Object object)
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, 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 Object

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

Methods inherited from interface SqmNode

asLoggableText

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

toHqlString

Constructor Details

Columns

public Columns(@Nonnull
 SqmJsonTableFunction<?> table)

Method Details

createTupleType

@Nonnull
public org.hibernate.query.sqm.tuple.internal.AnonymousTupleType<?> createTupleType()

copy

@Nonnull
public SqmJsonTableFunction.Columns copy(@Nonnull
 SqmCopyContext context)

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmTypedNode<Object>

populateTupleType

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

convertToSqlAst

@Nonnull
public JsonTableColumnDefinition convertToSqlAst(@Nonnull
 SqmToSqlAstConverter walker)

existsColumn

@Nonnull
public JpaJsonExistsNode existsColumn(@Nonnull
 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

@Nonnull
public JpaJsonExistsNode existsColumn(@Nonnull
 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

@Nonnull
public JpaJsonQueryNode queryColumn(@Nonnull
 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

@Nonnull
public JpaJsonQueryNode queryColumn(@Nonnull
 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

@Nonnull
public <X> JpaJsonValueNode<X> valueColumn(@Nonnull
 String columnName,
 @Nonnull
 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

@Nonnull
public <X> JpaJsonValueNode<X> valueColumn(@Nonnull
 String columnName,
 @Nonnull
 Class<X> type,
 @Nullable
 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

@Nonnull
public <X> JpaJsonValueNode<X> valueColumn(@Nonnull
 String columnName,
 @Nonnull
 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

@Nonnull
public <X> JpaJsonValueNode<X> valueColumn(@Nonnull
 String columnName,
 @Nonnull
 JpaCastTarget<X> type,
 @Nullable
 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

@Nonnull
public JpaJsonTableColumnsNode nested(@Nonnull
 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

@Nonnull
public JpaJsonTableColumnsNode ordinalityColumn(@Nonnull
 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

@Nullable
public <X> X accept(@Nonnull
 SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

getNodeType

@Nullable
public SqmBindableType<Object> getNodeType()

Specified by:

getNodeType in interface SqmTypedNode<Object>

nodeBuilder

@Nonnull
public NodeBuilder nodeBuilder()

Specified by:

nodeBuilder in interface SqmNode

appendHqlString

public void appendHqlString(@Nonnull
 StringBuilder hql,
 @Nonnull
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(@Nullable
 Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable