Package org.hibernate.dialect.function.xml

Class XmlTableFunction

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmSetReturningFunctionDescriptor

org.hibernate.query.sqm.function.AbstractSqmSelfRenderingSetReturningFunctionDescriptor

org.hibernate.dialect.function.xml.XmlTableFunction

All Implemented Interfaces:

SetReturningFunctionRenderer, SqmSetReturningFunctionDescriptor

Direct Known Subclasses:

DB2XmlTableFunction, HANAXmlTableFunction, OracleXmlTableFunction, SQLServerXmlTableFunction, SybaseASEXmlTableFunction

public class XmlTableFunction
extends AbstractSqmSelfRenderingSetReturningFunctionDescriptor

Standard xmltable function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	XmlTableFunction.XmlTableArguments

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	supportsParametersInDefault

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlTableFunction(boolean supportsParametersInDefault, SetReturningFunctionTypeResolver setReturningFunctionTypeResolver, TypeConfiguration typeConfiguration)
	XmlTableFunction(boolean supportsParametersInDefault, TypeConfiguration typeConfiguration)

Method Summary

Modifier and Type	Method	Description
protected String	determineColumnType(CastTarget castTarget, SqlAstTranslator<?> walker)
protected static String	determineColumnType(CastTarget castTarget, TypeConfiguration typeConfiguration)
protected <T> SelfRenderingSqmSetReturningFunction<T>	generateSqmSetReturningFunctionExpression(List<? extends SqmTypedNode<?>> arguments, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this function with the given arguments.
void	render(SqlAppender sqlAppender, List<? extends SqlAstNode> sqlAstArguments, AnonymousTupleTableGroupProducer tupleType, String tableIdentifierVariable, SqlAstTranslator<?> walker)
protected void	renderColumnPath(String name, @Nullable String xpath, SqlAppender sqlAppender, SqlAstTranslator<?> walker)
protected void	renderColumns(SqlAppender sqlAppender, XmlTableColumnsClause xmlTableColumnsClause, SqlAstTranslator<?> walker)
protected void	renderDefaultExpression(@Nullable Expression expression, SqlAppender sqlAppender, SqlAstTranslator<?> walker)
protected void	renderXmlOrdinalityColumnDefinition(SqlAppender sqlAppender, XmlTableOrdinalityColumnDefinition definition, SqlAstTranslator<?> walker)
protected void	renderXmlQueryColumnDefinition(SqlAppender sqlAppender, XmlTableQueryColumnDefinition definition, SqlAstTranslator<?> walker)
protected void	renderXmlTable(SqlAppender sqlAppender, XmlTableFunction.XmlTableArguments arguments, AnonymousTupleTableGroupProducer tupleType, String tableIdentifierVariable, SqlAstTranslator<?> walker)
protected void	renderXmlValueColumnDefinition(SqlAppender sqlAppender, XmlTableValueColumnDefinition definition, SqlAstTranslator<?> walker)

Methods inherited from class org.hibernate.query.sqm.function.AbstractSqmSetReturningFunctionDescriptor

generateSqmExpression, getArgumentListSignature, getArgumentsValidator, getArgumentTypeResolver, getName, getSetReturningTypeResolver, getSignature

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.function.SetReturningFunctionRenderer

rendersIdentifierVariable

Field Details

supportsParametersInDefault

protected final boolean supportsParametersInDefault

Constructor Details

XmlTableFunction

public XmlTableFunction(boolean supportsParametersInDefault,
 TypeConfiguration typeConfiguration)

XmlTableFunction

protected XmlTableFunction(boolean supportsParametersInDefault,
 SetReturningFunctionTypeResolver setReturningFunctionTypeResolver,
 TypeConfiguration typeConfiguration)

Method Details

generateSqmSetReturningFunctionExpression

protected <T>
SelfRenderingSqmSetReturningFunction<T> generateSqmSetReturningFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 QueryEngine queryEngine)

Description copied from class: AbstractSqmSetReturningFunctionDescriptor

Return an SQM node or subtree representing an invocation of this function with the given arguments. This method may be overridden in the case of function descriptors that wish to customize creation of the node.

Overrides:

generateSqmSetReturningFunctionExpression in class AbstractSqmSelfRenderingSetReturningFunctionDescriptor

Parameters:

arguments - the arguments of the function invocation

render

public void render(SqlAppender sqlAppender,
 List<? extends SqlAstNode> sqlAstArguments,
 AnonymousTupleTableGroupProducer tupleType,
 String tableIdentifierVariable,
 SqlAstTranslator<?> walker)

renderXmlTable

protected void renderXmlTable(SqlAppender sqlAppender,
 XmlTableFunction.XmlTableArguments arguments,
 AnonymousTupleTableGroupProducer tupleType,
 String tableIdentifierVariable,
 SqlAstTranslator<?> walker)

determineColumnType

protected String determineColumnType(CastTarget castTarget,
 SqlAstTranslator<?> walker)

determineColumnType

protected static String determineColumnType(CastTarget castTarget,
 TypeConfiguration typeConfiguration)

renderColumns

protected void renderColumns(SqlAppender sqlAppender,
 XmlTableColumnsClause xmlTableColumnsClause,
 SqlAstTranslator<?> walker)

renderXmlOrdinalityColumnDefinition

protected void renderXmlOrdinalityColumnDefinition(SqlAppender sqlAppender,
 XmlTableOrdinalityColumnDefinition definition,
 SqlAstTranslator<?> walker)

renderXmlValueColumnDefinition

protected void renderXmlValueColumnDefinition(SqlAppender sqlAppender,
 XmlTableValueColumnDefinition definition,
 SqlAstTranslator<?> walker)

renderColumnPath

protected void renderColumnPath(String name,
 @Nullable String xpath,
 SqlAppender sqlAppender,
 SqlAstTranslator<?> walker)

renderDefaultExpression

protected void renderDefaultExpression(@Nullable Expression expression,
 SqlAppender sqlAppender,
 SqlAstTranslator<?> walker)

renderXmlQueryColumnDefinition

protected void renderXmlQueryColumnDefinition(SqlAppender sqlAppender,
 XmlTableQueryColumnDefinition definition,
 SqlAstTranslator<?> walker)