Top Fields Constructors Methods
org.hibernate.query.spi

public abstract Class AbstractCommonQueryContract

extends Object
implements CommonQueryContract
Class Inheritance
All Implemented Interfaces
org.hibernate.query.CommonQueryContract
Known Direct Subclasses
org.hibernate.query.spi.AbstractSelectionQuery
Imports
java.time.Instant, java.util.Arrays, .Calendar, .Collection, .Date, .HashMap, .Map, .Set, org.hibernate.CacheMode, .FlushMode, .HibernateException, .LockMode, .LockOptions, .PropertyNotFoundException, org.hibernate.engine.spi.SharedSessionContractImplementor, org.hibernate.graph.GraphParser, .GraphSemantic, org.hibernate.graph.internal.RootGraphImpl, org.hibernate.graph.spi.AppliedGraph, .RootGraphImplementor, org.hibernate.jpa.internal.util.ConfigurationHelper, .FlushModeTypeHelper, org.hibernate.metamodel.RuntimeMetamodels, org.hibernate.metamodel.model.domain.JpaMetamodel, .ManagedDomainType, org.hibernate.property.access.spi.BuiltInPropertyAccessStrategies, .Getter, .PropertyAccess, org.hibernate.query.BindableType, .CommonQueryContract, .QueryLogging, .QueryParameter, .ResultListTransformer, .TupleTransformer, .TypedParameterValue, org.hibernate.query.criteria.JpaExpression, org.hibernate.query.internal.QueryOptionsImpl, org.hibernate.query.sqm.SqmExpressible, org.hibernate.query.sqm.tree.expression.SqmLiteral, .SqmParameter, org.hibernate.query.sqm.tree.select.SqmSelectStatement, org.hibernate.type.BasicType, org.hibernate.type.descriptor.java.JavaType, jakarta.persistence.CacheRetrieveMode, .CacheStoreMode, .EntityGraph, .FlushModeType, .LockModeType, .Parameter, .TemporalType
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final QueryOptionsImpl
queryOptions

private final SharedSessionContractImplementor
session

Constructor Summary

AccessConstructor and Description
public
AbstractCommonQueryContract(SharedSessionContractImplementor session)

Method Summary

Modifier and TypeMethod and Description
protected boolean
applyAdditionalPossibleHints(String hintName, Object value)

protected void
applyAliasSpecificLockModeHint(String hintName, Object value)

protected void
applyCacheableHint(boolean isCacheable)

protected void
applyCacheModeHint(CacheMode cacheMode)

protected void
applyCacheRegionHint(String regionName)

protected void
applyCommentHint(String comment)

protected void
applyEntityGraphHint(String hintName, Object value)

protected void
applyFetchSizeHint(int fetchSize)

public void
applyFirstResult(int startPosition)

protected void
applyFlushModeHint(FlushMode flushMode)

protected void
applyFollowOnLockingHint(Boolean followOnLocking)

protected void
applyGraph(String graphString, GraphSemantic graphSemantic)

protected void
applyGraph(RootGraphImplementor<?> entityGraph, GraphSemantic graphSemantic)

protected void
applyHibernateLockMode(LockMode value)

public final boolean
applyHint(String hintName, Object value)

protected boolean
applyJpaCacheRetrieveModeHint(CacheRetrieveMode retrieveMode)

protected boolean
applyJpaCacheStoreModeHint(CacheStoreMode storeMode)

protected void
applyJpaFlushMode(FlushModeType flushModeType)

private boolean
applyLockingHint(String hintName, Object value)

protected final void
applyLockModeHint(Object value)

protected void
applyLockModeType(LockModeType value)

protected void
applyLockTimeoutHint(Integer timeout)

protected void
applyLockTimeoutHint(int timeout)

public void
applyMaxResults(int maxResult)

protected void
applyQueryPlanCacheableHint(boolean isCacheable)

private void
applyReadOnlyHint(Boolean readOnly)

public boolean
applyResultListTransformer(ResultListTransformer<?> transformer)

protected final boolean
applySelectionHint(String hintName, Object value)

protected void
applySynchronizeSpacesHint(Object value)

protected void
applyTimeoutHint(int timeout)

public boolean
applyTupleTransformer(TupleTransformer<?> transformer)

protected void
collectHints(Map<String, Object> hints)

protected BindableType<Object>
determineType(String namedParam, Class<?> retType)

public String
getComment()

Implements org.hibernate.query.CommonQueryContract.getComment.

Get the comment that has been set for this query, if any.
public int
getFirstResult()

public FlushMode
getHibernateFlushMode()

Implements org.hibernate.query.CommonQueryContract.getHibernateFlushMode.

The FlushMode in effect for this query.
public Map<String, Object>
getHints()

protected int
getIntegerLiteral(JpaExpression<Number> expression, int defaultValue)

protected FlushModeType
getJpaFlushMode()

public int
getMaxResults()

protected int
getMaxRows(SqmSelectStatement<?> selectStatement, int size)

public QueryParameterImplementor<?>
getParameter(String name)

public <T> QueryParameterImplementor<T>
getParameter(String name, Class<T> type)

public QueryParameterImplementor<?>
getParameter(int position)

public <T> QueryParameterImplementor<T>
getParameter(int position, Class<T> type)

protected abstract ParameterMetadataImplementor
getParameterMetadata()

public Set<Parameter<?>>
getParameters()

public <T> T
getParameterValue(Parameter<T> param)

public Object
getParameterValue(String name)

public Object
getParameterValue(int position)

public MutableQueryOptions
getQueryOptions()

protected abstract QueryParameterBindings
getQueryParameterBindings()

public SharedSessionContractImplementor
getSession()

public Integer
getTimeout()

Implements org.hibernate.query.CommonQueryContract.getTimeout.

Obtain the query timeout in seconds.
public boolean
isBound(Parameter<?> param)

private boolean
isInstance(BindableType<?> parameterType, Object value)

private boolean
isRegisteredAsBasicType(Class<?> valueClass)

protected <P> QueryParameterBinding<P>
locateBinding(Parameter<P> parameter)

protected <P> QueryParameterBinding<P>
locateBinding(QueryParameterImplementor<P> parameter)

protected <P> QueryParameterBinding<P>
locateBinding(String name)

protected <P> QueryParameterBinding<P>
locateBinding(int position)

protected void
putIfNotNull(Map<String, Object> hints, String hintName, Enum<?> hintValue)

protected void
putIfNotNull(Map<String, Object> hints, String hintName, Object hintValue)

protected abstract boolean
resolveJdbcParameterTypeIfNecessary()

public CommonQueryContract
setComment(String comment)

Implements org.hibernate.query.CommonQueryContract.setComment.

Set a comment for this query.
public CommonQueryContract
setHibernateFlushMode(FlushMode flushMode)

Implements org.hibernate.query.CommonQueryContract.setHibernateFlushMode.

Set the current FlushMode in effect for this query.
public CommonQueryContract
setHint(String hintName, Object value)

Implements org.hibernate.query.CommonQueryContract.setHint.

Set a hint.
public CommonQueryContract
setParameter(String name, Object value)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind the given argument to a named query parameter.
public <P> CommonQueryContract
setParameter(String name, P value, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the BindableType.
public <P> CommonQueryContract
setParameter(String name, P value, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind the given argument to a named query parameter using the given BindableType.
public CommonQueryContract
setParameter(String name, Instant value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.
public CommonQueryContract
setParameter(int position, Object value)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind the given argument to an ordinal query parameter.
public <P> CommonQueryContract
setParameter(int position, P value, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
public <P> CommonQueryContract
setParameter(int position, P value, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind the given argument to an ordinal query parameter using the given BindableType.
public CommonQueryContract
setParameter(int position, Instant value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.
public <P> CommonQueryContract
setParameter(QueryParameter<P>
the query parameter memento
parameter, P
the argument, which might be null
value)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind an argument to the query parameter represented by the given QueryParameter.
public <P> CommonQueryContract
setParameter(QueryParameter<P>
the query parameter memento
parameter, P
the argument, which might be null
value, Class<P>
a BindableType representing the type of the parameter
javaType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the BindableType to use.
public <P> CommonQueryContract
setParameter(QueryParameter<P>
the query parameter memento
parameter, P
the argument, which might be null
value, BindableType<P>
a BindableType representing the type of the parameter
type)

Implements org.hibernate.query.CommonQueryContract.setParameter.

Bind an argument to the query parameter represented by the given QueryParameter, using the given BindableType.
public <P> CommonQueryContract
setParameter(Parameter<P> parameter, P value)

Implements org.hibernate.query.CommonQueryContract.setParameter.

private <P> void
setParameter(Parameter<P> parameter, P value, BindableType<P> type)

public CommonQueryContract
setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

public CommonQueryContract
setParameter(Parameter<Date> param, Date value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

public CommonQueryContract
setParameter(String name, Calendar value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

public CommonQueryContract
setParameter(String name, Date value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

public CommonQueryContract
setParameter(int position, Calendar value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

public CommonQueryContract
setParameter(int position, Date value, TemporalType temporalType)

Implements org.hibernate.query.CommonQueryContract.setParameter.

public CommonQueryContract
setParameterList(String name, Collection<E> values)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to a named query parameter.
public <P> CommonQueryContract
setParameterList(String name, Collection<? extends P> values, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the BindableType If unable to infer an appropriate BindableType, fall back to setParameterList(String, Collection).
public <P> CommonQueryContract
setParameterList(String name, Collection<? extends P> values, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to a named query parameter using the given BindableType.
public CommonQueryContract
setParameterList(String name, Object[] values)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to a named query parameter.
public <P> CommonQueryContract
setParameterList(String name, P[] values, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the BindableType to use.
public <P> CommonQueryContract
setParameterList(String name, P[] values, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to a named query parameter using the given BindableType.
public CommonQueryContract
setParameterList(int position, Collection<E> values)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to an ordinal query parameter.
public <P> CommonQueryContract
setParameterList(int position, Collection<? extends P> values, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
public <P> CommonQueryContract
setParameterList(int position, Collection<? extends P> values, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given BindableType.
public CommonQueryContract
setParameterList(int position, Object[] values)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to an ordinal query parameter.
public <P> CommonQueryContract
setParameterList(int position, P[] values, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
public <P> CommonQueryContract
setParameterList(int position, P[] values, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to an ordinal query parameter using the given BindableType.
public <P> CommonQueryContract
setParameterList(QueryParameter<P>
the parameter memento
parameter, Collection<? extends P>
a collection of arguments
values)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter.
public <P> CommonQueryContract
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use.
public <P> CommonQueryContract
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given BindableType.
public <P> CommonQueryContract
setParameterList(QueryParameter<P>
the parameter memento
parameter, P[]
a collection of arguments
values)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter.
public <P> CommonQueryContract
setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use.
public <P> CommonQueryContract
setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)

Implements org.hibernate.query.CommonQueryContract.setParameterList.

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the BindableType.
public CommonQueryContract
setProperties(Map<K, V>
a Map of names to arguments
map)

Implements org.hibernate.query.CommonQueryContract.setProperties.

Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
public CommonQueryContract
setProperties(Object
any JavaBean or POJO
bean)

Implements org.hibernate.query.CommonQueryContract.setProperties.

Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
public CommonQueryContract
setTimeout(int
the timeout in seconds
timeout)

Implements org.hibernate.query.CommonQueryContract.setTimeout.

Set the query timeout in seconds.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait