Package org.hibernate.query.spi

Class AbstractQuery<R>

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

All Implemented Interfaces:: Query,TypedQuery<R>,CommonQueryContract,MutationQuery,Query<R>,SelectionQuery<R>,DomainQueryExecutionContext,QueryImplementor<R>

Direct Known Subclasses:: NativeQueryImpl,ProcedureCallImpl

public abstract classAbstractQuery<R>extendsAbstractSelectionQuery<R>implementsQueryImplementor<R>

Field Summary
Fields inherited from class org.hibernate.query.spi.AbstractSelectionQuery
CRITERIA_HQL_STRING
Constructor Summary
Constructors
Constructor
Description
AbstractQuery(SharedSessionContractImplementor session)
Method Summary
Modifier and Type
Method
Description
QueryImplementor<R>
addQueryHint(String hint)
Add a database query hint to the SQL query.
protected void
applyOptions(NamedQueryMemento<?> memento)

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

QueryImplementor<R>
disableFetchProfile(String profileName)
Disable thefetch profile with the given name in this session.
protected abstract int
doExecuteUpdate()

QueryImplementor<R>
enableFetchProfile(String profileName)
Enable thefetch profile with the given name during execution of this query.
int
executeUpdate()
Execute an insert, update, or delete statement, and return the number of affected entities.
String
getComment()
Get the comment that has been set for this query, if any.
int
getFirstResult()
The first query result row to return.
KeyedResultList<R>
getKeyedResultList(KeyedPage<R> keyedPage)
Execute the query and return the results for the givenpage, using key-based pagination.
LockModeType
getLockMode()
Get the rootLockModeType for the query
LockOptions
getLockOptions()
Deprecated.
int
getMaxResults()
The maximum number of query result rows to return.
Set<Parameter<?>>
getParameters()

MutableQueryOptions
getQueryOptions()
Get the execution options for thisQuery.
Set<String>
getSupportedHints()

boolean
isCacheable()
Should the results of the query be stored in the second level cache?
protected void
prepareForExecution()

protected boolean
resolveJdbcParameterTypeIfNecessary()

QueryImplementor<R>
setCacheable(boolean cacheable)
Enable/disable second level query (result) caching for this query.
QueryImplementor<R>
setCacheMode(CacheMode cacheMode)
Set the currentCacheMode in effect for this query.
QueryImplementor<R>
setCacheRegion(String cacheRegion)
Set the name of the cache region where query results should be cached (assumingSelectionQuery.isCacheable()).
QueryImplementor<R>
setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

QueryImplementor<R>
setCacheStoreMode(CacheStoreMode cacheStoreMode)

QueryImplementor<R>
setComment(String comment)
Set a comment for this query.
QueryImplementor<R>
setEntityGraph(EntityGraph<? superR> graph,GraphSemantic semantic)
Apply anEntityGraph to the query.
QueryImplementor<R>
setFetchSize(int fetchSize)
Sets a JDBC fetch size hint for the query.
QueryImplementor<R>
setFirstResult(int startPosition)
Set the first query result row to return.
QueryImplementor<R>
setFlushMode(FlushModeType flushModeType)
Set theFlushMode to use for this query.
QueryImplementor<R>
setHibernateFlushMode(FlushMode flushMode)
Set the currentFlushMode in effect for this query.
QueryImplementor<R>
setHint(String hintName,Object value)
Set a hint.
QueryImplementor<R>
setLockMode(LockModeType lockModeType)
Specify the root LockModeType for the query
QueryImplementor<R>
setLockMode(String alias,LockMode lockMode)
Specify aLockMode to apply to a specific alias defined in the query
QueryImplementor<R>
setLockOptions(LockOptions lockOptions)
Deprecated.
QueryImplementor<R>
setLockScope(PessimisticLockScope lockScope)
Apply a scope to any pessimistic locking applied to the query.
QueryImplementor<R>
setMaxResults(int maxResults)
Set the maximum number of query result rows to return.
QueryImplementor<R>
setParameter(int position,Object value)
Bind the given argument to an ordinal query parameter.
QueryImplementor<R>
setParameter(int position,Instant value,TemporalType temporalType)
Deprecated.
QueryImplementor<R>
setParameter(int position,Calendar value,TemporalType temporalType)
Deprecated.
QueryImplementor<R>
setParameter(int position,Date value,TemporalType temporalType)
Deprecated.
 QueryImplementor<R>
setParameter(int position, P value,Type type)
Bind the given argument to an ordinal query parameter using the givenType.
 QueryImplementor<R>
setParameter(int position, P value,Class javaTypeClass)
Bind the given argument to an ordinal query parameter using the givenClass reference to attempt to infer theType.
QueryImplementor<R>
setParameter(Parameter<Calendar> param,Calendar value,TemporalType temporalType)
Deprecated.
QueryImplementor<R>
setParameter(Parameter<Date> param,Date value,TemporalType temporalType)
Deprecated.
 QueryImplementor<R>
setParameter(Parameter parameter, P value)
Query override
QueryImplementor<R>
setParameter(String name,Object value)
Bind the given argument to a named query parameter.
QueryImplementor<R>
setParameter(String name,Instant value,TemporalType temporalType)
Deprecated.
QueryImplementor<R>
setParameter(String name,Calendar value,TemporalType temporalType)
Deprecated.
QueryImplementor<R>
setParameter(String name,Date value,TemporalType temporalType)
Deprecated.
 QueryImplementor<R>
setParameter(String name, P value,Type type)
Bind the given argument to a named query parameter using the givenType.
 QueryImplementor<R>
setParameter(String name, P value,Class javaTypeClass)
Bind the given argument to a named query parameter using the givenClass reference to attempt to infer theType.
 QueryImplementor<R>
setParameter(QueryParameter parameter, P value)
Bind an argument to the query parameter represented by the givenQueryParameter.
 QueryImplementor<R>
setParameter(QueryParameter parameter, P value,Type type)
Bind an argument to the query parameter represented by the givenQueryParameter, using the givenType.
 QueryImplementor<R>
setParameter(QueryParameter parameter, P value,Class javaTypeClass)
Bind an argument to the query parameter represented by the givenQueryParameter, using the givenClass reference to attempt to infer theType to use.
QueryImplementor<R>
setParameterList(int position,Object[] values)
Bind multiple arguments to an ordinal query parameter.
QueryImplementor<R>
setParameterList(int position,Collection values)
Bind multiple arguments to an ordinal query parameter.
 QueryImplementor<R>
setParameterList(int position,Collection<? extends P> values,Type type)
Bind multiple arguments to an ordinal query parameter using the givenType.
 QueryImplementor<R>
setParameterList(int position,Collection<? extends P> values,Class javaTypeClass)
Bind multiple arguments to an ordinal query parameter using the givenClass reference to attempt to infer theType.
 QueryImplementor<R>
setParameterList(int position, P[] values,Type type)
Bind multiple arguments to an ordinal query parameter using the givenType.
 QueryImplementor<R>
setParameterList(int position, P[] values,Class javaTypeClass)
Bind multiple arguments to an ordinal query parameter using the givenClass reference to attempt to infer theType.
QueryImplementor<R>
setParameterList(String name,Object[] values)
Bind multiple arguments to a named query parameter.
QueryImplementor<R>
setParameterList(String name,Collection values)
Bind multiple arguments to a named query parameter.
 QueryImplementor<R>
setParameterList(String name,Collection<? extends P> values,Type type)
Bind multiple arguments to a named query parameter using the givenType.
 QueryImplementor<R>
setParameterList(String name,Collection<? extends P> values,Class javaTypeClass)
Bind multiple arguments to a named query parameter using the givenClass reference to attempt to infer theType If unable to infer an appropriateType, fall back toCommonQueryContract.setParameterList(String, Collection).
 QueryImplementor<R>
setParameterList(String name, P[] values,Type type)
Bind multiple arguments to a named query parameter using the givenType.
 QueryImplementor<R>
setParameterList(String name, P[] values,Class javaTypeClass)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType to use.
 QueryImplementor<R>
setParameterList(QueryParameter parameter,Collection<? extends P> values)
Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 QueryImplementor<R>
setParameterList(QueryParameter parameter,Collection<? extends P> values,Type type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter, using the givenType.
 QueryImplementor<R>
setParameterList(QueryParameter parameter,Collection<? extends P> values,Class javaTypeClass)
Bind multiple arguments to the query parameter represented by the givenQueryParameter using the givenClass reference to attempt to infer theType to use.
 QueryImplementor<R>
setParameterList(QueryParameter parameter, P[] values)
Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 QueryImplementor<R>
setParameterList(QueryParameter parameter, P[] values,Type type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter, using the given theType.
 QueryImplementor<R>
setParameterList(QueryParameter parameter, P[] values,Class javaTypeClass)
Bind multiple arguments to the query parameter represented by the givenQueryParameter using the givenClass reference to attempt to infer theType to use.
QueryImplementor<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.
QueryImplementor<R>
setProperties(Map map)
Bind the values of the givenMap to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
QueryImplementor<R>
setQueryFlushMode(QueryFlushMode queryFlushMode)
Set theQueryFlushMode to use for this query.
QueryImplementor<R>
setQueryPlanCacheable(boolean queryPlanCacheable)
Enable/disable query plan caching for this query.
QueryImplementor<R>
setReadOnly(boolean readOnly)
Set the read-only/modifiable mode for entities and proxies loaded by thisQuery.
QueryImplementor<R>
setResultListTransformer(ResultListTransformer<R> transformer)
Set aResultListTransformer.
QueryImplementor<R>
setTimeout(int timeout)
Set the query timeoutin seconds.
QueryImplementor<R>
setTimeout(Timeout timeout)
Apply a timeout to the corresponding database query.
<T> QueryImplementor<T>
setTupleTransformer(TupleTransformer<T> transformer)
Set aTupleTransformer.
Methods inherited from class org.hibernate.query.spi.AbstractSelectionQuery
afterQuery,afterQuery,afterQueryHandlingFetchProfiles,beforeQuery,beforeQueryHandlingFetchProfiles,doList,doScroll,getCacheMode,getCacheRegion,getCacheRetrieveMode,getCacheStoreMode,getCallback,getFetchSize,getFlushMode,getHibernateLockMode,getQueryString,getResultStream,getSingleResult,getSingleResultOrNull,hasCallbackActions,isQueryPlanCacheable,isReadOnly,list,requiresTxn,resetCallback,scroll,scroll,setFollowOnLocking,setHibernateLockMode,stream,uniqueElement,uniqueResult,uniqueResultOptional
Methods inherited from class org.hibernate.query.spi.AbstractCommonQueryContract
applyAliasSpecificLockModeHint,applyCommentHint,applyDatabaseHint,applyEntityGraphHint,applyFlushModeHint,applyFollowOnLockingHint,applyGraph,applyGraph,applyHibernateLockMode,applyHint,applyLockModeHint,applyLockModeType,applyLockTimeoutHint,applyLockTimeoutHint,applySelectionHint,applySynchronizeSpacesHint,applyTimeoutHint,determineType,getExceptionConverter,getHibernateFlushMode,getHints,getIntegerLiteral,getMaxRows,getParameter,getParameter,getParameter,getParameter,getParameterMetadata,getParameterValue,getParameterValue,getParameterValue,getQueryFlushMode,getQueryParameterBindings,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,getParameterMetadata,getQueryFlushMode,getTimeout
Methods inherited from interface org.hibernate.query.spi.DomainQueryExecutionContext
getQueryParameterBindings,getResultType,getSession
Methods inherited from interface jakarta.persistence.Query
getCacheRetrieveMode,getCacheStoreMode,getFlushMode,getHints,getParameter,getParameter,getParameter,getParameter,getParameterValue,getParameterValue,getParameterValue,getTimeout,isBound,unwrap
Methods inherited from interface org.hibernate.query.Query
applyFetchGraph,applyGraph,applyLoadGraph,getQueryString,getResultList,getResultStream,getSingleResult,list,setPage,stream,uniqueResult,uniqueResultOptional
Methods inherited from interface org.hibernate.query.spi.QueryImplementor
getParameterBindings,getSession,scroll,scroll,setResultTransformer
Methods inherited from interface org.hibernate.query.SelectionQuery
getCacheMode,getCacheRegion,getCacheRetrieveMode,getCacheStoreMode,getFetchSize,getHibernateLockMode,getResultCount,getSingleResultOrNull,isQueryPlanCacheable,isReadOnly,setFollowOnLocking,setHibernateLockMode
Methods inherited from interface jakarta.persistence.TypedQuery
getSingleResultOrNull,setTimeout

Constructor Details
- AbstractQuery
  public AbstractQuery(SharedSessionContractImplementor session)
Method Details
- applyOptions
 protected void applyOptions(NamedQueryMemento<?> memento)
 Overrides:
 applyOptions in class AbstractSelectionQuery<R>
- setHint
 public QueryImplementor<R> setHint(String hintName,Object value)
 Description copied from interface: CommonQueryContract
 Set a hint. The hints understood by Hibernate are enumerated byAvailableHints.
 Specified by:
 setHint in interface CommonQueryContract
 Specified by:
 setHint in interface MutationQuery
 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 AbstractSelectionQuery<R>
 See Also:
 HibernateHints
 SpecHints
- setEntityGraph
 public QueryImplementor<R> setEntityGraph(EntityGraph<? superR> graph,GraphSemantic semantic)
 Description copied from interface: SelectionQuery
 Apply anEntityGraph to the query.
 This is an alternative way to specify the associations which should be fetched as part of the initial query.
 Specified by:
 setEntityGraph in interface Query<R>
 Specified by:
 setEntityGraph in interface SelectionQuery<R>
 Overrides:
 setEntityGraph in class AbstractSelectionQuery<R>
- enableFetchProfile
 public QueryImplementor<R> enableFetchProfile(String profileName)
 Description copied from interface: SelectionQuery
 Enable thefetch profile with the given name during execution of this query. If the requested fetch profile is already enabled, the call has no effect.
 This is an alternative way to specify the associations which should be fetched as part of the initial query.
 Specified by:
 enableFetchProfile in interface Query<R>
 Specified by:
 enableFetchProfile in interface SelectionQuery<R>
 Overrides:
 enableFetchProfile in class AbstractSelectionQuery<R>
 Parameters:
 profileName - the name of the fetch profile to be enabled
 See Also:
 FetchProfile
- disableFetchProfile
 public QueryImplementor<R> disableFetchProfile(String profileName)
 Description copied from interface: SelectionQuery
 Disable thefetch profile with the given name in this session. If the fetch profile is not currently enabled, the call has no effect.
 Specified by:
 disableFetchProfile in interface Query<R>
 Specified by:
 disableFetchProfile in interface SelectionQuery<R>
 Overrides:
 disableFetchProfile in class AbstractSelectionQuery<R>
 Parameters:
 profileName - the name of the fetch profile to be disabled
 See Also:
 FetchProfile
- getQueryOptions
 public MutableQueryOptions getQueryOptions()
 Description copied from interface: Query
 Get the execution options for thisQuery. Many of the setters of this object update the state of the returnedQueryOptions. 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 AbstractCommonQueryContract
 Returns:
 Return the encapsulation of this query's options.
- getMaxResults
 public int getMaxResults()
 Description copied from interface: SelectionQuery
 The maximum number of query result rows to return.
 Specified by:
 getMaxResults in interface Query
 Specified by:
 getMaxResults in interface SelectionQuery<R>
 Overrides:
 getMaxResults in class AbstractCommonQueryContract
 Returns:
 the maximum length of the query result list
- setMaxResults
 public QueryImplementor<R> setMaxResults(int maxResults)
 Description copied from interface: SelectionQuery
 Set the maximum number of query result rows to return.
 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 AbstractSelectionQuery<R>
 Parameters:
 maxResults - the maximum length of the query result list
- getFirstResult
 public int getFirstResult()
 Description copied from interface: SelectionQuery
 The first query result row to return. The very first row of the query result list is considered the zeroth row.
 Specified by:
 getFirstResult in interface Query
 Specified by:
 getFirstResult in interface SelectionQuery<R>
 Overrides:
 getFirstResult in class AbstractCommonQueryContract
 Returns:
 the position of the first row to return, indexed from zero
- setFirstResult
 public QueryImplementor<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 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 AbstractSelectionQuery<R>
 Parameters:
 startPosition - the position of the first row to return, indexed from zero
- setTupleTransformer
 public <T> QueryImplementor<T> setTupleTransformer(TupleTransformer<T> transformer)
 Description copied from interface: Query
 Set aTupleTransformer.
 Specified by:
 setTupleTransformer in interface Query<R>
 Specified by:
 setTupleTransformer in interface QueryImplementor<R>
 Specified by:
 setTupleTransformer in interface SelectionQuery<R>
- setResultListTransformer
 public QueryImplementor<R> setResultListTransformer(ResultListTransformer<R> transformer)
 Description copied from interface: Query
 Set aResultListTransformer.
 Specified by:
 setResultListTransformer in interface Query<R>
 Specified by:
 setResultListTransformer in interface QueryImplementor<R>
 Specified by:
 setResultListTransformer in interface SelectionQuery<R>
- setHibernateFlushMode
 public QueryImplementor<R> setHibernateFlushMode(FlushMode flushMode)
 Description copied from interface: CommonQueryContract
 Set the currentFlushMode in effect for this query.
 Specified by:
 setHibernateFlushMode in interface CommonQueryContract
 Specified by:
 setHibernateFlushMode in interface MutationQuery
 Specified by:
 setHibernateFlushMode in interface Query<R>
 Specified by:
 setHibernateFlushMode in interface SelectionQuery<R>
 Overrides:
 setHibernateFlushMode in class AbstractSelectionQuery<R>
 See Also:
 CommonQueryContract.getQueryFlushMode()
 CommonQueryContract.getHibernateFlushMode()
 Session.getHibernateFlushMode()
- setQueryFlushMode
 public QueryImplementor<R> setQueryFlushMode(QueryFlushMode queryFlushMode)
 Description copied from interface: CommonQueryContract
 Set theQueryFlushMode to use for this query.
 Specified by:
 setQueryFlushMode in interface CommonQueryContract
 Specified by:
 setQueryFlushMode in interface MutationQuery
 Specified by:
 setQueryFlushMode in interface Query<R>
 Specified by:
 setQueryFlushMode in interface SelectionQuery<R>
 Overrides:
 setQueryFlushMode in class AbstractSelectionQuery<R>
 See Also:
 Session.getHibernateFlushMode()
- setFlushMode
 public QueryImplementor<R> setFlushMode(FlushModeType flushModeType)
 Description copied from interface: CommonQueryContract
 Set theFlushMode to use for this query.
 Setting this tonull ultimately indicates to use theFlushMode of the session. UseCommonQueryContract.setHibernateFlushMode(org.hibernate.FlushMode) passingFlushMode.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 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 AbstractSelectionQuery<R>
 See Also:
 CommonQueryContract.getQueryFlushMode()
 CommonQueryContract.getHibernateFlushMode()
 Session.getHibernateFlushMode()
- setCacheMode
 public QueryImplementor<R> setCacheMode(CacheMode cacheMode)
 Description copied from interface: SelectionQuery
 Set the currentCacheMode in effect for this query.
 Set it tonull to indicate that theCacheMode of thesession should be used.
 Specified by:
 setCacheMode in interface Query<R>
 Specified by:
 setCacheMode in interface SelectionQuery<R>
 Overrides:
 setCacheMode in class AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.getCacheMode()
 Session.setCacheMode(CacheMode)
- setCacheRetrieveMode
 public QueryImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
 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 AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.setCacheMode(CacheMode)
- setCacheStoreMode
 public QueryImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)
 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 AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.setCacheMode(CacheMode)
- isCacheable
 public boolean isCacheable()
 Description copied from interface: SelectionQuery
 Should the results of the query be stored in the second level cache?
 This is different to second level caching of any returned entities and collections, which is controlled bySelectionQuery.getCacheMode().
 The query being "eligible" for caching does not necessarily mean its results will be cached. Second-level query caching still has to be enabled on theSessionFactory for this to happen. Usually that is controlled by the configuration setting"hibernate.cache.use_query_cache".
 Specified by:
 isCacheable in interface SelectionQuery<R>
 Overrides:
 isCacheable in class AbstractSelectionQuery<R>
- setCacheable
 public QueryImplementor<R> setCacheable(boolean cacheable)
 Description copied from interface: SelectionQuery
 Enable/disable second level query (result) caching for this query.
 Specified by:
 setCacheable in interface Query<R>
 Specified by:
 setCacheable in interface SelectionQuery<R>
 Overrides:
 setCacheable in class AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.isCacheable()
- setCacheRegion
 public QueryImplementor<R> setCacheRegion(String cacheRegion)
 Description copied from interface: SelectionQuery
 Set the name of the cache region where query results should be cached (assumingSelectionQuery.isCacheable()).null indicates to use the default region.
 Specified by:
 setCacheRegion in interface Query<R>
 Specified by:
 setCacheRegion in interface SelectionQuery<R>
 Overrides:
 setCacheRegion in class AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.getCacheRegion()
- setQueryPlanCacheable
 public QueryImplementor<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 AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.isQueryPlanCacheable()
- setTimeout
 public QueryImplementor<R> setTimeout(int timeout)
 Description copied from interface: CommonQueryContract
 Set the query timeoutin seconds.
 Any value set here is eventually passed directly along to theJDBC statement, which expressly disallows negative values. So negative values should be avoidedas a general rule, although certain "magic values" are handled - seeTimeouts.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 Query<R>
 Specified by:
 setTimeout in interface SelectionQuery<R>
 Overrides:
 setTimeout in class AbstractSelectionQuery<R>
 Parameters:
 timeout - the timeoutin seconds
 Returns:
 this, for method chaining
 See Also:
 Timeouts
 CommonQueryContract.setTimeout(Timeout)
 CommonQueryContract.getTimeout()
- setFetchSize
 public QueryImplementor<R> setFetchSize(int fetchSize)
 Description copied from interface: SelectionQuery
 Sets a JDBC fetch size hint for the query.
 Specified by:
 setFetchSize in interface Query<R>
 Specified by:
 setFetchSize in interface SelectionQuery<R>
 Overrides:
 setFetchSize in class AbstractSelectionQuery<R>
 Parameters:
 fetchSize - the fetch size hint
 Returns:
 this, for method chaining
 See Also:
 SelectionQuery.getFetchSize()
- setReadOnly
 public QueryImplementor<R> setReadOnly(boolean readOnly)
 Description copied from interface: SelectionQuery
 Set the read-only/modifiable mode for entities and proxies loaded by thisQuery. 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, useSession.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 Query<R>
 Specified by:
 setReadOnly in interface SelectionQuery<R>
 Overrides:
 setReadOnly in class AbstractSelectionQuery<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
- getLockOptions
 @Deprecatedpublic LockOptions getLockOptions()
 Deprecated.
 Description copied from interface: SelectionQuery
 TheLockOptions currently in effect for the query
 Specified by:
 getLockOptions in interface Query<R>
 Specified by:
 getLockOptions in interface SelectionQuery<R>
 Overrides:
 getLockOptions in class AbstractSelectionQuery<R>
 Returns:
 TheLockOptions currently in effect
 See Also:
 LockOptions
- setLockOptions
 @Deprecatedpublic QueryImplementor<R> setLockOptions(LockOptions lockOptions)
 Deprecated.
 Description copied from interface: Query
 Apply the givenlock options to this query. Alias-specific lock modes in the given lock options are merged with any alias-specific lock mode which have already beenset. 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 Query<R>
 Parameters:
 lockOptions - The lock options to apply to the query.
 Returns:
 this, for method chaining
 See Also:
 Query.getLockOptions()
- getLockMode
 public LockModeType getLockMode()
 Description copied from interface: SelectionQuery
 Get the rootLockModeType for the query
 Specified by:
 getLockMode in interface Query
 Specified by:
 getLockMode in interface SelectionQuery<R>
 Overrides:
 getLockMode in class AbstractSelectionQuery<R>
 See Also:
 SelectionQuery.getHibernateLockMode()
- setLockMode
 public QueryImplementor<R> setLockMode(String alias,LockMode lockMode)
 Description copied from interface: SelectionQuery
 Specify aLockMode to apply to a specific alias defined in the query
 Specified by:
 setLockMode in interface Query<R>
 Specified by:
 setLockMode in interface SelectionQuery<R>
 Overrides:
 setLockMode in class AbstractSelectionQuery<R>
 Parameters:
 alias - A query alias
 lockMode - The lock mode to apply
 Returns:
 this, for method chaining
 See Also:
 SelectionQuery.setLockScope(jakarta.persistence.PessimisticLockScope)
- setLockMode
 public QueryImplementor<R> setLockMode(LockModeType lockModeType)
 Description copied from class: AbstractSelectionQuery
 Specify the root LockModeType for the query
 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 AbstractSelectionQuery<R>
 See Also:
 AbstractSelectionQuery.setHibernateLockMode(org.hibernate.LockMode)
- setLockScope
 public QueryImplementor<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 Query<R>
 Specified by:
 setLockScope in interface SelectionQuery<R>
 Overrides:
 setLockScope in class AbstractSelectionQuery<R>
 Parameters:
 lockScope - The lock scope to apply
 Returns:
 this, for method chaining
- setTimeout
 public QueryImplementor<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 Query<R>
 Overrides:
 setTimeout in class AbstractSelectionQuery<R>
 Parameters:
 timeout - The timeout to apply
 Returns:
 this, for method chaining
- getComment
 public String getComment()
 Description copied from interface: CommonQueryContract
 Get the comment that has been set for this query, if any.
 Specified by:
 getComment in interface CommonQueryContract
 Specified by:
 getComment in interface Query<R>
 Overrides:
 getComment in class AbstractCommonQueryContract
 Returns:
 The comment.
- setComment
 public QueryImplementor<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 Query<R>
 Specified by:
 setComment in interface SelectionQuery<R>
 Overrides:
 setComment in class AbstractSelectionQuery<R>
 Parameters:
 comment - The human-readable comment
 Returns:
 this, for method chaining
 See Also:
 Query.setComment(String)
- addQueryHint
 public QueryImplementor<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 usingQueryHint orQuery.getHints(). These are hints to the JPA provider.
 Multiple query hints may be specified. The operationDialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.
 Specified by:
 addQueryHint in interface Query<R>
 Parameters:
 hint - The database specific query hint to add.
- getSupportedHints
 public Set<String> getSupportedHints()
- collectHints
 protected void collectHints(Map<String,Object> hints)
 Overrides:
 collectHints in class AbstractSelectionQuery<R>
- resolveJdbcParameterTypeIfNecessary
 protected boolean resolveJdbcParameterTypeIfNecessary()
 Specified by:
 resolveJdbcParameterTypeIfNecessary in class AbstractCommonQueryContract
- getParameters
 public Set<Parameter<?>> getParameters()
 Specified by:
 getParameters in interface Query
 Overrides:
 getParameters in class AbstractCommonQueryContract
- setParameter
 public QueryImplementor<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 aTypedParameterValue.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
 See Also:
 CommonQueryContract.setParameter(String, Object, Class)
 CommonQueryContract.setParameter(String, Object, Type)
 TypedParameterValue
- setParameter
 public QueryImplementor<R> setParameter(String name, P value,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind the given argument to a named query parameter using the givenClass reference to attempt to infer theType. If unable to infer an appropriateType, fall back toCommonQueryContract.setParameter(String, Object).
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
 See Also:
 CommonQueryContract.setParameter(String, Object, Type)
- setParameter
 public QueryImplementor<R> setParameter(String name, P value,Type type)
 Description copied from interface: CommonQueryContract
 Bind the given argument to a named query parameter using the givenType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
- setParameter
 @Deprecatedpublic QueryImplementor<R> setParameter(String name,Instant value,TemporalType temporalType)
 Deprecated.
 Description copied from interface: CommonQueryContract
 Bind anInstant to the named query parameter using just the portion indicated by the givenTemporalType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
- setParameter
 public QueryImplementor<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 aTypedParameterValue.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
 See Also:
 CommonQueryContract.setParameter(int, Object, Class)
 CommonQueryContract.setParameter(int, Object, Type)
 TypedParameterValue
- setParameter
 public QueryImplementor<R> setParameter(int position, P value,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind the given argument to an ordinal query parameter using the givenClass reference to attempt to infer theType. If unable to infer an appropriateType, fall back toCommonQueryContract.setParameter(int, Object).
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
 See Also:
 CommonQueryContract.setParameter(int, Object, Type)
- setParameter
 public QueryImplementor<R> setParameter(int position, P value,Type type)
 Description copied from interface: CommonQueryContract
 Bind the given argument to an ordinal query parameter using the givenType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
- setParameter
 @Deprecatedpublic QueryImplementor<R> setParameter(int position,Instant value,TemporalType temporalType)
 Deprecated.
 Description copied from interface: CommonQueryContract
 Bind anInstant to an ordinal query parameter using just the portion indicated by the givenTemporalType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
- setParameter
 public QueryImplementor<R> setParameter(QueryParameter parameter, P value)
 Description copied from interface: CommonQueryContract
 Bind an argument to the query parameter represented by the givenQueryParameter.
 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 Query<R>
 Specified by:
 setParameter in interface QueryImplementor<R>
 Specified by:
 setParameter in interface SelectionQuery<R>
 Overrides:
 setParameter in class AbstractSelectionQuery<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 QueryImplementor<R> setParameter(QueryParameter parameter, P value,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind an argument to the query parameter represented by the givenQueryParameter, using the givenClass reference to attempt to infer theType to use. If unable to infer an appropriateType, fall back toCommonQueryContract.setParameter(QueryParameter, Object).
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Parameters:
 parameter - the query parameter memento
 value - the argument, which might be null
 javaTypeClass - aType representing the type of the parameter
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameter(QueryParameter, Object, Type)
- setParameter
 public QueryImplementor<R> setParameter(QueryParameter parameter, P value,Type type)
 Description copied from interface: CommonQueryContract
 Bind an argument to the query parameter represented by the givenQueryParameter, using the givenType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Parameters:
 parameter - the query parameter memento
 value - the argument, which might be null
 type - aType representing the type of the parameter
 Returns:
 this, for method chaining
- setParameter
 public QueryImplementor<R> setParameter(Parameter 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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(Parameter, Object)
- setParameterList
 public QueryImplementor<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 Query<R>
 Specified by:
 setParameterList in interface QueryImplementor<R>
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Overrides:
 setParameterList in class AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)
- setParameterList
 public QueryImplementor<R> setParameterList(String name,Collection<? extends P> values,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to a named query parameter using the givenClass reference to attempt to infer theType If unable to infer an appropriateType, fall back toCommonQueryContract.setParameterList(String, Collection).
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)
- setParameterList
 public QueryImplementor<R> setParameterList(String name,Collection<? extends P> values,Type type)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to a named query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<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 Query<R>
 Specified by:
 setParameterList in interface QueryImplementor<R>
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Overrides:
 setParameterList in class AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(String name, P[] values,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,CommonQueryContract.setParameterList(String, Collection) is used
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(java.lang.String, Object[], Type)
- setParameterList
 public QueryImplementor<R> setParameterList(String name, P[] values,Type type)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to a named query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<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 Query<R>
 Specified by:
 setParameterList in interface QueryImplementor<R>
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Overrides:
 setParameterList in class AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(int position,Collection<? extends P> values,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to an ordinal query parameter using the givenClass reference to attempt to infer theType. If unable to infer an appropriateType, fall back toCommonQueryContract.setParameterList(String, Collection).
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(int, Collection, Type)
- setParameterList
 public QueryImplementor<R> setParameterList(int position,Collection<? extends P> values,Type type)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to an ordinal query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<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 Query<R>
 Specified by:
 setParameterList in interface QueryImplementor<R>
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Overrides:
 setParameterList in class AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(int position, P[] values,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to an ordinal query parameter using the givenClass reference to attempt to infer theType. If unable to infer an appropriateType, fall back toCommonQueryContract.setParameterList(String, Collection).
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(int, Object[], Type)
- setParameterList
 public QueryImplementor<R> setParameterList(int position, P[] values,Type type)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to an ordinal query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(QueryParameter parameter,Collection<? extends P> values)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 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 Query<R>
 Specified by:
 setParameterList in interface QueryImplementor<R>
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Overrides:
 setParameterList in class AbstractSelectionQuery<R>
 Parameters:
 parameter - the parameter memento
 values - a collection of arguments
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(QueryParameter parameter,Collection<? extends P> values,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to the query parameter represented by the givenQueryParameter using the givenClass reference to attempt to infer theType to use. If unable to infer an appropriateType, fall back to usingCommonQueryContract.setParameterList(String, Collection).
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, Type)
- setParameterList
 public QueryImplementor<R> setParameterList(QueryParameter parameter,Collection<? extends P> values,Type type)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to the query parameter represented by the givenQueryParameter, using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(QueryParameter parameter, P[] values)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 The type of the parameter is inferred between the context in which it occurs, the type associated with theQueryParameter 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 Query<R>
 Specified by:
 setParameterList in interface QueryImplementor<R>
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Overrides:
 setParameterList in class AbstractSelectionQuery<R>
 Parameters:
 parameter - the parameter memento
 values - a collection of arguments
 Returns:
 this, for method chaining
- setParameterList
 public QueryImplementor<R> setParameterList(QueryParameter parameter, P[] values,Class javaTypeClass)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to the query parameter represented by the givenQueryParameter using the givenClass reference to attempt to infer theType to use. If unable to infer an appropriateType, fall back to usingCommonQueryContract.setParameterList(String, Collection).
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 CommonQueryContract.setParameterList(QueryParameter, Object[], Type)
- setParameterList
 public QueryImplementor<R> setParameterList(QueryParameter parameter, P[] values,Type type)
 Description copied from interface: CommonQueryContract
 Bind multiple arguments to the query parameter represented by the givenQueryParameter, using the given theType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 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 AbstractSelectionQuery<R>
 Returns:
 this, for method chaining
- setParameter
 @Deprecatedpublic QueryImplementor<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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(Parameter, Calendar, TemporalType)
- setParameter
 @Deprecatedpublic QueryImplementor<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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(Parameter, Date, TemporalType)
- setParameter
 @Deprecatedpublic QueryImplementor<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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(String, Calendar, TemporalType)
- setParameter
 @Deprecatedpublic QueryImplementor<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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(String, Date, TemporalType)
- setParameter
 @Deprecatedpublic QueryImplementor<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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(int, Calendar, TemporalType)
- setParameter
 @Deprecatedpublic QueryImplementor<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 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 AbstractSelectionQuery<R>
 See Also:
 Query.setParameter(int, Date, TemporalType)
- setProperties
 public QueryImplementor<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 Query<R>
 Specified by:
 setProperties in interface QueryImplementor<R>
 Specified by:
 setProperties in interface SelectionQuery<R>
 Overrides:
 setProperties in class AbstractSelectionQuery<R>
 Parameters:
 bean - any JavaBean or POJO
 Returns:
 this, for method chaining
- setProperties
 public QueryImplementor<R> setProperties(Map map)
 Description copied from interface: CommonQueryContract
 Bind the values of the givenMap 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 Query<R>
 Specified by:
 setProperties in interface QueryImplementor<R>
 Specified by:
 setProperties in interface SelectionQuery<R>
 Overrides:
 setProperties in class AbstractSelectionQuery<R>
 Parameters:
 map - aMap of names to arguments
 Returns:
 this, for method chaining
- prepareForExecution
 protected void prepareForExecution()
 Specified by:
 prepareForExecution in class AbstractSelectionQuery<R>
- executeUpdate
 public int executeUpdate() throwsHibernateException
 Description copied from interface: Query
 Execute an insert, update, or delete statement, and return the number of affected entities.
 For use with instances ofMutationQuery created usingQueryProducer.createMutationQuery(String),QueryProducer.createNamedMutationQuery(String),QueryProducer.createNativeMutationQuery(String),QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate), orQueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaDelete).
 Specified by:
 executeUpdate in interface MutationQuery
 Specified by:
 executeUpdate in interface Query
 Specified by:
 executeUpdate in interface Query<R>
 Returns:
 the number of affected entity instances (may differ from the number of affected rows)
 Throws:
 HibernateException
 See Also:
 QueryProducer.createMutationQuery(java.lang.String)
 QueryProducer.createMutationQuery(String)
 QueryProducer.createNamedMutationQuery(String)
 QueryProducer.createNativeMutationQuery(String)
 QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate)
 QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaDelete)
 Query.executeUpdate()
- doExecuteUpdate
 protected abstract int doExecuteUpdate()
- getKeyedResultList
 public KeyedResultList<R> getKeyedResultList(KeyedPage<R> keyedPage)
 Description copied from interface: SelectionQuery
 Execute the query and return the results for the givenpage, using key-based pagination.
 Specified by:
 getKeyedResultList in interface SelectionQuery<R>
 Parameters:
 keyedPage - the key-based specification of the page as an instance ofKeyedPage
 Returns:
 the query results and the key of the next page as an instance ofKeyedResultList
 See Also:
 KeyedPage
 KeyedResultList

Movatterモバイル変換

Class AbstractQuery<R>

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.query.CommonQueryContract

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

Methods inherited from interface jakarta.persistence.Query

Methods inherited from interface org.hibernate.query.Query

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

Methods inherited from interface org.hibernate.query.SelectionQuery

Methods inherited from interface jakarta.persistence.TypedQuery

Constructor Details

AbstractQuery

Method Details

applyOptions

setHint

setEntityGraph

enableFetchProfile

disableFetchProfile

getQueryOptions

getMaxResults

setMaxResults

getFirstResult

setFirstResult

setTupleTransformer

setResultListTransformer

setHibernateFlushMode

setQueryFlushMode

setFlushMode

setCacheMode

setCacheRetrieveMode

setCacheStoreMode

isCacheable

setCacheable

setCacheRegion

setQueryPlanCacheable

setTimeout

setFetchSize

setReadOnly

getLockOptions

setLockOptions

getLockMode

setLockMode

setLockMode

setLockScope

setTimeout

getComment

setComment

addQueryHint

getSupportedHints

collectHints

resolveJdbcParameterTypeIfNecessary

getParameters

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList