Top Description Inners Methods
org.hibernate.sql.ast.spi

public Interface SqlExpressionResolver

Known Direct Implementers
org.hibernate.query.results.DomainResultCreationStateImpl, org.hibernate.query.sqm.sql.BaseSqmToSqlAstConverter.DelegatingSqmAliasedNodeCollector, org.hibernate.query.sqm.sql.BaseSqmToSqlAstConverter.SqmAliasedNodePositionTracker, org.hibernate.query.sqm.sql.internal.SqlAstProcessingStateImpl
Imports
java.util.function.Function, org.hibernate.metamodel.mapping.JdbcMapping, .SelectableMapping, .SelectablePath, org.hibernate.sql.ast.tree.expression.ColumnReference, .Expression, org.hibernate.sql.ast.tree.from.TableReference, org.hibernate.sql.results.graph.FetchParent, org.hibernate.type.NullType, org.hibernate.type.descriptor.java.JavaType, org.hibernate.type.spi.TypeConfiguration
Resolution of a SqlSelection reference for a given SqlSelectable. Some SqlSelectable are required to be qualified (e.g. a Column) - this is indicated by the QualifiableSqlSelectable subtype. The NonQualifiableSqlSelectable subtype indicates a SqlSelectable that does not require qualification (e.g. a literal).

The point of this contract is to allow "unique-ing" of SqlSelectable references in a query to a single SqlSelection reference - effectively a caching of SqlSelection instances keyed by the SqlSelectable (+ qualifier when applicable) that it refers to.

Note also that the returns can be a specialized Expression represented by org.hibernate.sql.ast.tree.expression.SqlSelectionExpression

Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
SqlExpressionResolver.ColumnReferenceKey

Method Summary

Modifier and TypeMethod and Description
public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(String tableExpression, String columnExpression, JdbcMapping jdbcMapping)

Helper for generating an expression key for a column reference.

public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(TableReference tableReference, String columnExpression, JdbcMapping jdbcMapping)

Helper for generating an expression key for a column reference.

public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(TableReference tableReference, SelectablePath selectablePath, JdbcMapping jdbcMapping)

public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(String qualifier, SelectablePath selectablePath, JdbcMapping jdbcMapping)

public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(String columnExpression)

public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(String tableExpression, SelectableMapping selectable)

Convenience form for creating a key from table expression and SelectableMapping

public static SqlExpressionResolver.ColumnReferenceKey
createColumnReferenceKey(TableReference tableReference, SelectableMapping selectable)

Convenience form for creating a key from TableReference and SelectableMapping

public default Expression
resolveSqlExpression(TableReference tableReference, SelectableMapping selectableMapping)

public Expression
resolveSqlExpression(SqlExpressionResolver.ColumnReferenceKey key, Function<SqlAstProcessingState, Expression> creator)

Given a qualifier + a qualifiable org.hibernate.metamodel.mapping.SqlExpressible, resolve the (Sql)Expression reference.

public SqlSelection
resolveSqlSelection(Expression expression, JavaType<?> javaType, FetchParent fetchParent, TypeConfiguration typeConfiguration)

Resolve the SqlSelection for the given expression

Method Detail

createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(String tableExpression, String columnExpression, JdbcMapping jdbcMapping)

Helper for generating an expression key for a column reference.

See Also
resolveSqlExpression
createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(TableReference tableReference, String columnExpression, JdbcMapping jdbcMapping)

Helper for generating an expression key for a column reference.

See Also
resolveSqlExpression
createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(TableReference tableReference, SelectablePath selectablePath, JdbcMapping jdbcMapping)
createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(String qualifier, SelectablePath selectablePath, JdbcMapping jdbcMapping)
createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(String columnExpression)
createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(String tableExpression, SelectableMapping selectable)

Convenience form for creating a key from table expression and SelectableMapping

createColumnReferenceKeyback to summary
public static SqlExpressionResolver.ColumnReferenceKey createColumnReferenceKey(TableReference tableReference, SelectableMapping selectable)

Convenience form for creating a key from TableReference and SelectableMapping

resolveSqlExpressionback to summary
public default Expression resolveSqlExpression(TableReference tableReference, SelectableMapping selectableMapping)
resolveSqlExpressionback to summary
public Expression resolveSqlExpression(SqlExpressionResolver.ColumnReferenceKey key, Function<SqlAstProcessingState, Expression> creator)

Given a qualifier + a qualifiable org.hibernate.metamodel.mapping.SqlExpressible, resolve the (Sql)Expression reference.

resolveSqlSelectionback to summary
public SqlSelection resolveSqlSelection(Expression expression, JavaType<?> javaType, FetchParent fetchParent, TypeConfiguration typeConfiguration)

Resolve the SqlSelection for the given expression

org.hibernate.sql.ast.spi back to summary

public final Class SqlExpressionResolver.ColumnReferenceKey

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.sql.ast.spi.SqlExpressionResolver.ColumnReferenceKey

Field Summary

Modifier and TypeField and Description
private final JdbcMapping
jdbcMapping

private final SelectablePath
selectablePath

private final String
tableQualifier

Constructor Summary

AccessConstructor and Description
public
ColumnReferenceKey(String tableQualifier, SelectablePath selectablePath, JdbcMapping jdbcMapping)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

jdbcMappingback to summary
private final JdbcMapping jdbcMapping
selectablePathback to summary
private final SelectablePath selectablePath
tableQualifierback to summary
private final String tableQualifier

Constructor Detail

ColumnReferenceKeyback to summary
public ColumnReferenceKey(String tableQualifier, SelectablePath selectablePath, JdbcMapping jdbcMapping)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override