Package org.hibernate.query.criteria

Interface JpaXmlTableFunction

All Known Implementing Classes:

SqmXmlTableFunction

@Incubating
public interface JpaXmlTableFunction

A special expression for the xmltable function.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
JpaXmlTableFunction	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 queryColumn(String, String), but uses the column name as XPath expression.
JpaXmlTableColumnNode<String>	queryColumn(String columnName, 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.
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, Class<X> type)	Like valueColumn(String, Class, String) but uses the column name as XPath expression.
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, Class<X> type, String xpath)	Like valueColumn(String, JpaCastTarget, String), but converting the Class to JpaCastTarget via HibernateCriteriaBuilder.castTarget(Class).
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, JpaCastTarget<X> castTarget)	Like valueColumn(String, JpaCastTarget, String) but uses the column name as XPath expression.
<X> JpaXmlTableColumnNode<X>	valueColumn(String columnName, JpaCastTarget<X> castTarget, 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.

Method Details

queryColumn

JpaXmlTableColumnNode<String> queryColumn(String columnName)

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

Returns:

The JpaXmlTableColumnNode for the column

queryColumn

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

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

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

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

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

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

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

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

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

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

Returns:

The JpaXmlTableColumnNode for the column

valueColumn

<X> JpaXmlTableColumnNode<X> valueColumn(String columnName,
 JpaCastTarget<X> castTarget,
 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.

Returns:

The JpaXmlTableColumnNode for the column

ordinalityColumn

JpaXmlTableFunction ordinalityColumn(String columnName)

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.

Returns:

this for method chaining