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

Class SqmXmlTableFunction<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.SqmXmlTableFunction<T>

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaSetReturningFunction<T>, JpaXmlTableFunction, SqmNode, SqmVisitableNode

public class SqmXmlTableFunction<T>
extends SelfRenderingSqmSetReturningFunction<T>
implements JpaXmlTableFunction

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SqmXmlTableFunction.Columns

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	appendHqlString(StringBuilder sb)
SqmXmlTableFunction<T>	copy(SqmCopyContext context)
SqmXmlTableFunction<T>	ordinalityColumn(String columnName)	Defines a long column on the result type with the given name which is set to the ordinality i.e.
JpaXmlTableColumnNode<String>	queryColumn(String columnName)	Like JpaXmlTableFunction.queryColumn(String, String), but uses the column name as XPath expression.
JpaXmlTableColumnNode<String>	queryColumn(String columnName, @Nullable String xpath)	Defines a string column on the result type with the given name for which the value can be obtained by evaluating xmlquery with the given XPath expression on the XML document.
protected List<SqlAstNode>	resolveSqlAstArguments(List<? extends SqmTypedNode<?>> sqmArguments, SqmToSqlAstConverter walker)
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, Class<X> type)	Like JpaXmlTableFunction.valueColumn(String, Class, String) but uses the column name as XPath expression.
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, Class<X> type, String xpath)	Like JpaXmlTableFunction.valueColumn(String, JpaCastTarget, String), but converting the Class to JpaCastTarget via HibernateCriteriaBuilder.castTarget(Class).
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, JpaCastTarget<X> castTarget)	Like JpaXmlTableFunction.valueColumn(String, JpaCastTarget, String) but uses the column name as XPath expression.
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, JpaCastTarget<X> castTarget, @Nullable String xpath)	Defines an column on the result type with the given name and type for which the value can be obtained by the given XPath 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, getArguments, getFunctionDescriptor, getFunctionName

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

nodeBuilder

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

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

toHqlString

Constructor Details

SqmXmlTableFunction

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

Method Details

copy

public SqmXmlTableFunction<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>

queryColumn

public JpaXmlTableColumnNode<String> queryColumn(String columnName)

Description copied from interface: JpaXmlTableFunction

Like JpaXmlTableFunction.queryColumn(String, String), but uses the column name as XPath expression.

Specified by:

queryColumn in interface JpaXmlTableFunction

Returns:

The JpaXmlTableColumnNode for the column

queryColumn

public JpaXmlTableColumnNode<String> queryColumn(String columnName,
 @Nullable String xpath)

Description copied from interface: JpaXmlTableFunction

Defines a string column on the result type with the given name for which the value can be obtained by evaluating xmlquery with the given XPath expression on the XML document.

Specified by:

queryColumn in interface JpaXmlTableFunction

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

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

Description copied from interface: JpaXmlTableFunction

Like JpaXmlTableFunction.valueColumn(String, Class, String) but uses the column name as XPath expression.

Specified by:

valueColumn in interface JpaXmlTableFunction

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

public <X> JpaXmlTableColumnNode<X> valueColumn(String columnName,
 JpaCastTarget<X> castTarget)

Description copied from interface: JpaXmlTableFunction

Like JpaXmlTableFunction.valueColumn(String, JpaCastTarget, String) but uses the column name as XPath expression.

Specified by:

valueColumn in interface JpaXmlTableFunction

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

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

Description copied from interface: JpaXmlTableFunction

Like JpaXmlTableFunction.valueColumn(String, JpaCastTarget, String), but converting the Class to JpaCastTarget via HibernateCriteriaBuilder.castTarget(Class).

Specified by:

valueColumn in interface JpaXmlTableFunction

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

public <X> JpaXmlTableColumnNode<X> valueColumn(String columnName,
 JpaCastTarget<X> castTarget,
 @Nullable String xpath)

Description copied from interface: JpaXmlTableFunction

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

Specified by:

valueColumn in interface JpaXmlTableFunction

Returns:

The JpaXmlTableColumnNode for the column

ordinalityColumn

public SqmXmlTableFunction<T> ordinalityColumn(String columnName)

Description copied from interface: JpaXmlTableFunction

Defines a long 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 JpaXmlTableFunction

Returns:

this for method chaining

appendHqlString

public void appendHqlString(StringBuilder sb)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class SqmSetReturningFunction<T>