Package org.hibernate.query.sqm.function

Class SelfRenderingFunctionSqlAstExpression

java.lang.Object

org.hibernate.query.sqm.function.SelfRenderingFunctionSqlAstExpression

All Implemented Interfaces:

Selectable, JdbcMappingContainer, SqlExpressible, DomainResultProducer, SqlSelectionProducer, Expression, FunctionExpression, SelfRenderingExpression, SqlAstNode

Direct Known Subclasses:

SelfRenderingAggregateFunctionSqlAstExpression, SelfRenderingWindowFunctionSqlAstExpression

public class SelfRenderingFunctionSqlAstExpression
extends Object
implements SelfRenderingExpression, Selectable, SqlExpressible, DomainResultProducer, FunctionExpression

Representation of a function call in the SQL AST for impls that know how to render themselves.

Constructor Summary

Constructors

Constructor	Description
SelfRenderingFunctionSqlAstExpression(String functionName, FunctionRenderer renderer, List<? extends SqlAstNode> sqlAstArguments, @Nullable ReturnableType<?> type, @Nullable JdbcMappingContainer expressible)
SelfRenderingFunctionSqlAstExpression(String functionName, FunctionRenderingSupport renderer, List<? extends SqlAstNode> sqlAstArguments, @Nullable ReturnableType<?> type, @Nullable JdbcMappingContainer expressible)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelfRenderingFunctionSqlAstExpression(String, FunctionRenderer, List, ReturnableType, JdbcMappingContainer) instead

Method Summary

Modifier and Type	Method	Description
void	applySqlSelections(DomainResultCreationState creationState)	Used when this producer is a selection in a sub-query.
DomainResult<?>	createDomainResult(String resultVariable, DomainResultCreationState creationState)	Produce the domain query
SqlSelection	createSqlSelection(int jdbcPosition, int valuesArrayPosition, JavaType javaType, boolean virtual, TypeConfiguration typeConfiguration)	Create a SqlSelection for the given JDBC ResultSet position
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
String	getAlias(Dialect dialect)
String	getAlias(Dialect dialect, Table table)
List<? extends SqlAstNode>	getArguments()
String	getCustomReadExpression()	Any custom read expression for this selectable.
String	getCustomWriteExpression()	Any custom write expression for this selectable.
JdbcMappingContainer	getExpressionType()	The type for this expression
String	getFunctionName()
protected FunctionRenderer	getFunctionRenderer()
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
protected FunctionRenderingSupport	getRenderer()	Deprecated, for removal: This API element is subject to removal in a future version. Use getFunctionRenderer() instead
String	getTemplate(Dialect dialect, TypeConfiguration typeConfiguration, SqmFunctionRegistry registry)
String	getText()	The selectable's "canonical" text representation
String	getText(Dialect dialect)	The selectable's text representation accounting for the Dialect's quoting, if quoted
protected @Nullable ReturnableType<?>	getType()
boolean	isFormula()	Does this selectable represent a formula? true indicates it is a formula; false indicates it is a physical column
void	renderToSql(SqlAppender sqlAppender, SqlAstTranslator<?> walker, SessionFactoryImplementor sessionFactory)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.sql.ast.tree.expression.Expression

createDomainResultSqlSelection, getColumnReference

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMappingContainer

forEachJdbcType, getJdbcTypeCount, getSingleJdbcMapping

Methods inherited from interface org.hibernate.mapping.Selectable

getWriteExpr, getWriteExpr

Methods inherited from interface org.hibernate.sql.ast.tree.expression.SelfRenderingExpression

accept

Methods inherited from interface org.hibernate.metamodel.mapping.SqlExpressible

getJdbcMapping

Constructor Detail

SelfRenderingFunctionSqlAstExpression

@Deprecated(forRemoval=true)
public SelfRenderingFunctionSqlAstExpression(String functionName,
                                             FunctionRenderingSupport renderer,
                                             List<? extends SqlAstNode> sqlAstArguments,
                                             @Nullable ReturnableType<?> type,
                                             @Nullable JdbcMappingContainer expressible)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelfRenderingFunctionSqlAstExpression(String, FunctionRenderer, List, ReturnableType, JdbcMappingContainer) instead

SelfRenderingFunctionSqlAstExpression

public SelfRenderingFunctionSqlAstExpression(String functionName,
                                             FunctionRenderer renderer,
                                             List<? extends SqlAstNode> sqlAstArguments,
                                             @Nullable ReturnableType<?> type,
                                             @Nullable JdbcMappingContainer expressible)

Method Detail

getFunctionName

public String getFunctionName()

Specified by:

getFunctionName in interface FunctionExpression

getArguments

public List<? extends SqlAstNode> getArguments()

Specified by:

getArguments in interface FunctionExpression

getExpressionType

public JdbcMappingContainer getExpressionType()

Description copied from interface: Expression

The type for this expression

Specified by:

getExpressionType in interface Expression

getRenderer

@Deprecated(forRemoval=true)
protected FunctionRenderingSupport getRenderer()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getFunctionRenderer() instead

getFunctionRenderer

protected FunctionRenderer getFunctionRenderer()

getType

protected @Nullable ReturnableType<?> getType()

createSqlSelection

public SqlSelection createSqlSelection(int jdbcPosition,
                                       int valuesArrayPosition,
                                       JavaType javaType,
                                       boolean virtual,
                                       TypeConfiguration typeConfiguration)

Description copied from interface: SqlSelectionProducer

Create a SqlSelection for the given JDBC ResultSet position

Specified by:

createSqlSelection in interface Expression

Specified by:

createSqlSelection in interface SqlSelectionProducer

Parameters:

jdbcPosition - The index position used to read values from JDBC

valuesArrayPosition - The position in our "current JDBC values array"

javaType - The descriptor for the Java type to read the value as

virtual - Whether the select is virtual or real. See SqlSelection.isVirtual()

typeConfiguration - The associated TypeConfiguration

createDomainResult

public DomainResult<?> createDomainResult(String resultVariable,
                                          DomainResultCreationState creationState)

Description copied from interface: DomainResultProducer

Produce the domain query

Specified by:

createDomainResult in interface DomainResultProducer

renderToSql

public void renderToSql(SqlAppender sqlAppender,
                        SqlAstTranslator<?> walker,
                        SessionFactoryImplementor sessionFactory)

Specified by:

renderToSql in interface SelfRenderingExpression

getAlias

public String getAlias(Dialect dialect)

Specified by:

getAlias in interface Selectable

getAlias

public String getAlias(Dialect dialect,
                       Table table)

Specified by:

getAlias in interface Selectable

isFormula

public boolean isFormula()

Description copied from interface: Selectable

Does this selectable represent a formula? true indicates it is a formula; false indicates it is a physical column

Specified by:

isFormula in interface Selectable

getTemplate

public String getTemplate(Dialect dialect,
                          TypeConfiguration typeConfiguration,
                          SqmFunctionRegistry registry)

Specified by:

getTemplate in interface Selectable

getText

public String getText(Dialect dialect)

Description copied from interface: Selectable

The selectable's text representation accounting for the Dialect's quoting, if quoted

Specified by:

getText in interface Selectable

getText

public String getText()

Description copied from interface: Selectable

The selectable's "canonical" text representation

Specified by:

getText in interface Selectable

getCustomReadExpression

public String getCustomReadExpression()

Description copied from interface: Selectable

Any custom read expression for this selectable. Only pertinent for physical columns (not formulas)

Specified by:

getCustomReadExpression in interface Selectable

See Also:

ColumnTransformer

getCustomWriteExpression

public String getCustomWriteExpression()

Description copied from interface: Selectable

Any custom write expression for this selectable. Only pertinent for physical columns (not formulas)

Specified by:

getCustomWriteExpression in interface Selectable

See Also:

ColumnTransformer

getJdbcMapping

public JdbcMapping getJdbcMapping()

Description copied from interface: SqlExpressible

Anything that is expressible at the SQL AST level would be of basic type.

Specified by:

getJdbcMapping in interface SqlExpressible

applySqlSelections

public void applySqlSelections(DomainResultCreationState creationState)

Description copied from interface: DomainResultProducer

Used when this producer is a selection in a sub-query. The DomainResult is only needed for root query of a SELECT statement. This default impl assumes this producer is a true (Sql)Expression

Specified by:

applySqlSelections in interface DomainResultProducer

forEachJdbcType

public int forEachJdbcType(int offset,
                           IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface JdbcMappingContainer