Package org.hibernate.query.sql.internal

Class NativeQueryImpl<R>

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

org.hibernate.query.spi.AbstractSelectionQuery<R>

org.hibernate.query.spi.AbstractQuery<R>

org.hibernate.query.sql.internal.NativeQueryImpl<R>

All Implemented Interfaces:

Query, TypedQuery<R>, CommonQueryContract, ResultSetMappingResolutionContext, MutationQuery, NameableQuery, NativeQuery<R>, Query<R>, SelectionQuery<R>, DomainQueryExecutionContext, QueryImplementor<R>, NativeQueryImplementor<R>, SynchronizeableQuery

public class NativeQueryImpl<R>
extends AbstractQuery<R>
implements NativeQueryImplementor<R>, DomainQueryExecutionContext, ResultSetMappingResolutionContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.NativeQuery

NativeQuery.CollectionReturn, NativeQuery.FetchReturn, NativeQuery.InstantiationResultNode<J>, NativeQuery.ResultNode, NativeQuery.ReturnableResultNode, NativeQuery.ReturnProperty, NativeQuery.RootReturn

Field Summary

Fields inherited from class org.hibernate.query.spi.AbstractSelectionQuery

CRITERIA_HQL_STRING

Constructor Summary

Constructors

Constructor	Description
NativeQueryImpl(String sql, @Nullable Class<R> resultClass, SharedSessionContractImplementor session)
NativeQueryImpl(String sql, NamedResultSetMappingMemento resultSetMappingMemento, Class<R> resultClass, SharedSessionContractImplementor session)
NativeQueryImpl(NamedNativeQueryMemento<?> memento, Class<R> resultJavaType, SharedSessionContractImplementor session)	Constructs a NativeQueryImpl given a SQL query defined in the mappings.
NativeQueryImpl(NamedNativeQueryMemento<?> memento, String resultSetMappingName, SharedSessionContractImplementor session)	Constructs a NativeQueryImpl given a SQL query defined in the mappings.
NativeQueryImpl(NamedNativeQueryMemento<?> memento, SharedSessionContractImplementor session)	Constructs a NativeQueryImpl given a SQL query defined in the mappings.

Method Summary

Modifier and Type	Method	Description
NativeQueryImplementor<R>	addAttributeResult(String columnAlias, SingularAttribute attribute)	Defines a result based on a specified attribute.
NativeQueryImplementor<R>	addAttributeResult(String columnAlias, Class entityJavaType, String attributePath)	Defines a result based on a specified attribute.
NativeQueryImplementor<R>	addAttributeResult(String columnAlias, String entityName, String attributePath)	Defines a result based on a specified attribute.
NativeQueryImplementor<R>	addEntity(Class entityType)	Declare a "root" entity, without specifying an alias.
NativeQueryImplementor<R>	addEntity(Class<R> entityType, LockMode lockMode)
NativeQueryImplementor<R>	addEntity(String entityName)	Declare a "root" entity, without specifying an alias.
NativeQueryImplementor<R>	addEntity(String tableAlias, Class entityClass)	Declare a "root" entity.
NativeQueryImplementor<R>	addEntity(String tableAlias, Class entityClass, LockMode lockMode)	Declare a "root" entity, specifying a lock mode.
NativeQueryImplementor<R>	addEntity(String tableAlias, String entityName)	Declare a "root" entity.
NativeQueryImplementor<R>	addEntity(String tableAlias, String entityName, LockMode lockMode)	Declare a "root" entity, specifying a lock mode.
NativeQuery.FetchReturn	addFetch(String tableAlias, String ownerTableAlias, String joinPropertyName)	Declare a join fetch result.
<J> NativeQuery.InstantiationResultNode<J>	addInstantiation(Class<J> targetJavaType)
NativeQueryImplementor<R>	addJoin(String tableAlias, String path)	Declare a join fetch result.
NativeQueryImplementor<R>	addJoin(String tableAlias, String ownerTableAlias, String joinPropertyName)	Declare a join fetch result.
NativeQueryImplementor<R>	addJoin(String tableAlias, String path, LockMode lockMode)	Declare a join fetch result, specifying a lock mode.
NativeQueryImplementor<R>	addQueryHint(String hint)	Add a database query hint to the SQL query.
protected void	addQuerySpaces(Serializable... spaces)
protected void	addQuerySpaces(String... spaces)
void	addResultTypeClass(Class<?> resultClass)
DynamicResultBuilderEntityStandard	addRoot(String tableAlias, Class entityType)	Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.
DynamicResultBuilderEntityStandard	addRoot(String tableAlias, String entityName)	Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.
NativeQueryImplementor<R>	addScalar(int position, Class<?> type)
NativeQueryImplementor<R>	addScalar(String columnAlias)	Declare a scalar query result.
NativeQueryImplementor<R>	addScalar(String columnAlias, Class javaType)	Declare a scalar query result using the specified result type.
<C> NativeQueryImplementor<R>	addScalar(String columnAlias, Class<C> jdbcJavaType, AttributeConverter<?,C> converter)	Declare a scalar query result with an explicit conversion.
<C> NativeQueryImplementor<R>	addScalar(String columnAlias, Class<C> relationalJavaType, Class<? extends AttributeConverter<?,C>> converter)	Declare a scalar query result with an explicit conversion.
<O, J> NativeQueryImplementor<R>	addScalar(String columnAlias, Class<O> domainJavaType, Class<J> jdbcJavaType, AttributeConverter<O,J> converter)	Declare a scalar query result with an explicit conversion.
<O, J> NativeQueryImplementor<R>	addScalar(String columnAlias, Class<O> domainJavaType, Class<J> jdbcJavaType, Class<? extends AttributeConverter<O,J>> converterJavaType)	Declare a scalar query result with an explicit conversion.
NativeQueryImplementor<R>	addScalar(String columnAlias, BasicDomainType type)	Declare a scalar query result.
NativeQuery<R>	addScalar(String columnAlias, BasicTypeReference type)	Declare a scalar query result.
NativeQueryImplementor<R>	addSynchronizedEntityClass(Class entityClass)	Add all query spaces associated with the entity with the given type.
NativeQueryImplementor<R>	addSynchronizedEntityName(String entityName)	Add all query spaces associated with the entity with the given names.
NativeQueryImplementor<R>	addSynchronizedQuerySpace(String querySpace)	Add a query space.
protected void	applyEntityGraphHint(GraphSemantic graphSemantic, Object value, String hintName)
protected void	applyGraph(String graphString, GraphSemantic graphSemantic)
Query<R>	applyGraph(RootGraph graph, GraphSemantic semantic)	Apply the given graph using the given semantic
protected void	applyGraph(RootGraphImplementor<?> entityGraph, GraphSemantic graphSemantic)
protected void	applyOptions(NamedNativeQueryMemento<?> memento)
protected void	applySynchronizeSpace(Object value)
protected void	applySynchronizeSpacesHint(Object value)
protected void	collectHints(Map<String,Object> hints)
protected NativeSelectQueryPlan<Long>	createCountQueryPlan()
static int	determineBindValueMaxCount(boolean paddingEnabled, int inExprLimit, int bindValueCount)
protected @Nullable TupleTransformer<?>	determineTupleTransformerForResultType(Class<?> resultClass)	If the result type of the query is Tuple, Map, List, or any record or class type with an appropriate constructor which is NOT a registered basic type, then we attempt to repackage the result tuple as an instance of the result type using an appropriate TupleTransformer.
protected int	doExecuteUpdate()
protected List<R>	doList()
protected ScrollableResultsImplementor<R>	doScroll(ScrollMode scrollMode)
protected String	expandParameterLists(int parameterStartPosition)
protected NonSelectInterpretationsKey	generateNonSelectInterpretationsKey()
Callback	getCallback()	The callback reference
KeyedResultList<R>	getKeyedResultList(KeyedPage<R> page)	Execute the query and return the results for the given page, using key-based pagination.
LockModeType	getLockMode()	Get the root LockModeType for the query
QueryParameterBindings	getParameterBindings()
ParameterMetadataImplementor	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
List<ParameterOccurrence>	getParameterOccurrences()
MutableQueryOptions	getQueryOptions()	Get the execution options for this Query.
QueryParameterBindings	getQueryParameterBindings()	The domain parameter bindings
String	getQueryString()	The query as a string, or null in the case of a criteria query.
long	getResultCount()	Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.
Class<R>	getResultType()
Collection<String>	getSynchronizedQuerySpaces()	Obtain the list of query spaces this query is synchronized with.
boolean	hasCallbackActions()
Boolean	isSelectQuery()	Best guess whether this is a select query.
protected void	prepareForExecution()
protected NativeQueryImplementor<R>	registerBuilder(ResultBuilder builder)
protected SelectQueryPlan<R>	resolveSelectQueryPlan()
NativeQueryImplementor<R>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
NativeQueryImplementor<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
NativeQueryImplementor<R>	setCacheRegion(String cacheRegion)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
NativeQueryImplementor<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
NativeQueryImplementor<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
NativeQueryImplementor<R>	setComment(String comment)	Set a comment for this query.
NativeQueryImplementor<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
NativeQueryImplementor<R>	setFirstResult(int startPosition)	Set the first query result row to return.
NativeQueryImplementor<R>	setFlushMode(FlushModeType flushModeType)	Set the FlushMode to use for this query.
NativeQueryImplementor<R>	setHibernateFlushMode(FlushMode flushMode)	Set the current FlushMode in effect for this query.
NativeQueryImplementor<R>	setHibernateLockMode(LockMode lockMode)	Specify the root LockMode for the query
NativeQueryImplementor<R>	setHint(String hintName, Object value)	Set a hint.
NativeQueryImplementor<R>	setLockMode(LockModeType lockModeType)	Specify the root LockModeType for the query
NativeQueryImplementor<R>	setLockOptions(LockOptions lockOptions)	Deprecated.
NativeQueryImplementor<R>	setLockScope(PessimisticLockScope lockScope)	Apply a scope to any pessimistic locking applied to the query.
QueryImplementor<R>	setLockScope(Locking.Scope lockScope)	Apply a scope to any pessimistic locking applied to the query.
NativeQueryImplementor<R>	setMaxResults(int maxResults)	Set the maximum number of query result rows to return.
NativeQueryImplementor<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
NativeQueryImplementor<R>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
NativeQueryImplementor<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
NativeQueryImplementor<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> NativeQueryImplementor<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameter(int position, P value, Class<P> javaTypeClass)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
NativeQueryImplementor<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
NativeQueryImplementor<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> NativeQueryImplementor<R>	setParameter(Parameter<P> parameter, P value)	Query override
NativeQueryImplementor<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
NativeQueryImplementor<R>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
NativeQueryImplementor<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
NativeQueryImplementor<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> NativeQueryImplementor<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameter(String name, P value, Class<P> javaTypeClass)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> NativeQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> NativeQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P value, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> NativeQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P value, Class<P> javaTypeClass)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
NativeQueryImplementor<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
NativeQueryImplementor<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> NativeQueryImplementor<R>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameterList(int position, Collection<? extends P> values, Class<P> javaTypeClass)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
<P> NativeQueryImplementor<R>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameterList(int position, P[] values, Class<P> javaTypeClass)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
NativeQueryImplementor<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
NativeQueryImplementor<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> NativeQueryImplementor<R>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameterList(String name, Collection<? extends P> values, Class<P> javaTypeClass)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> NativeQueryImplementor<R>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameterList(String name, P[] values, Class<P> javaTypeClass)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use.
<P> NativeQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> NativeQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.
<P> NativeQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaTypeClass)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
<P> NativeQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> NativeQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, P[] values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.
<P> NativeQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaTypeClass)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
NativeQueryImplementor<R>	setProperties(Object bean)	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.
NativeQueryImplementor<R>	setProperties(Map map)	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.
NativeQueryImplementor<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
NativeQueryImplementor<R>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable/disable query plan caching for this query.
NativeQueryImplementor<R>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
NativeQueryImplementor<R>	setResultListTransformer(ResultListTransformer<R> transformer)	Set a ResultListTransformer.
<S> NativeQueryImplementor<S>	setResultTransformer(ResultTransformer<S> transformer)	Deprecated.
NativeQueryImplementor<R>	setTimeout(int timeout)	Set the query timeout in seconds.
NativeQueryImplementor<R>	setTimeout(Timeout timeout)	Apply a timeout to the corresponding database query.
TypedQuery<R>	setTimeout(Integer timeout)
<T> NativeQueryImplementor<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.
protected <T> void	setTupleTransformerForResultType(Class<T> resultClass)
NamedNativeQueryMemento<R>	toMemento(String name)	Convert this query into the memento.
<T> T	unwrap(Class<T> type)

Methods inherited from class org.hibernate.query.spi.AbstractQuery

applyOptions, disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getFirstResult, getLockOptions, getMaxResults, getParameters, getSupportedHints, isCacheable, resolveJdbcParameterTypeIfNecessary, setEntityGraph

Methods inherited from class org.hibernate.query.spi.AbstractSelectionQuery

afterQuery, afterQuery, afterQueryHandlingFetchProfiles, beforeQuery, beforeQueryHandlingFetchProfiles, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFlushMode, getHibernateLockMode, getResultStream, getSingleResult, getSingleResultOrNull, isQueryPlanCacheable, isReadOnly, list, requiresTxn, resetCallback, scroll, scroll, setFollowOnLocking, setFollowOnStrategy, setLockMode, stream, uniqueElement, uniqueResult, uniqueResultOptional

Methods inherited from class org.hibernate.query.spi.AbstractCommonQueryContract

applyCommentHint, applyDatabaseHint, applyFlushModeHint, applyFollowOnLockingHint, applyFollowOnStrategyHint, applyHibernateLockMode, applyHint, applyLockModeHint, applyLockModeType, applyLockTimeoutHint, applyLockTimeoutHint, applySelectionHint, applyTimeoutHint, determineType, getExceptionConverter, getHibernateFlushMode, getHints, getIntegerLiteral, getMaxRows, getParameter, getParameter, getParameter, getParameter, getParameterValue, getParameterValue, getParameterValue, getQueryFlushMode, getSession, getSessionFactory, getTimeout, getTypeConfiguration, isBound, locateBinding, locateBinding, locateBinding, locateBinding, putIfNotNull, putIfNotNull

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.CommonQueryContract

getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout

Methods inherited from interface org.hibernate.query.spi.DomainQueryExecutionContext

getSession

Methods inherited from interface org.hibernate.query.NativeQuery

getHibernateLockMode, getLockOptions

Methods inherited from interface jakarta.persistence.Query

getCacheRetrieveMode, getCacheStoreMode, getFirstResult, getFlushMode, getHints, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getTimeout, isBound

Methods inherited from interface org.hibernate.query.Query

applyFetchGraph, applyLoadGraph, disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getResultList, getResultStream, getSingleResult, list, setEntityGraph, setPage, stream, uniqueResult, uniqueResultOptional

Methods inherited from interface org.hibernate.query.spi.QueryImplementor

getSession, scroll, scroll

Methods inherited from interface org.hibernate.query.internal.ResultSetMappingResolutionContext

getMappingMetamodel, getNamedObjectRepository, getSessionFactory, getTypeConfiguration

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getMaxResults, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, setFollowOnLocking, setFollowOnStrategy, setLockMode

Methods inherited from interface jakarta.persistence.TypedQuery

getSingleResultOrNull

Constructor Details

NativeQueryImpl

public NativeQueryImpl(NamedNativeQueryMemento<?> memento,
 SharedSessionContractImplementor session)

Constructs a NativeQueryImpl given a SQL query defined in the mappings. Used by Hibernate Reactive.

NativeQueryImpl

public NativeQueryImpl(NamedNativeQueryMemento<?> memento,
 Class<R> resultJavaType,
 SharedSessionContractImplementor session)

Constructs a NativeQueryImpl given a SQL query defined in the mappings.

NativeQueryImpl

public NativeQueryImpl(NamedNativeQueryMemento<?> memento,
 String resultSetMappingName,
 SharedSessionContractImplementor session)

Constructs a NativeQueryImpl given a SQL query defined in the mappings.

NativeQueryImpl

public NativeQueryImpl(String sql,
 NamedResultSetMappingMemento resultSetMappingMemento,
 Class<R> resultClass,
 SharedSessionContractImplementor session)

NativeQueryImpl

public NativeQueryImpl(String sql,
 @Nullable Class<R> resultClass,
 SharedSessionContractImplementor session)

Method Details

setTupleTransformerForResultType

protected <T> void setTupleTransformerForResultType(Class<T> resultClass)

determineTupleTransformerForResultType

protected @Nullable TupleTransformer<?> determineTupleTransformerForResultType(Class<?> resultClass)

If the result type of the query is Tuple, Map, List, or any record or class type with an appropriate constructor which is NOT a registered basic type, then we attempt to repackage the result tuple as an instance of the result type using an appropriate TupleTransformer.

Parameters:

resultClass - The requested result type of the query

Returns:

A TupleTransformer responsible for repackaging the result type

getParameterOccurrences

public List<ParameterOccurrence> getParameterOccurrences()

applyOptions

protected void applyOptions(NamedNativeQueryMemento<?> memento)

getQueryString

public String getQueryString()

Description copied from interface: Query

The query as a string, or null in the case of a criteria query.

Specified by:

getQueryString in interface Query<R>

Specified by:

getQueryString in class AbstractSelectionQuery<R>

getParameterMetadata

public ParameterMetadataImplementor getParameterMetadata()

Description copied from interface: CommonQueryContract

Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.

Specified by:

getParameterMetadata in interface CommonQueryContract

Specified by:

getParameterMetadata in class AbstractCommonQueryContract

getQueryOptions

public MutableQueryOptions getQueryOptions()

Description copied from interface: Query

Get the execution options for this Query. Many of the setters of this object update the state of the returned QueryOptions. This is useful because it gives access to s primitive value in its (nullable) wrapper form, rather than the primitive form as required by JPA. This allows us to distinguish whether a value has been explicitly set by the client.

Specified by:

getQueryOptions in interface DomainQueryExecutionContext

Specified by:

getQueryOptions in interface Query<R>

Overrides:

getQueryOptions in class AbstractQuery<R>

Returns:

Return the encapsulation of this query's options.

getCallback

public Callback getCallback()

Description copied from interface: DomainQueryExecutionContext

The callback reference

Specified by:

getCallback in interface DomainQueryExecutionContext

Overrides:

getCallback in class AbstractSelectionQuery<R>

hasCallbackActions

public boolean hasCallbackActions()

Specified by:

hasCallbackActions in interface DomainQueryExecutionContext

Overrides:

hasCallbackActions in class AbstractSelectionQuery<R>

getQueryParameterBindings

public QueryParameterBindings getQueryParameterBindings()

Description copied from interface: DomainQueryExecutionContext

The domain parameter bindings

Specified by:

getQueryParameterBindings in interface DomainQueryExecutionContext

Specified by:

getQueryParameterBindings in class AbstractCommonQueryContract

getParameterBindings

public QueryParameterBindings getParameterBindings()

Specified by:

getParameterBindings in interface QueryImplementor<R>

getResultType

public Class<R> getResultType()

Specified by:

getResultType in interface DomainQueryExecutionContext

toMemento

public NamedNativeQueryMemento<R> toMemento(String name)

Description copied from interface: NameableQuery

Convert this query into the memento.

Specified by:

toMemento in interface NameableQuery

Specified by:

toMemento in interface NativeQueryImplementor<R>

See Also:

• EntityManagerFactory.addNamedQuery(String, Query)
• NamedObjectRepository.registerNamedQuery(String, Query)

getLockMode

public LockModeType getLockMode()

Description copied from interface: SelectionQuery

Get the root LockModeType for the query

Specified by:

getLockMode in interface NativeQuery<R>

Specified by:

getLockMode in interface Query

Specified by:

getLockMode in interface SelectionQuery<R>

Overrides:

getLockMode in class AbstractQuery<R>

See Also:

• SelectionQuery.getHibernateLockMode()

setLockOptions

@Deprecated
public NativeQueryImplementor<R> setLockOptions(LockOptions lockOptions)

Deprecated.

Description copied from interface: Query

Apply the given lock options to this query. Alias-specific lock modes in the given lock options are merged with any alias-specific lock mode which have already been set. If a lock mode has already been specified for an alias that is among the aliases in the given lock options, the lock mode specified in the given lock options overrides the lock mode that was already set.

Specified by:

setLockOptions in interface NativeQuery<R>

Specified by:

setLockOptions in interface NativeQueryImplementor<R>

Specified by:

setLockOptions in interface Query<R>

Overrides:

setLockOptions in class AbstractQuery<R>

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

• Query.getLockOptions()

setHibernateLockMode

public NativeQueryImplementor<R> setHibernateLockMode(LockMode lockMode)

Description copied from class: AbstractSelectionQuery

Specify the root LockMode for the query

Specified by:

setHibernateLockMode in interface NativeQuery<R>

Specified by:

setHibernateLockMode in interface NativeQueryImplementor<R>

Specified by:

setHibernateLockMode in interface SelectionQuery<R>

Overrides:

setHibernateLockMode in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.setLockMode(LockModeType)

setTimeout

public NativeQueryImplementor<R> setTimeout(Timeout timeout)

Description copied from interface: CommonQueryContract

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface NativeQuery<R>

Specified by:

setTimeout in interface Query<R>

Overrides:

setTimeout in class AbstractQuery<R>

Parameters:

timeout - The timeout to apply

Returns:

this, for method chaining

setLockScope

public NativeQueryImplementor<R> setLockScope(PessimisticLockScope lockScope)

Description copied from interface: SelectionQuery

Apply a scope to any pessimistic locking applied to the query.

Specified by:

setLockScope in interface NativeQuery<R>

Specified by:

setLockScope in interface Query<R>

Specified by:

setLockScope in interface SelectionQuery<R>

Overrides:

setLockScope in class AbstractQuery<R>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setLockScope

public QueryImplementor<R> setLockScope(Locking.Scope lockScope)

Description copied from interface: SelectionQuery

Apply a scope to any pessimistic locking applied to the query.

Specified by:

setLockScope in interface SelectionQuery<R>

Overrides:

setLockScope in class AbstractQuery<R>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setLockMode

public NativeQueryImplementor<R> setLockMode(LockModeType lockModeType)

Description copied from class: AbstractSelectionQuery

Specify the root LockModeType for the query

Specified by:

setLockMode in interface NativeQuery<R>

Specified by:

setLockMode in interface NativeQueryImplementor<R>

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Specified by:

setLockMode in interface TypedQuery<R>

Overrides:

setLockMode in class AbstractQuery<R>

See Also:

• AbstractSelectionQuery.setHibernateLockMode(org.hibernate.LockMode)

applyGraph

protected void applyGraph(String graphString,
 GraphSemantic graphSemantic)

Overrides:

applyGraph in class AbstractCommonQueryContract

applyGraph

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

Overrides:

applyGraph in class AbstractCommonQueryContract

applyGraph

public Query<R> applyGraph(RootGraph graph,
 GraphSemantic semantic)

Description copied from interface: Query

Apply the given graph using the given semantic

Specified by:

applyGraph in interface Query<R>

Parameters:

graph - The graph to apply.

semantic - The semantic to use when applying the graph

applyEntityGraphHint

protected void applyEntityGraphHint(GraphSemantic graphSemantic,
 Object value,
 String hintName)

Overrides:

applyEntityGraphHint in class AbstractCommonQueryContract

setTupleTransformer

public <T> NativeQueryImplementor<T> setTupleTransformer(TupleTransformer<T> transformer)

Description copied from interface: Query

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface NativeQuery<R>

Specified by:

setTupleTransformer in interface NativeQueryImplementor<R>

Specified by:

setTupleTransformer in interface Query<R>

Specified by:

setTupleTransformer in interface QueryImplementor<R>

Specified by:

setTupleTransformer in interface SelectionQuery<R>

Overrides:

setTupleTransformer in class AbstractQuery<R>

setResultListTransformer

public NativeQueryImplementor<R> setResultListTransformer(ResultListTransformer<R> transformer)

Description copied from interface: Query

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface NativeQuery<R>

Specified by:

setResultListTransformer in interface NativeQueryImplementor<R>

Specified by:

setResultListTransformer in interface Query<R>

Specified by:

setResultListTransformer in interface QueryImplementor<R>

Specified by:

setResultListTransformer in interface SelectionQuery<R>

Overrides:

setResultListTransformer in class AbstractQuery<R>

isSelectQuery

public Boolean isSelectQuery()

Description copied from interface: NativeQueryImplementor

Best guess whether this is a select query. null indicates unknown

Specified by:

isSelectQuery in interface NativeQueryImplementor<R>

prepareForExecution

protected void prepareForExecution()

Overrides:

prepareForExecution in class AbstractQuery<R>

doList

protected List<R> doList()

Specified by:

doList in class AbstractSelectionQuery<R>

getResultCount

public long getResultCount()

Description copied from interface: SelectionQuery

Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.

Specified by:

getResultCount in interface SelectionQuery<R>

Returns:

the size of the list that would be returned

getKeyedResultList

public KeyedResultList<R> getKeyedResultList(KeyedPage<R> page)

Description copied from interface: SelectionQuery

Execute the query and return the results for the given page, using key-based pagination.

Specified by:

getKeyedResultList in interface SelectionQuery<R>

Overrides:

getKeyedResultList in class AbstractQuery<R>

Parameters:

page - the key-based specification of the page as an instance of KeyedPage

Returns:

the query results and the key of the next page as an instance of KeyedResultList

See Also:

• KeyedPage
• KeyedResultList

resolveSelectQueryPlan

protected SelectQueryPlan<R> resolveSelectQueryPlan()

createCountQueryPlan

protected NativeSelectQueryPlan<Long> createCountQueryPlan()

expandParameterLists

protected String expandParameterLists(int parameterStartPosition)

determineBindValueMaxCount

public static int determineBindValueMaxCount(boolean paddingEnabled,
 int inExprLimit,
 int bindValueCount)

doScroll

protected ScrollableResultsImplementor<R> doScroll(ScrollMode scrollMode)

Specified by:

doScroll in class AbstractSelectionQuery<R>

doExecuteUpdate

protected int doExecuteUpdate()

Specified by:

doExecuteUpdate in class AbstractQuery<R>

generateNonSelectInterpretationsKey

protected NonSelectInterpretationsKey generateNonSelectInterpretationsKey()

addResultTypeClass

public void addResultTypeClass(Class<?> resultClass)

Specified by:

addResultTypeClass in interface NativeQueryImplementor<R>

addScalar

public NativeQueryImplementor<R> addScalar(String columnAlias)

Description copied from interface: NativeQuery

Declare a scalar query result. Hibernate will attempt to automatically detect the underlying type.

Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Parameters:

columnAlias - The column alias in the result set to be processed as a scalar result

Returns:

this, for method chaining

addScalar

public NativeQueryImplementor<R> addScalar(int position,
 Class<?> type)

registerBuilder

protected NativeQueryImplementor<R> registerBuilder(ResultBuilder builder)

addScalar

public NativeQuery<R> addScalar(String columnAlias,
 BasicTypeReference type)

Description copied from interface: NativeQuery

Declare a scalar query result.

Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations.

Specified by:

addScalar in interface NativeQuery<R>

Parameters:

columnAlias - The column alias in the result set to be processed as a scalar result

type - The Hibernate type as which to treat the value.

Returns:

this, for method chaining

addScalar

public NativeQueryImplementor<R> addScalar(String columnAlias,
 BasicDomainType type)

Description copied from interface: NativeQuery

Declare a scalar query result.

Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations.

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Parameters:

columnAlias - The column alias in the result set to be processed as a scalar result

type - The Hibernate type as which to treat the value.

Returns:

this, for method chaining

addScalar

public NativeQueryImplementor<R> addScalar(String columnAlias,
 Class javaType)

Description copied from interface: NativeQuery

Declare a scalar query result using the specified result type.

Hibernate will implicitly determine an appropriate conversion, if it can. Otherwise, an exception will be thrown.

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Returns:

this, for method chaining

addScalar

public <C> NativeQueryImplementor<R> addScalar(String columnAlias,
 Class<C> jdbcJavaType,
 AttributeConverter<?,C> converter)

Description copied from interface: NativeQuery

Declare a scalar query result with an explicit conversion.

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Parameters:

jdbcJavaType - The Java type expected by the converter as its "relational" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

addScalar

public <O,
J> NativeQueryImplementor<R> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<J> jdbcJavaType,
 AttributeConverter<O,J> converter)

Description copied from interface: NativeQuery

Declare a scalar query result with an explicit conversion.

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Parameters:

domainJavaType - The Java type expected by the converter as its "object model" type.

jdbcJavaType - The Java type expected by the converter as its "relational model" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

addScalar

public <C> NativeQueryImplementor<R> addScalar(String columnAlias,
 Class<C> relationalJavaType,
 Class<? extends AttributeConverter<?,C>> converter)

Description copied from interface: NativeQuery

Declare a scalar query result with an explicit conversion.

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Parameters:

relationalJavaType - The Java type expected by the converter as its "relational" type.

converter - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

addScalar

public <O,
J> NativeQueryImplementor<R> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<J> jdbcJavaType,
 Class<? extends AttributeConverter<O,J>> converterJavaType)

Description copied from interface: NativeQuery

Declare a scalar query result with an explicit conversion.

Specified by:

addScalar in interface NativeQuery<R>

Specified by:

addScalar in interface NativeQueryImplementor<R>

Parameters:

domainJavaType - The Java type expected by the converter as its "object model" type.

jdbcJavaType - The Java type expected by the converter as its "relational model" type.

converterJavaType - The conversion to apply. Consumes the JDBC value based on relationalJavaType.

Returns:

this, for method chaining

addInstantiation

public <J> NativeQuery.InstantiationResultNode<J> addInstantiation(Class<J> targetJavaType)

Specified by:

addInstantiation in interface NativeQuery<R>

addAttributeResult

public NativeQueryImplementor<R> addAttributeResult(String columnAlias,
 Class entityJavaType,
 String attributePath)

Description copied from interface: NativeQuery

Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping.

Specified by:

addAttributeResult in interface NativeQuery<R>

Specified by:

addAttributeResult in interface NativeQueryImplementor<R>

Returns:

this, for method chaining

addAttributeResult

public NativeQueryImplementor<R> addAttributeResult(String columnAlias,
 String entityName,
 String attributePath)

Description copied from interface: NativeQuery

Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping.

Specified by:

addAttributeResult in interface NativeQuery<R>

Specified by:

addAttributeResult in interface NativeQueryImplementor<R>

Returns:

this, for method chaining

addAttributeResult

public NativeQueryImplementor<R> addAttributeResult(String columnAlias,
 SingularAttribute attribute)

Description copied from interface: NativeQuery

Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping.

This form accepts the JPA Attribute mapping describing the attribute

Specified by:

addAttributeResult in interface NativeQuery<R>

Specified by:

addAttributeResult in interface NativeQueryImplementor<R>

Returns:

this, for method chaining

addRoot

public DynamicResultBuilderEntityStandard addRoot(String tableAlias,
 String entityName)

Description copied from interface: NativeQuery

Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.

Specified by:

addRoot in interface NativeQuery<R>

Specified by:

addRoot in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias to map to this entity

entityName - The name of the entity

Returns:

The return config object for further control.

addRoot

public DynamicResultBuilderEntityStandard addRoot(String tableAlias,
 Class entityType)

Description copied from interface: NativeQuery

Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.

Specified by:

addRoot in interface NativeQuery<R>

Parameters:

tableAlias - The SQL table alias to map to this entity

entityType - The java type of the entity

Returns:

The return config object for further control.

addEntity

public NativeQueryImplementor<R> addEntity(String entityName)

Description copied from interface: NativeQuery

Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name.

Use NativeQuery.addRoot(java.lang.String, java.lang.String) if you need further control of the mapping

Specified by:

addEntity in interface NativeQuery<R>

Specified by:

addEntity in interface NativeQueryImplementor<R>

Parameters:

entityName - The entity name that is the root return of the query

Returns:

this, for method chaining

addEntity

public NativeQueryImplementor<R> addEntity(String tableAlias,
 String entityName)

Description copied from interface: NativeQuery

Declare a "root" entity.

Specified by:

addEntity in interface NativeQuery<R>

Specified by:

addEntity in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias

entityName - The entity name

Returns:

this, for method chaining

addEntity

public NativeQueryImplementor<R> addEntity(String tableAlias,
 String entityName,
 LockMode lockMode)

Description copied from interface: NativeQuery

Declare a "root" entity, specifying a lock mode.

Specified by:

addEntity in interface NativeQuery<R>

Specified by:

addEntity in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias

entityName - The entity name

lockMode - The lock mode for this return.

Returns:

this, for method chaining

addEntity

public NativeQueryImplementor<R> addEntity(Class entityType)

Description copied from interface: NativeQuery

Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name.

Specified by:

addEntity in interface NativeQuery<R>

Specified by:

addEntity in interface NativeQueryImplementor<R>

Parameters:

entityType - The java type of the entity to add as a root

Returns:

this, for method chaining

addEntity

public NativeQueryImplementor<R> addEntity(Class<R> entityType,
 LockMode lockMode)

Specified by:

addEntity in interface NativeQueryImplementor<R>

addEntity

public NativeQueryImplementor<R> addEntity(String tableAlias,
 Class entityClass)

Description copied from interface: NativeQuery

Declare a "root" entity.

Specified by:

addEntity in interface NativeQuery<R>

Specified by:

addEntity in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias

entityClass - The java type of the entity to add as a root

Returns:

this, for method chaining

addEntity

public NativeQueryImplementor<R> addEntity(String tableAlias,
 Class entityClass,
 LockMode lockMode)

Description copied from interface: NativeQuery

Declare a "root" entity, specifying a lock mode.

Specified by:

addEntity in interface NativeQuery<R>

Specified by:

addEntity in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias

entityClass - The entity Class

lockMode - The lock mode for this return

Returns:

this, for method chaining

addFetch

public NativeQuery.FetchReturn addFetch(String tableAlias,
 String ownerTableAlias,
 String joinPropertyName)

Description copied from interface: NativeQuery

Declare a join fetch result.

Specified by:

addFetch in interface NativeQuery<R>

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch.

ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch.

joinPropertyName - The name of the property being join fetched.

Returns:

The return config object for further control.

addJoin

public NativeQueryImplementor<R> addJoin(String tableAlias,
 String path)

Description copied from interface: NativeQuery

Declare a join fetch result.

Specified by:

addJoin in interface NativeQuery<R>

Specified by:

addJoin in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch.

path - The association path of form [owner-alias].[property-name].

Returns:

this, for method chaining

addJoin

public NativeQueryImplementor<R> addJoin(String tableAlias,
 String ownerTableAlias,
 String joinPropertyName)

Description copied from interface: NativeQuery

Declare a join fetch result.

Specified by:

addJoin in interface NativeQuery<R>

Specified by:

addJoin in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch

ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch.

joinPropertyName - The name of the property being join fetched.

Returns:

this, for method chaining

addJoin

public NativeQueryImplementor<R> addJoin(String tableAlias,
 String path,
 LockMode lockMode)

Description copied from interface: NativeQuery

Declare a join fetch result, specifying a lock mode.

Specified by:

addJoin in interface NativeQuery<R>

Specified by:

addJoin in interface NativeQueryImplementor<R>

Parameters:

tableAlias - The SQL table alias for the data to be mapped to this fetch

path - The association path of form [owner-alias].[property-name].

lockMode - The lock mode for this return.

Returns:

this, for method chaining

getSynchronizedQuerySpaces

public Collection<String> getSynchronizedQuerySpaces()

Description copied from interface: SynchronizeableQuery

Obtain the list of query spaces this query is synchronized with.

Specified by:

getSynchronizedQuerySpaces in interface SynchronizeableQuery

Returns:

The list of query spaces upon which the query is synchronized.

addSynchronizedQuerySpace

public NativeQueryImplementor<R> addSynchronizedQuerySpace(String querySpace)

Description copied from interface: SynchronizeableQuery

Add a query space. The effect of this call is to:

• force an auto-flush if any entity associated with the current session and mapped to the given query space has pending changes which have not yet been synchronized with the database, and
• if the result set of this query is cached, mark it for invalidation when any entity mapped to the given query space is synchronized with the database in any session.

Specified by:

addSynchronizedQuerySpace in interface NativeQuery<R>

Specified by:

addSynchronizedQuerySpace in interface NativeQueryImplementor<R>

Specified by:

addSynchronizedQuerySpace in interface SynchronizeableQuery

Parameters:

querySpace - The name of the query space, usually the name of a database table.

Returns:

this, for method chaining

addQuerySpaces

protected void addQuerySpaces(String... spaces)

addQuerySpaces

protected void addQuerySpaces(Serializable... spaces)

addSynchronizedEntityName

public NativeQueryImplementor<R> addSynchronizedEntityName(String entityName)

Description copied from interface: SynchronizeableQuery

Add all query spaces associated with the entity with the given names.

Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables mapped by the given entity.

Specified by:

addSynchronizedEntityName in interface NativeQuery<R>

Specified by:

addSynchronizedEntityName in interface NativeQueryImplementor<R>

Specified by:

addSynchronizedEntityName in interface SynchronizeableQuery

Parameters:

entityName - The name of an entity.

Returns:

this, for method chaining

addSynchronizedEntityClass

public NativeQueryImplementor<R> addSynchronizedEntityClass(Class entityClass)

Description copied from interface: SynchronizeableQuery

Add all query spaces associated with the entity with the given type.

Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables mapped by the given entity.

Specified by:

addSynchronizedEntityClass in interface NativeQuery<R>

Specified by:

addSynchronizedEntityClass in interface NativeQueryImplementor<R>

Specified by:

addSynchronizedEntityClass in interface SynchronizeableQuery

Parameters:

entityClass - The class of the entity.

Returns:

this, for method chaining

setHibernateFlushMode

public NativeQueryImplementor<R> setHibernateFlushMode(FlushMode flushMode)

Description copied from interface: CommonQueryContract

Set the current FlushMode in effect for this query.

Specified by:

setHibernateFlushMode in interface CommonQueryContract

Specified by:

setHibernateFlushMode in interface MutationQuery

Specified by:

setHibernateFlushMode in interface NativeQuery<R>

Specified by:

setHibernateFlushMode in interface NativeQueryImplementor<R>

Specified by:

setHibernateFlushMode in interface Query<R>

Specified by:

setHibernateFlushMode in interface SelectionQuery<R>

Overrides:

setHibernateFlushMode in class AbstractQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• CommonQueryContract.getHibernateFlushMode()
• Session.getHibernateFlushMode()

setQueryFlushMode

public NativeQueryImplementor<R> setQueryFlushMode(QueryFlushMode queryFlushMode)

Description copied from interface: CommonQueryContract

Set the QueryFlushMode to use for this query.

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface MutationQuery

Specified by:

setQueryFlushMode in interface NativeQuery<R>

Specified by:

setQueryFlushMode in interface NativeQueryImplementor<R>

Specified by:

setQueryFlushMode in interface Query<R>

Specified by:

setQueryFlushMode in interface SelectionQuery<R>

Overrides:

setQueryFlushMode in class AbstractQuery<R>

See Also:

• Session.getHibernateFlushMode()

setFlushMode

public NativeQueryImplementor<R> setFlushMode(FlushModeType flushModeType)

Description copied from interface: CommonQueryContract

Set the FlushMode to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use CommonQueryContract.setHibernateFlushMode(org.hibernate.FlushMode) passing FlushMode.MANUAL instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface NativeQuery<R>

Specified by:

setFlushMode in interface NativeQueryImplementor<R>

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface SelectionQuery<R>

Specified by:

setFlushMode in interface TypedQuery<R>

Overrides:

setFlushMode in class AbstractQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• CommonQueryContract.getHibernateFlushMode()
• Session.getHibernateFlushMode()

setCacheMode

public NativeQueryImplementor<R> setCacheMode(CacheMode cacheMode)

Description copied from interface: SelectionQuery

Set the current CacheMode in effect for this query.

Set it to null to indicate that the CacheMode of the session should be used.

Specified by:

setCacheMode in interface NativeQuery<R>

Specified by:

setCacheMode in interface NativeQueryImplementor<R>

Specified by:

setCacheMode in interface Query<R>

Specified by:

setCacheMode in interface SelectionQuery<R>

Overrides:

setCacheMode in class AbstractQuery<R>

See Also:

• SelectionQuery.getCacheMode()
• Session.setCacheMode(CacheMode)

setCacheRetrieveMode

public NativeQueryImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface NativeQuery<R>

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<R>

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

Specified by:

setCacheRetrieveMode in interface TypedQuery<R>

Overrides:

setCacheRetrieveMode in class AbstractQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheStoreMode

public NativeQueryImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface NativeQuery<R>

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<R>

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

Specified by:

setCacheStoreMode in interface TypedQuery<R>

Overrides:

setCacheStoreMode in class AbstractQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setTimeout

public TypedQuery<R> setTimeout(Integer timeout)

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface TypedQuery<R>

setCacheable

public NativeQueryImplementor<R> setCacheable(boolean cacheable)

Description copied from interface: SelectionQuery

Enable/disable second level query (result) caching for this query.

Specified by:

setCacheable in interface NativeQuery<R>

Specified by:

setCacheable in interface NativeQueryImplementor<R>

Specified by:

setCacheable in interface Query<R>

Specified by:

setCacheable in interface SelectionQuery<R>

Overrides:

setCacheable in class AbstractQuery<R>

See Also:

• SelectionQuery.isCacheable()

setCacheRegion

public NativeQueryImplementor<R> setCacheRegion(String cacheRegion)

Description copied from interface: SelectionQuery

Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()). null indicates to use the default region.

Specified by:

setCacheRegion in interface NativeQuery<R>

Specified by:

setCacheRegion in interface NativeQueryImplementor<R>

Specified by:

setCacheRegion in interface Query<R>

Specified by:

setCacheRegion in interface SelectionQuery<R>

Overrides:

setCacheRegion in class AbstractQuery<R>

See Also:

• SelectionQuery.getCacheRegion()

setQueryPlanCacheable

public NativeQueryImplementor<R> setQueryPlanCacheable(boolean queryPlanCacheable)

Description copied from interface: SelectionQuery

Enable/disable query plan caching for this query.

Specified by:

setQueryPlanCacheable in interface SelectionQuery<R>

Overrides:

setQueryPlanCacheable in class AbstractQuery<R>

See Also:

• SelectionQuery.isQueryPlanCacheable()

setTimeout

public NativeQueryImplementor<R> setTimeout(int timeout)

Description copied from interface: CommonQueryContract

Set the query timeout in seconds.

Any value set here is eventually passed directly along to the JDBC statement, which expressly disallows negative values. So negative values should be avoided as a general rule, although certain "magic values" are handled - see Timeouts.NO_WAIT.

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface NativeQuery<R>

Specified by:

setTimeout in interface NativeQueryImplementor<R>

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Overrides:

setTimeout in class AbstractQuery<R>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

• Timeouts
• CommonQueryContract.setTimeout(Timeout)
• CommonQueryContract.getTimeout()

setFetchSize

public NativeQueryImplementor<R> setFetchSize(int fetchSize)

Description copied from interface: SelectionQuery

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface NativeQuery<R>

Specified by:

setFetchSize in interface NativeQueryImplementor<R>

Specified by:

setFetchSize in interface Query<R>

Specified by:

setFetchSize in interface SelectionQuery<R>

Overrides:

setFetchSize in class AbstractQuery<R>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()

setReadOnly

public NativeQueryImplementor<R> setReadOnly(boolean readOnly)

Description copied from interface: SelectionQuery

Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context, Session.isDefaultReadOnly().

To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, use Session.setDefaultReadOnly(boolean).

Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.

When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting.

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session beforeQuery the query was executed.

Specified by:

setReadOnly in interface NativeQuery<R>

Specified by:

setReadOnly in interface NativeQueryImplementor<R>

Specified by:

setReadOnly in interface Query<R>

Specified by:

setReadOnly in interface SelectionQuery<R>

Overrides:

setReadOnly in class AbstractQuery<R>

Parameters:

readOnly - true indicates that entities and proxies loaded by the query are to be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode

Returns:

this, for method chaining

unwrap

public <T> T unwrap(Class<T> type)

Specified by:

unwrap in interface Query

setComment

public NativeQueryImplementor<R> setComment(String comment)

Description copied from interface: CommonQueryContract

Set a comment for this query.

Specified by:

setComment in interface CommonQueryContract

Specified by:

setComment in interface MutationQuery

Specified by:

setComment in interface NativeQuery<R>

Specified by:

setComment in interface NativeQueryImplementor<R>

Specified by:

setComment in interface Query<R>

Specified by:

setComment in interface SelectionQuery<R>

Overrides:

setComment in class AbstractQuery<R>

Parameters:

comment - The human-readable comment

Returns:

this, for method chaining

See Also:

• Query.setComment(String)

addQueryHint

public NativeQueryImplementor<R> addQueryHint(String hint)

Description copied from interface: Query

Add a database query hint to the SQL query.

A database hint is a completely different concept to a JPA hint specified using QueryHint or Query.getHints(). These are hints to the JPA provider.

Multiple query hints may be specified. The operation Dialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.

Specified by:

addQueryHint in interface NativeQuery<R>

Specified by:

addQueryHint in interface NativeQueryImplementor<R>

Specified by:

addQueryHint in interface Query<R>

Overrides:

addQueryHint in class AbstractQuery<R>

Parameters:

hint - The database specific query hint to add.

collectHints

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

Overrides:

collectHints in class AbstractQuery<R>

applySynchronizeSpacesHint

protected void applySynchronizeSpacesHint(Object value)

Overrides:

applySynchronizeSpacesHint in class AbstractCommonQueryContract

applySynchronizeSpace

protected void applySynchronizeSpace(Object value)

setParameter

public NativeQueryImplementor<R> setParameter(String name,
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, Type)
• TypedParameterValue

setParameter

public <P> NativeQueryImplementor<R> setParameter(String name,
 P value,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

public <P> NativeQueryImplementor<R> setParameter(String name,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(String name,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(String name,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(String name,
 Date value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

public NativeQueryImplementor<R> setParameter(int position,
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, Type)
• TypedParameterValue

setParameter

public <P> NativeQueryImplementor<R> setParameter(int position,
 P value,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

public <P> NativeQueryImplementor<R> setParameter(int position,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(int position,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(int position,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(int position,
 Date value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

public <P> NativeQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P value)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> NativeQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P value,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

javaTypeClass - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> NativeQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

public <P> NativeQueryImplementor<R> setParameter(Parameter<P> parameter,
 P value)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated
public NativeQueryImplementor<R> setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface NativeQueryImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

public NativeQueryImplementor<R> setParameterList(String name,
 Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(String name,
 Collection<? extends P> values,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(String name,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public NativeQueryImplementor<R> setParameterList(String name,
 Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(String name,
 P[] values,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use. If unable to determine an appropriate Type, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, Object[], Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(String name,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public NativeQueryImplementor<R> setParameterList(int position,
 Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(int position,
 Collection<? extends P> values,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(int position,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public NativeQueryImplementor<R> setParameterList(int position,
 Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(int position,
 P[] values,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Object[], Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(int position,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
 P[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Class<P> javaTypeClass)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, Object[], Type)

setParameterList

public <P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface NativeQueryImplementor<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Overrides:

setParameterList in class AbstractQuery<R>

Returns:

this, for method chaining

setProperties

public NativeQueryImplementor<R> setProperties(Map map)

Description copied from interface: CommonQueryContract

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.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface NativeQuery<R>

Specified by:

setProperties in interface NativeQueryImplementor<R>

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Overrides:

setProperties in class AbstractQuery<R>

Parameters:

map - a Map of names to arguments

Returns:

this, for method chaining

setProperties

public NativeQueryImplementor<R> setProperties(Object bean)

Description copied from interface: CommonQueryContract

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.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface NativeQuery<R>

Specified by:

setProperties in interface NativeQueryImplementor<R>

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Overrides:

setProperties in class AbstractQuery<R>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setResultTransformer

@Deprecated
public <S> NativeQueryImplementor<S> setResultTransformer(ResultTransformer<S> transformer)

Deprecated.

Specified by:

setResultTransformer in interface NativeQuery<R>

Specified by:

setResultTransformer in interface NativeQueryImplementor<R>

Specified by:

setResultTransformer in interface Query<R>

Specified by:

setResultTransformer in interface QueryImplementor<R>

setMaxResults

public NativeQueryImplementor<R> setMaxResults(int maxResults)

Description copied from interface: SelectionQuery

Set the maximum number of query result rows to return.

Specified by:

setMaxResults in interface NativeQuery<R>

Specified by:

setMaxResults in interface NativeQueryImplementor<R>

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<R>

Specified by:

setMaxResults in interface SelectionQuery<R>

Specified by:

setMaxResults in interface TypedQuery<R>

Overrides:

setMaxResults in class AbstractQuery<R>

Parameters:

maxResults - the maximum length of the query result list

setFirstResult

public NativeQueryImplementor<R> setFirstResult(int startPosition)

Description copied from interface: SelectionQuery

Set the first query result row to return. The very first row of the query result list is considered the zeroth row.

Specified by:

setFirstResult in interface NativeQuery<R>

Specified by:

setFirstResult in interface NativeQueryImplementor<R>

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<R>

Specified by:

setFirstResult in interface SelectionQuery<R>

Specified by:

setFirstResult in interface TypedQuery<R>

Overrides:

setFirstResult in class AbstractQuery<R>

Parameters:

startPosition - the position of the first row to return, indexed from zero

setHint

public NativeQueryImplementor<R> setHint(String hintName,
 Object value)

Description copied from interface: CommonQueryContract

Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface MutationQuery

Specified by:

setHint in interface NativeQuery<R>

Specified by:

setHint in interface NativeQueryImplementor<R>

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface TypedQuery<R>

Overrides:

setHint in class AbstractQuery<R>

See Also:

• HibernateHints
• SpecHints