Package org.hibernate.query.sqm.internal

Class SqmUtil

java.lang.Object

org.hibernate.query.sqm.internal.SqmUtil

public class SqmUtil
extends Object

Helper utilities for dealing with SQM

Method Summary

Modifier and Type	Method	Description
static void	checkQueryReturnType(SqmQueryPart<?> queryPart, Class<?> expectedResultType)	Similar to validateQueryReturnType(SqmQueryPart, Class) but does not check if isResultTypeAlwaysAllowed(Class).
static JdbcParameterBindings	createJdbcParameterBindings(QueryParameterBindings domainParamBindings, DomainParameterXref domainParameterXref, Map<QueryParameterImplementor<?>,Map<SqmParameter<?>,List<JdbcParametersList>>> jdbcParamXref, SqmParameterMappingModelResolutionAccess mappingModelResolutionAccess, SharedSessionContractImplementor session)
static @Nullable String	determineAffectedTableName(TableGroup tableGroup, ValuedModelPart mapping)
static Bindable	determineParameterType(QueryParameterBinding<?> binding, QueryParameterImplementor<?> parameter, List<? extends SqmParameter<?>> sqmParameters, SqmParameterMappingModelResolutionAccess mappingModelResolutionAccess, SessionFactoryImplementor sessionFactory)
static IllegalQueryOperationException	expectingNonSelect(SqmStatement<?> sqm, String hqlString)
static <T, A> SqmAttributeJoin<T,A>	findCompatibleFetchJoin(SqmFrom<?,T> sqmFrom, SqmPathSource<A> pathSource, SqmJoinType requestedJoinType)
static Map<QueryParameterImplementor<?>,Map<SqmParameter<?>,List<JdbcParametersList>>>	generateJdbcParamsXref(DomainParameterXref domainParameterXref, JdbcParameterBySqmParameterAccess jdbcParameterBySqmParameterAccess)
static List<NavigablePath>	getGroupByNavigablePaths(SqmQuerySpec<?> querySpec)
static List<NavigablePath>	getOrderByNavigablePaths(SqmQuerySpec<?> querySpec)
static Set<ParameterExpression<?>>	getParameters(SqmStatement<?> statement)
static ModelPartContainer	getTargetMappingIfNeeded(SqmPath<?> sqmPath, ModelPartContainer modelPartContainer, SqmToSqlAstConverter sqlAstCreationState)	Utility that returns the entity association target's mapping type if the specified sqmPath should be dereferenced using the target table, i.e.
static List<NavigablePath>	getWhereClauseNavigablePaths(SqmQuerySpec<?> querySpec)
static boolean	isFkOptimizationAllowed(SqmPath<?> sqmPath)	Deprecated, for removal: This API element is subject to removal in a future version. Use isFkOptimizationAllowed(SqmPath, EntityAssociationMapping) instead
static boolean	isFkOptimizationAllowed(SqmPath<?> sqmPath, EntityAssociationMapping associationMapping)	Utility that returns false when the provided sqmPath is a join that cannot be dereferenced through the foreign key on the associated table, i.e.
static boolean	isHqlTuple(SqmSelection<?> selection)
static boolean	isMutation(SqmStatement<?> sqm)
static <T> boolean	isRestrictedMutation(SqmStatement<T> sqmStatement)
static boolean	isResultTypeAlwaysAllowed(Class<?> expectedResultClass)	Any query result can be represented as a Tuple, List, or Map, simply by repackaging the result tuple.
static boolean	isSelect(SqmStatement<?> sqm)
static boolean	isSelectionAssignableToResultType(SqmSelection<?> selection, Class<?> expectedResultType)
static Class<?>	resolveExpressibleJavaTypeClass(SqmExpression<?> expression)
static SqmStatement.ParameterResolutions	resolveParameters(SqmStatement<?> statement)
static <X> SqmPredicate	restriction(SqmSelectStatement<X> sqmStatement, Class<X> resultType, Restriction<? super X> restriction)
static SqmSortSpecification	sortSpecification(SqmSelectStatement<?> sqm, Order<?> order)
static void	validateCriteriaQuery(SqmQueryPart<?> queryPart)
static void	validateQueryReturnType(SqmQueryPart<?> queryPart, @Nullable Class<?> expectedResultType)	Used to validate that the specified query return type is valid (i.e.
static void	verifyIsNonSelectStatement(SqmStatement<?> sqm, String hqlString)
static void	verifyIsRestrictedMutation(SqmStatement<?> sqm, String hqlString)
static void	verifyIsSelectStatement(SqmStatement<?> sqm, String hqlString)
protected static void	verifyResultType(Class<?> resultClass, SqmSelectableNode<?> selectableNode)

Methods inherited from class java.lang.Object

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

Method Details

isSelect

public static boolean isSelect(SqmStatement<?> sqm)

isMutation

public static boolean isMutation(SqmStatement<?> sqm)

isRestrictedMutation

public static <T> boolean isRestrictedMutation(SqmStatement<T> sqmStatement)

verifyIsSelectStatement

public static void verifyIsSelectStatement(SqmStatement<?> sqm,
 String hqlString)

verifyIsNonSelectStatement

public static void verifyIsNonSelectStatement(SqmStatement<?> sqm,
 String hqlString)

expectingNonSelect

public static IllegalQueryOperationException expectingNonSelect(SqmStatement<?> sqm,
 String hqlString)

verifyIsRestrictedMutation

public static void verifyIsRestrictedMutation(SqmStatement<?> sqm,
 String hqlString)

determineAffectedTableName

public static @Nullable String determineAffectedTableName(TableGroup tableGroup,
 ValuedModelPart mapping)

getTargetMappingIfNeeded

public static ModelPartContainer getTargetMappingIfNeeded(SqmPath<?> sqmPath,
 ModelPartContainer modelPartContainer,
 SqmToSqlAstConverter sqlAstCreationState)

Utility that returns the entity association target's mapping type if the specified sqmPath should be dereferenced using the target table, i.e. when the path's lhs is an explicit join that is used in the group by clause, or defaults to the provided modelPartContainer otherwise.

isFkOptimizationAllowed

@Deprecated(forRemoval=true,
            since="6.6.1")
public static boolean isFkOptimizationAllowed(SqmPath<?> sqmPath)

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

Use isFkOptimizationAllowed(SqmPath, EntityAssociationMapping) instead

Utility that returns false when the provided sqmPath is a join that cannot be dereferenced through the foreign key on the associated table, i.e. a join that's neither SqmJoinType.INNER nor SqmJoinType.LEFT or one that has an explicit on clause predicate.

isFkOptimizationAllowed

public static boolean isFkOptimizationAllowed(SqmPath<?> sqmPath,
 EntityAssociationMapping associationMapping)

Utility that returns false when the provided sqmPath is a join that cannot be dereferenced through the foreign key on the associated table, i.e. a join that's neither SqmJoinType.INNER nor SqmJoinType.LEFT or one that has an explicit on clause predicate.

getWhereClauseNavigablePaths

public static List<NavigablePath> getWhereClauseNavigablePaths(SqmQuerySpec<?> querySpec)

getGroupByNavigablePaths

public static List<NavigablePath> getGroupByNavigablePaths(SqmQuerySpec<?> querySpec)

getOrderByNavigablePaths

public static List<NavigablePath> getOrderByNavigablePaths(SqmQuerySpec<?> querySpec)

findCompatibleFetchJoin

public static <T,
A> SqmAttributeJoin<T,A> findCompatibleFetchJoin(SqmFrom<?,T> sqmFrom,
 SqmPathSource<A> pathSource,
 SqmJoinType requestedJoinType)

generateJdbcParamsXref

public static Map<QueryParameterImplementor<?>,Map<SqmParameter<?>,List<JdbcParametersList>>> generateJdbcParamsXref(DomainParameterXref domainParameterXref,
 JdbcParameterBySqmParameterAccess jdbcParameterBySqmParameterAccess)

createJdbcParameterBindings

public static JdbcParameterBindings createJdbcParameterBindings(QueryParameterBindings domainParamBindings,
 DomainParameterXref domainParameterXref,
 Map<QueryParameterImplementor<?>,Map<SqmParameter<?>,List<JdbcParametersList>>> jdbcParamXref,
 SqmParameterMappingModelResolutionAccess mappingModelResolutionAccess,
 SharedSessionContractImplementor session)

determineParameterType

public static Bindable determineParameterType(QueryParameterBinding<?> binding,
 QueryParameterImplementor<?> parameter,
 List<? extends SqmParameter<?>> sqmParameters,
 SqmParameterMappingModelResolutionAccess mappingModelResolutionAccess,
 SessionFactoryImplementor sessionFactory)

resolveParameters

public static SqmStatement.ParameterResolutions resolveParameters(SqmStatement<?> statement)

sortSpecification

public static SqmSortSpecification sortSpecification(SqmSelectStatement<?> sqm,
 Order<?> order)

isSelectionAssignableToResultType

public static boolean isSelectionAssignableToResultType(SqmSelection<?> selection,
 Class<?> expectedResultType)

isHqlTuple

public static boolean isHqlTuple(SqmSelection<?> selection)

resolveExpressibleJavaTypeClass

public static Class<?> resolveExpressibleJavaTypeClass(SqmExpression<?> expression)

restriction

public static <X> SqmPredicate restriction(SqmSelectStatement<X> sqmStatement,
 Class<X> resultType,
 Restriction<? super X> restriction)

validateCriteriaQuery

public static void validateCriteriaQuery(SqmQueryPart<?> queryPart)

validateQueryReturnType

public static void validateQueryReturnType(SqmQueryPart<?> queryPart,
 @Nullable Class<?> expectedResultType)

Used to validate that the specified query return type is valid (i.e. the user did not pass Integer.class when the selection is an entity)

checkQueryReturnType

public static void checkQueryReturnType(SqmQueryPart<?> queryPart,
 Class<?> expectedResultType)

Similar to validateQueryReturnType(SqmQueryPart, Class) but does not check if isResultTypeAlwaysAllowed(Class).

isResultTypeAlwaysAllowed

public static boolean isResultTypeAlwaysAllowed(Class<?> expectedResultClass)

Any query result can be represented as a Tuple, List, or Map, simply by repackaging the result tuple. Also, any query result is assignable to Object, or can be returned as an instance of Object[].

See Also:

• ConcreteSqmSelectQueryPlan.determineRowTransformer(org.hibernate.query.sqm.tree.select.SqmSelectStatement<?>, java.lang.Class<T>, org.hibernate.sql.results.internal.TupleMetadata, org.hibernate.query.spi.QueryOptions)
• NativeQueryImpl.determineTupleTransformerForResultType(java.lang.Class<?>)

verifyResultType

protected static void verifyResultType(Class<?> resultClass,
 SqmSelectableNode<?> selectableNode)

getParameters

public static Set<ParameterExpression<?>> getParameters(SqmStatement<?> statement)