Interface NativeQueryImplementor<R>

All Superinterfaces:

CommonQueryContract, CommonQueryContractImplementor, MutationQuery, MutationQueryImplementor<R>, NameableQuery, NativeQuery<R>, Query, Query<R>, QueryImplementor<R>, SelectionQuery<R>, SelectionQueryImplementor<R>, Statement, StatementReferenceProducer, SynchronizeableQuery, TypedQuery<R>, TypedQueryReferenceProducer

@Incubating
public interface NativeQueryImplementor<R>
extends SelectionQueryImplementor<R>, MutationQueryImplementor<R>, NativeQuery<R>, NameableQuery

Nested Class Summary

Nested classes/interfaces inherited from interface NativeQuery

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

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 entityType)	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.
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.
void	addResultTypeClass(Class<?> resultClass)
org.hibernate.query.results.internal.dynamic.DynamicResultBuilderEntityStandard	addRoot(String tableAlias, String entityName)	Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.
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> relationalJavaType, 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>> converter)	Declare a scalar query result with an explicit conversion.
NativeQueryImplementor<R>	addScalar(String columnAlias, BasicDomainType 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.
default NativeQueryImplementor<R>	asMutationQuery()	Casts this query as a mutation query.
NativeQueryImplementor<R>	asSelectionQuery()	Casts this query as a SelectionQuery.
<X> NativeQueryImplementor<X>	asSelectionQuery(EntityGraph<X> entityGraph)	Casts this query as a SelectionQuery with the given result graph.
<X> NativeQueryImplementor<X>	asSelectionQuery(Class<X> type)	Casts this query as a SelectionQuery with the given result type.
default NativeQueryImplementor<R>	asStatement()	Covariant override of Query.asStatement().
NativeQueryImplementor<R>	disableFetchProfile(String profileName)	Disable the fetch profile with the given name in this session.
NativeQueryImplementor<R>	enableFetchProfile(String profileName)	Enable the fetch profile with the given name during execution of this query.
int	execute()
int	executeUpdate()	Execute an insert, update, or delete statement, and return the number of affected entities.
CacheMode	getCacheMode()	Obtain the CacheMode in effect for this query.
CacheRetrieveMode	getCacheRetrieveMode()
CacheStoreMode	getCacheStoreMode()
int	getFirstResult()
LockMode	getHibernateLockMode()	Get the root LockMode for the query
LockModeType	getLockMode()
int	getMaxResults()
default List<R>	getResultList()	Execute the query and return the query results as a List.
default Stream<R>	getResultStream()	Execute the query and return the query results as a Stream.
R	getSingleResult()	Execute the query and return the single result of the query, throwing an exception if the query returns no results.
R	getSingleResultOrNull()	Execute the query and return the single result of the query, or null if the query returns no results.
Boolean	isSelectQuery()	Best guess whether this is a select query.
List<R>	list()	Execute the query and return the query results as a List.
<X> NativeQueryImplementor<X>	ofType(Class<X> type)	Covariant override of Query.ofType(Class).
ScrollableResultsImplementor<R>	scroll()	Returns scrollable access to the query results, using the default scroll mode of the SQL dialect.
ScrollableResultsImplementor<R>	scroll(ScrollMode scrollMode)	Returns scrollable access to the query results.
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 the comment for this query.
<P> NativeQueryImplementor<R>	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> NativeQueryImplementor<R>	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
NativeQueryImplementor<R>	setEntityGraph(EntityGraph<? super R> entityGraph)	Apply an EntityGraph to the query using load graph semantics.
NativeQueryImplementor<R>	setEntityGraph(EntityGraph<? super R> graph, GraphSemantic semantic)	Apply an EntityGraph to the query.
NativeQueryImplementor<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
NativeQueryImplementor<R>	setFirstResult(int startPosition)
NativeQueryImplementor<R>	setFlushMode(FlushModeType flushMode)	Deprecated.
NativeQueryImplementor<R>	setFollowOnStrategy(Locking.FollowOn followOnStrategy)	Specifies whether follow-on locking should be applied
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 lockMode)
NativeQueryImplementor<R>	setLockScope(PessimisticLockScope lockScope)	Apply a scope to any pessimistic locking applied to the query.
NativeQueryImplementor<R>	setMaxResults(int maxResults)
NativeQueryImplementor<R>	setPage(Page page)	Set the page of results to return.
NativeQueryImplementor<R>	setParameter(int position, Object val)	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 val, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameter(int position, P val, Class<P> type)	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> param, P value)
NativeQueryImplementor<R>	setParameter(String name, Object val)	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 val, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> NativeQueryImplementor<R>	setParameter(String name, P val, Class<P> type)	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 val)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> NativeQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P val, 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 val, Class<P> type)	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> type)	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> javaType)	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> type)	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> type)	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> javaType)	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> javaType)	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 bean)	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.
NativeQueryImplementor<R>	setTimeout(int timeout)	Apply a timeout to the corresponding database query.
NativeQueryImplementor<R>	setTimeout(Timeout timeout)	Apply a timeout to the corresponding database query.
NativeQueryImplementor<R>	setTimeout(Integer timeout)	Apply a timeout to the corresponding database query.
<X> NativeQueryImplementor<X>	setTupleTransformer(TupleTransformer<X> transformer)	Set a TupleTransformer.
default Stream<R>	stream()	Execute the query and return the query results as a Stream.
NamedNativeQueryMemento<?>	toMemento(String name)	Convert this query into the memento.
NamedMutationMemento<?>	toMutationMemento(String name)
org.hibernate.query.named.internal.NativeSelectionMementoImpl<R>	toSelectionMemento(String name)
R	uniqueResult()	Execute the query and return the single result of the query, or null if the query returns no results.
Optional<R>	uniqueResultOptional()	Execute the query and return the single result of the query, as an Optional.
<X> NativeQueryImplementor<X>	withEntityGraph(EntityGraph<X> entityGraph)	Covariant override of Query.withEntityGraph(EntityGraph).

Methods inherited from interface CommonQueryContract

asSelectionQuery, getComment, getEffectiveFlushMode, getQueryFlushMode, getTimeout

Methods inherited from interface CommonQueryContractImplementor

getSession

Methods inherited from interface MutationQueryImplementor

getMutationString, getParameterMetadata, getTargetType

Methods inherited from interface NativeQuery

addFetch, addInstantiation, addRoot, addScalar

Methods inherited from interface Query

getHints, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Methods inherited from interface Query

getFlushMode, getLockTimeout, getQueryOptions, getQueryString

Methods inherited from interface QueryImplementor

getParameterBindings

Methods inherited from interface SelectionQuery

getCacheRegion, getFetchSize, getKeyedResultList, getResultCount, getResultType, isCacheable, isQueryPlanCacheable, isReadOnly

Methods inherited from interface SelectionQueryImplementor

setFollowOnLockingStrategy, setLockTimeout

Methods inherited from interface SynchronizeableQuery

getSynchronizedQuerySpaces

Methods inherited from interface TypedQuery

getEntityGraph, getLockScope

Method Details

isSelectQuery

Boolean isSelectQuery()

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

toMemento

NamedNativeQueryMemento<?> toMemento(String name)

Description copied from interface: NameableQuery

Convert this query into the memento.

Specified by:

toMemento in interface NameableQuery

See Also:

• EntityManagerFactory.addNamedQuery(String, Query)
• NamedObjectRepository.registerNamedQuery(String, TypedQuery)
• NamedObjectRepository.registerNamedMutation(String, Statement)
• NamedObjectRepository.registerCallableQueryMemento(String, NamedCallableQueryMemento)

toMutationMemento

NamedMutationMemento<?> toMutationMemento(String name)

Specified by:

toMutationMemento in interface StatementReferenceProducer

asMutationQuery

default NativeQueryImplementor<R> asMutationQuery()

Description copied from interface: CommonQueryContract

Casts this query as a mutation query.

Specified by:

asMutationQuery in interface CommonQueryContract

Specified by:

asMutationQuery in interface CommonQueryContractImplementor

Specified by:

asMutationQuery in interface MutationQueryImplementor<R>

Specified by:

asMutationQuery in interface QueryImplementor<R>

Specified by:

asMutationQuery in interface SelectionQueryImplementor<R>

asStatement

default NativeQueryImplementor<R> asStatement()

Description copied from interface: Query

Covariant override of Query.asStatement().

Specified by:

asStatement in interface CommonQueryContractImplementor

Specified by:

asStatement in interface MutationQueryImplementor<R>

Specified by:

asStatement in interface Query

Specified by:

asStatement in interface Query<R>

Specified by:

asStatement in interface QueryImplementor<R>

Specified by:

asStatement in interface SelectionQueryImplementor<R>

See Also:

• CommonQueryContract.asMutationQuery()

asSelectionQuery

NativeQueryImplementor<R> asSelectionQuery()

Description copied from interface: CommonQueryContract

Casts this query as a SelectionQuery.

Specified by:

asSelectionQuery in interface CommonQueryContract

Specified by:

asSelectionQuery in interface CommonQueryContractImplementor

Specified by:

asSelectionQuery in interface Query<R>

Specified by:

asSelectionQuery in interface QueryImplementor<R>

asSelectionQuery

<X> NativeQueryImplementor<X> asSelectionQuery(Class<X> type)

Description copied from interface: CommonQueryContract

Casts this query as a SelectionQuery with the given result type.

Specified by:

asSelectionQuery in interface CommonQueryContract

Specified by:

asSelectionQuery in interface CommonQueryContractImplementor

asSelectionQuery

<X> NativeQueryImplementor<X> asSelectionQuery(EntityGraph<X> entityGraph)

Description copied from interface: CommonQueryContract

Casts this query as a SelectionQuery with the given result graph.

Specified by:

asSelectionQuery in interface CommonQueryContract

Specified by:

asSelectionQuery in interface CommonQueryContractImplementor

ofType

<X> NativeQueryImplementor<X> ofType(Class<X> type)

Description copied from interface: Query

Covariant override of Query.ofType(Class).

Specified by:

ofType in interface CommonQueryContractImplementor

Specified by:

ofType in interface MutationQueryImplementor<R>

Specified by:

ofType in interface Query

Specified by:

ofType in interface Query<R>

See Also:

• CommonQueryContract.asSelectionQuery(Class)

list

List<R> list()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

list in interface MutationQueryImplementor<R>

Specified by:

list in interface Query<R>

Specified by:

list in interface SelectionQuery<R>

Returns:

the result list

getResultList

default List<R> getResultList()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

getResultList in interface MutationQueryImplementor<R>

Specified by:

getResultList in interface Query

Specified by:

getResultList in interface Query<R>

Specified by:

getResultList in interface SelectionQuery<R>

Specified by:

getResultList in interface TypedQuery<R>

Returns:

the results as a list

scroll

ScrollableResultsImplementor<R> scroll()

Description copied from interface: SelectionQuery

Returns scrollable access to the query results, using the default scroll mode of the SQL dialect.

Specified by:

scroll in interface MutationQueryImplementor<R>

Specified by:

scroll in interface Query<R>

Specified by:

scroll in interface QueryImplementor<R>

Specified by:

scroll in interface SelectionQuery<R>

Specified by:

scroll in interface SelectionQueryImplementor<R>

See Also:

• SelectionQuery.scroll(ScrollMode)

scroll

ScrollableResultsImplementor<R> scroll(ScrollMode scrollMode)

Description copied from interface: SelectionQuery

Returns scrollable access to the query results. The capabilities of the returned ScrollableResults depend on the specified ScrollMode.

Specified by:

scroll in interface MutationQueryImplementor<R>

Specified by:

scroll in interface Query<R>

Specified by:

scroll in interface QueryImplementor<R>

Specified by:

scroll in interface SelectionQuery<R>

Specified by:

scroll in interface SelectionQueryImplementor<R>

getResultStream

default Stream<R> getResultStream()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

getResultStream in interface MutationQueryImplementor<R>

Specified by:

getResultStream in interface Query

Specified by:

getResultStream in interface Query<R>

Specified by:

getResultStream in interface SelectionQuery<R>

Specified by:

getResultStream in interface TypedQuery<R>

Returns:

The results as a Stream

stream

default Stream<R> stream()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

stream in interface MutationQueryImplementor<R>

Specified by:

stream in interface Query<R>

Specified by:

stream in interface SelectionQuery<R>

Returns:

The results as a Stream

uniqueResult

R uniqueResult()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, or null if the query returns no results.

Specified by:

uniqueResult in interface MutationQueryImplementor<R>

Specified by:

uniqueResult in interface Query<R>

Specified by:

uniqueResult in interface SelectionQuery<R>

Returns:

the single result or null

uniqueResultOptional

Optional<R> uniqueResultOptional()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, as an Optional.

Specified by:

uniqueResultOptional in interface MutationQueryImplementor<R>

Specified by:

uniqueResultOptional in interface Query<R>

Specified by:

uniqueResultOptional in interface SelectionQuery<R>

Returns:

the single result as an Optional

getSingleResult

R getSingleResult()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, throwing an exception if the query returns no results.

Specified by:

getSingleResult in interface MutationQueryImplementor<R>

Specified by:

getSingleResult in interface Query

Specified by:

getSingleResult in interface Query<R>

Specified by:

getSingleResult in interface SelectionQuery<R>

Specified by:

getSingleResult in interface TypedQuery<R>

Returns:

the single result, only if there is exactly one

getSingleResultOrNull

R getSingleResultOrNull()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, or null if the query returns no results.

Specified by:

getSingleResultOrNull in interface MutationQueryImplementor<R>

Specified by:

getSingleResultOrNull in interface Query

Specified by:

getSingleResultOrNull in interface SelectionQuery<R>

Specified by:

getSingleResultOrNull in interface TypedQuery<R>

Returns:

the single result or null if there is no result to return

execute

int execute()

Specified by:

execute in interface Statement

executeUpdate

int executeUpdate()

Description copied from interface: Query

Execute an insert, update, or delete statement, and return the number of affected entities.

For use with instances of MutationQuery created using SharedSessionContract.createMutationQuery(String), SharedSessionContract.createNamedMutationQuery(String), SharedSessionContract.createNativeMutationQuery(String), or SharedSessionContract.createMutationQuery(jakarta.persistence.criteria.CriteriaStatement).

Specified by:

executeUpdate in interface MutationQuery

Specified by:

executeUpdate in interface Query

Specified by:

executeUpdate in interface Query<R>

Specified by:

executeUpdate in interface SelectionQueryImplementor<R>

Specified by:

executeUpdate in interface TypedQuery<R>

Returns:

the number of affected entity instances (may differ from the number of affected rows)

See Also:

• Query.executeUpdate()

toSelectionMemento

org.hibernate.query.named.internal.NativeSelectionMementoImpl<R> toSelectionMemento(String name)

Specified by:

toSelectionMemento in interface TypedQueryReferenceProducer

addSynchronizedQuerySpace

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 SynchronizeableQuery

Parameters:

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

Returns:

this, for method chaining

addSynchronizedEntityName

NativeQueryImplementor<R> addSynchronizedEntityName(String entityName)
                                             throws MappingException

Description copied from interface: SynchronizeableQuery

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

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

Specified by:

addSynchronizedEntityName in interface NativeQuery<R>

Specified by:

addSynchronizedEntityName in interface SynchronizeableQuery

Parameters:

entityName - The name of an entity.

Returns:

this, for method chaining

Throws:

MappingException - Indicates the given name could not be resolved as an entity

addSynchronizedEntityClass

NativeQueryImplementor<R> addSynchronizedEntityClass(Class entityClass)
                                              throws MappingException

Description copied from interface: SynchronizeableQuery

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

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

Specified by:

addSynchronizedEntityClass in interface NativeQuery<R>

Specified by:

addSynchronizedEntityClass in interface SynchronizeableQuery

Parameters:

entityClass - The class of the entity.

Returns:

this, for method chaining

Throws:

MappingException - Indicates the given class could not be resolved as an entity

setHint

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

Description copied from interface: Query

Set a hint. Hints are a JPA-standard way to control provider-specific behavior affecting execution of the query. Clients of native Hibernate API should make use of type-safe operations of this interface and of its subtypes. For example, SelectionQuery.setCacheRegion(String) is preferred over HibernateHints.HINT_CACHE_REGION.

The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface CommonQueryContractImplementor

Specified by:

setHint in interface MutationQuery

Specified by:

setHint in interface MutationQueryImplementor<R>

Specified by:

setHint in interface NativeQuery<R>

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface QueryImplementor<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface SelectionQueryImplementor<R>

Specified by:

setHint in interface Statement

Specified by:

setHint in interface TypedQuery<R>

See Also:

• HibernateHints
• SpecHints

setTimeout

NativeQueryImplementor<R> setTimeout(int timeout)

Description copied from interface: Query

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface MutationQueryImplementor<R>

Specified by:

setTimeout in interface NativeQuery<R>

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface QueryImplementor<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Specified by:

setTimeout in interface SelectionQueryImplementor<R>

See Also:

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

setTimeout

NativeQueryImplementor<R> setTimeout(Integer timeout)

Description copied from interface: Query

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface MutationQueryImplementor<R>

Specified by:

setTimeout in interface NativeQuery<R>

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface QueryImplementor<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Specified by:

setTimeout in interface SelectionQueryImplementor<R>

Specified by:

setTimeout in interface Statement

Specified by:

setTimeout in interface TypedQuery<R>

See Also:

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

setTimeout

NativeQueryImplementor<R> setTimeout(Timeout timeout)

Description copied from interface: Query

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface MutationQueryImplementor<R>

Specified by:

setTimeout in interface NativeQuery<R>

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface QueryImplementor<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Specified by:

setTimeout in interface SelectionQueryImplementor<R>

Specified by:

setTimeout in interface Statement

Specified by:

setTimeout in interface TypedQuery<R>

Parameters:

timeout - The timeout to apply

Returns:

this, for method chaining

setQueryFlushMode

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 CommonQueryContractImplementor

Specified by:

setQueryFlushMode in interface MutationQuery

Specified by:

setQueryFlushMode in interface MutationQueryImplementor<R>

Specified by:

setQueryFlushMode in interface NativeQuery<R>

Specified by:

setQueryFlushMode in interface Query<R>

Specified by:

setQueryFlushMode in interface QueryImplementor<R>

Specified by:

setQueryFlushMode in interface SelectionQuery<R>

Specified by:

setQueryFlushMode in interface SelectionQueryImplementor<R>

See Also:

• Session.getHibernateFlushMode()

setFlushMode

@Deprecated(since="7")
NativeQueryImplementor<R> setFlushMode(FlushModeType flushMode)

Deprecated.

Description copied from interface: Query

Set the FlushModeType to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use Query.setQueryFlushMode(QueryFlushMode) passing QueryFlushMode.NO_FLUSH instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface CommonQueryContractImplementor

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface MutationQueryImplementor<R>

Specified by:

setFlushMode in interface NativeQuery<R>

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface QueryImplementor<R>

Specified by:

setFlushMode in interface SelectionQuery<R>

Specified by:

setFlushMode in interface SelectionQueryImplementor<R>

Specified by:

setFlushMode in interface Statement

Specified by:

setFlushMode in interface TypedQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• Query.setQueryFlushMode(QueryFlushMode)
• Session.getHibernateFlushMode()

setQueryPlanCacheable

NativeQueryImplementor<R> setQueryPlanCacheable(boolean queryPlanCacheable)

Description copied from interface: SelectionQuery

Enable/disable query plan caching for this query.

Specified by:

setQueryPlanCacheable in interface NativeQuery<R>

Specified by:

setQueryPlanCacheable in interface Query<R>

Specified by:

setQueryPlanCacheable in interface QueryImplementor<R>

Specified by:

setQueryPlanCacheable in interface SelectionQuery<R>

Specified by:

setQueryPlanCacheable in interface SelectionQueryImplementor<R>

See Also:

• SelectionQuery.isQueryPlanCacheable()

setCacheable

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 Query<R>

Specified by:

setCacheable in interface SelectionQuery<R>

Specified by:

setCacheable in interface SelectionQueryImplementor<R>

See Also:

• SelectionQuery.isCacheable()

setCacheMode

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 Query<R>

Specified by:

setCacheMode in interface SelectionQuery<R>

Specified by:

setCacheMode in interface SelectionQueryImplementor<R>

See Also:

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

getCacheMode

CacheMode getCacheMode()

Description copied from interface: SelectionQuery

Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the session from which it originates.

The CacheMode here affects the use of entity and collection caches as the query result set is processed. For caching of the actual query results, use SelectionQuery.isCacheable() and SelectionQuery.getCacheRegion().

In order for this setting to have any affect, second-level caching must be enabled and the entities and collections must be eligible for storage in the second-level cache.

Specified by:

getCacheMode in interface Query<R>

Specified by:

getCacheMode in interface SelectionQuery<R>

See Also:

• Session.getCacheMode()

getCacheStoreMode

CacheStoreMode getCacheStoreMode()

Specified by:

getCacheStoreMode in interface MutationQueryImplementor<R>

Specified by:

getCacheStoreMode in interface Query

Specified by:

getCacheStoreMode in interface SelectionQuery<R>

Specified by:

getCacheStoreMode in interface TypedQuery<R>

See Also:

• SelectionQuery.getCacheMode()

getCacheRetrieveMode

CacheRetrieveMode getCacheRetrieveMode()

Specified by:

getCacheRetrieveMode in interface MutationQueryImplementor<R>

Specified by:

getCacheRetrieveMode in interface Query

Specified by:

getCacheRetrieveMode in interface SelectionQuery<R>

Specified by:

getCacheRetrieveMode in interface TypedQuery<R>

See Also:

• SelectionQuery.getCacheMode()

setCacheRegion

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 Query<R>

Specified by:

setCacheRegion in interface SelectionQuery<R>

Specified by:

setCacheRegion in interface SelectionQueryImplementor<R>

See Also:

• SelectionQuery.getCacheRegion()

setFetchSize

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 Query<R>

Specified by:

setFetchSize in interface SelectionQuery<R>

Specified by:

setFetchSize in interface SelectionQueryImplementor<R>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()
• JdbcSettings.STATEMENT_FETCH_SIZE

setReadOnly

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 Query<R>

Specified by:

setReadOnly in interface SelectionQuery<R>

Specified by:

setReadOnly in interface SelectionQueryImplementor<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

getHibernateLockMode

LockMode getHibernateLockMode()

Description copied from interface: SelectionQuery

Get the root LockMode for the query

Specified by:

getHibernateLockMode in interface NativeQuery<R>

Specified by:

getHibernateLockMode in interface Query<R>

Specified by:

getHibernateLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getLockMode()

setHibernateLockMode

NativeQueryImplementor<R> setHibernateLockMode(LockMode lockMode)

Description copied from interface: SelectionQuery

Specify the root LockMode for the query

Specified by:

setHibernateLockMode in interface NativeQuery<R>

Specified by:

setHibernateLockMode in interface Query<R>

Specified by:

setHibernateLockMode in interface QueryImplementor<R>

Specified by:

setHibernateLockMode in interface SelectionQuery<R>

Specified by:

setHibernateLockMode in interface SelectionQueryImplementor<R>

See Also:

• SelectionQuery.setLockMode(LockModeType)

getLockMode

LockModeType getLockMode()

Description copied from interface: SelectionQuery

Specified by:

getLockMode in interface MutationQueryImplementor<R>

Specified by:

getLockMode in interface NativeQuery<R>

Specified by:

getLockMode in interface Query

Specified by:

getLockMode in interface SelectionQuery<R>

Specified by:

getLockMode in interface TypedQuery<R>

See Also:

• SelectionQuery.getHibernateLockMode()

setLockMode

NativeQueryImplementor<R> setLockMode(LockModeType lockMode)

Description copied from interface: SelectionQuery

Specified by:

setLockMode in interface CommonQueryContractImplementor

Specified by:

setLockMode in interface MutationQueryImplementor<R>

Specified by:

setLockMode in interface NativeQuery<R>

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface QueryImplementor<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Specified by:

setLockMode in interface SelectionQueryImplementor<R>

Specified by:

setLockMode in interface TypedQuery<R>

See Also:

• SelectionQuery.setHibernateLockMode(LockMode)

setComment

NativeQueryImplementor<R> setComment(String comment)

Description copied from interface: Query

Set the comment for this query.

If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.

SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".

Specified by:

setComment in interface CommonQueryContract

Specified by:

setComment in interface CommonQueryContractImplementor

Specified by:

setComment in interface MutationQuery

Specified by:

setComment in interface MutationQueryImplementor<R>

Specified by:

setComment in interface NativeQuery<R>

Specified by:

setComment in interface Query<R>

Specified by:

setComment in interface QueryImplementor<R>

Specified by:

setComment in interface SelectionQuery<R>

Specified by:

setComment in interface SelectionQueryImplementor<R>

See Also:

• CommonQueryContract.getComment()

getMaxResults

int getMaxResults()

Specified by:

getMaxResults in interface MutationQueryImplementor<R>

Specified by:

getMaxResults in interface Query

Specified by:

getMaxResults in interface TypedQuery<R>

setMaxResults

NativeQueryImplementor<R> setMaxResults(int maxResults)

Description copied from interface: SelectionQuery

Specified by:

setMaxResults in interface CommonQueryContractImplementor

Specified by:

setMaxResults in interface MutationQueryImplementor<R>

Specified by:

setMaxResults in interface NativeQuery<R>

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<R>

Specified by:

setMaxResults in interface QueryImplementor<R>

Specified by:

setMaxResults in interface SelectionQuery<R>

Specified by:

setMaxResults in interface SelectionQueryImplementor<R>

Specified by:

setMaxResults in interface TypedQuery<R>

getFirstResult

int getFirstResult()

Specified by:

getFirstResult in interface MutationQueryImplementor<R>

Specified by:

getFirstResult in interface Query

Specified by:

getFirstResult in interface TypedQuery<R>

setFirstResult

NativeQueryImplementor<R> setFirstResult(int startPosition)

Description copied from interface: SelectionQuery

Specified by:

setFirstResult in interface CommonQueryContractImplementor

Specified by:

setFirstResult in interface MutationQueryImplementor<R>

Specified by:

setFirstResult in interface NativeQuery<R>

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<R>

Specified by:

setFirstResult in interface QueryImplementor<R>

Specified by:

setFirstResult in interface SelectionQuery<R>

Specified by:

setFirstResult in interface SelectionQueryImplementor<R>

Specified by:

setFirstResult in interface TypedQuery<R>

addQueryHint

NativeQueryImplementor<R> addQueryHint(String hint)

Description copied from interface: Query

Add a database query hint to the SQL query.

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 CommonQueryContract

Specified by:

addQueryHint in interface CommonQueryContractImplementor

Specified by:

addQueryHint in interface MutationQueryImplementor<R>

Specified by:

addQueryHint in interface NativeQuery<R>

Specified by:

addQueryHint in interface Query<R>

Specified by:

addQueryHint in interface QueryImplementor<R>

Specified by:

addQueryHint in interface SelectionQueryImplementor<R>

setTupleTransformer

<X> NativeQueryImplementor<X> setTupleTransformer(TupleTransformer<X> transformer)

Description copied from interface: SelectionQuery

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface NativeQuery<R>

Specified by:

setTupleTransformer in interface Query<R>

Specified by:

setTupleTransformer in interface SelectionQuery<R>

Specified by:

setTupleTransformer in interface SelectionQueryImplementor<R>

setResultListTransformer

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

Description copied from interface: SelectionQuery

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface NativeQuery<R>

Specified by:

setResultListTransformer in interface Query<R>

Specified by:

setResultListTransformer in interface SelectionQuery<R>

Specified by:

setResultListTransformer in interface SelectionQueryImplementor<R>

withEntityGraph

<X> NativeQueryImplementor<X> withEntityGraph(EntityGraph<X> entityGraph)

Description copied from interface: Query

Covariant override of Query.withEntityGraph(EntityGraph).

Specified by:

withEntityGraph in interface CommonQueryContractImplementor

Specified by:

withEntityGraph in interface MutationQueryImplementor<R>

Specified by:

withEntityGraph in interface Query

Specified by:

withEntityGraph in interface Query<R>

See Also:

• CommonQueryContract.asSelectionQuery(EntityGraph, GraphSemantic)
• SharedSessionContract.createSelectionQuery(String, EntityGraph)
• SharedSessionContract.createQuery(String, EntityGraph)
• CommonQueryContract.asSelectionQuery(Class)

setEntityGraph

NativeQueryImplementor<R> setEntityGraph(EntityGraph<? super R> entityGraph)

Description copied from interface: SelectionQuery

Apply an EntityGraph to the query using load graph semantics. Covariant override of TypedQuery.setEntityGraph(EntityGraph)

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Specified by:

setEntityGraph in interface SelectionQuery<R>

Specified by:

setEntityGraph in interface SelectionQueryImplementor<R>

Specified by:

setEntityGraph in interface TypedQuery<R>

See Also:

• SharedSessionContract.createSelectionQuery(String, EntityGraph)

setEntityGraph

NativeQueryImplementor<R> setEntityGraph(EntityGraph<? super R> graph,
 GraphSemantic semantic)

Description copied from interface: SelectionQuery

Apply an EntityGraph 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 SelectionQuery<R>

Specified by:

setEntityGraph in interface SelectionQueryImplementor<R>

See Also:

• SharedSessionContract.createSelectionQuery(String, EntityGraph)
• CommonQueryContract.asSelectionQuery(EntityGraph)
• CommonQueryContract.asSelectionQuery(EntityGraph,GraphSemantic)
• Query.withEntityGraph(EntityGraph)

disableFetchProfile

NativeQueryImplementor<R> disableFetchProfile(String profileName)

Description copied from interface: SelectionQuery

Disable the fetch 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 SelectionQuery<R>

Specified by:

disableFetchProfile in interface SelectionQueryImplementor<R>

Parameters:

profileName - the name of the fetch profile to be disabled

See Also:

• FetchProfile

enableFetchProfile

NativeQueryImplementor<R> enableFetchProfile(String profileName)

Description copied from interface: SelectionQuery

Enable the fetch 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 SelectionQuery<R>

Specified by:

enableFetchProfile in interface SelectionQueryImplementor<R>

Parameters:

profileName - the name of the fetch profile to be enabled

See Also:

• FetchProfile

setPage

NativeQueryImplementor<R> setPage(Page page)

Description copied from interface: SelectionQuery

Set the page of results to return.

Specified by:

setPage in interface SelectionQuery<R>

Specified by:

setPage in interface SelectionQueryImplementor<R>

See Also:

• Page

setCacheStoreMode

NativeQueryImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface CommonQueryContractImplementor

Specified by:

setCacheStoreMode in interface MutationQueryImplementor<R>

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 QueryImplementor<R>

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

Specified by:

setCacheStoreMode in interface SelectionQueryImplementor<R>

Specified by:

setCacheStoreMode in interface TypedQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheRetrieveMode

NativeQueryImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface CommonQueryContractImplementor

Specified by:

setCacheRetrieveMode in interface MutationQueryImplementor<R>

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 QueryImplementor<R>

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

Specified by:

setCacheRetrieveMode in interface SelectionQueryImplementor<R>

Specified by:

setCacheRetrieveMode in interface TypedQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setFollowOnStrategy

NativeQueryImplementor<R> setFollowOnStrategy(Locking.FollowOn followOnStrategy)

Description copied from interface: SelectionQuery

Specifies whether follow-on locking should be applied

Specified by:

setFollowOnStrategy in interface Query<R>

Specified by:

setFollowOnStrategy in interface QueryImplementor<R>

Specified by:

setFollowOnStrategy in interface SelectionQuery<R>

Specified by:

setFollowOnStrategy in interface SelectionQueryImplementor<R>

Parameters:

followOnStrategy - The strategy for follow-on locking.

Returns:

this, for method chaining

setLockScope

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 MutationQueryImplementor<R>

Specified by:

setLockScope in interface NativeQuery<R>

Specified by:

setLockScope in interface Query<R>

Specified by:

setLockScope in interface QueryImplementor<R>

Specified by:

setLockScope in interface SelectionQuery<R>

Specified by:

setLockScope in interface SelectionQueryImplementor<R>

Specified by:

setLockScope in interface TypedQuery<R>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setParameter

NativeQueryImplementor<R> setParameter(String name,
 Object val)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

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

setParameter

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

Description copied from interface: Query

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

setParameter

<P> NativeQueryImplementor<R> setParameter(String name,
 P val,
 Class<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

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

setParameter

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

Deprecated.

Description copied from interface: Query

Bind an Instant value 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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<R>

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 SelectionQueryImplementor<R>

setParameter

@Deprecated
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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated
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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

NativeQueryImplementor<R> setParameter(int position,
 Object val)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

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

setParameter

<P> NativeQueryImplementor<R> setParameter(int position,
 P val,
 Class<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

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

Description copied from interface: Query

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

setParameter

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

Deprecated.

Description copied from interface: Query

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<R>

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 SelectionQueryImplementor<R>

setParameter

@Deprecated
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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated
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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

<P> NativeQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P val)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<R>

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 SelectionQueryImplementor<R>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

<P> NativeQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P val,
 Class<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<R>

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 SelectionQueryImplementor<R>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<R>

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 SelectionQueryImplementor<R>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

<P> NativeQueryImplementor<R> setParameter(Parameter<P> param,
 P value)

Description copied from interface: Query

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated
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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

@Deprecated
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 CommonQueryContractImplementor

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface MutationQueryImplementor<R>

Specified by:

setParameter in interface NativeQuery<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 SelectionQueryImplementor<R>

Specified by:

setParameter in interface Statement

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

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

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface MutationQueryImplementor<R>

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SelectionQueryImplementor<R>

Returns:

this, for method chaining

setProperties

NativeQueryImplementor<R> setProperties(Object bean)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface MutationQueryImplementor<R>

Specified by:

setProperties in interface NativeQuery<R>

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Specified by:

setProperties in interface SelectionQueryImplementor<R>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

NativeQueryImplementor<R> setProperties(Map bean)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface MutationQueryImplementor<R>

Specified by:

setProperties in interface NativeQuery<R>

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Specified by:

setProperties in interface SelectionQueryImplementor<R>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setConvertedParameter

<P> NativeQueryImplementor<R> setConvertedParameter(String name,
 P value,
 Class<? extends AttributeConverter<P,?>> converter)

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface CommonQueryContractImplementor

Specified by:

setConvertedParameter in interface MutationQuery

Specified by:

setConvertedParameter in interface MutationQueryImplementor<R>

Specified by:

setConvertedParameter in interface NativeQuery<R>

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<R>

Specified by:

setConvertedParameter in interface QueryImplementor<R>

Specified by:

setConvertedParameter in interface SelectionQuery<R>

Specified by:

setConvertedParameter in interface SelectionQueryImplementor<R>

Specified by:

setConvertedParameter in interface Statement

Specified by:

setConvertedParameter in interface TypedQuery<R>

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

<P> NativeQueryImplementor<R> setConvertedParameter(int position,
 P value,
 Class<? extends AttributeConverter<P,?>> converter)

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface CommonQueryContractImplementor

Specified by:

setConvertedParameter in interface MutationQuery

Specified by:

setConvertedParameter in interface MutationQueryImplementor<R>

Specified by:

setConvertedParameter in interface NativeQuery<R>

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<R>

Specified by:

setConvertedParameter in interface QueryImplementor<R>

Specified by:

setConvertedParameter in interface SelectionQuery<R>

Specified by:

setConvertedParameter in interface SelectionQueryImplementor<R>

Specified by:

setConvertedParameter in interface Statement

Specified by:

setConvertedParameter in interface TypedQuery<R>

See Also:

• Query.setConvertedParameter(int, Object, Class)

addResultTypeClass

void addResultTypeClass(Class<?> resultClass)

addScalar

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>

Parameters:

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

Returns:

this, for method chaining

addScalar

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>

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

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>

Returns:

this, for method chaining

addScalar

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

Description copied from interface: NativeQuery

Declare a scalar query result with an explicit conversion.

Specified by:

addScalar in interface NativeQuery<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

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

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

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

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

<O,J> NativeQueryImplementor<R> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<J> jdbcJavaType,
 Class<? extends 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>

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

addAttributeResult

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>

Returns:

this, for method chaining

addAttributeResult

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>

Returns:

this, for method chaining

addAttributeResult

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>

Returns:

this, for method chaining

addRoot

org.hibernate.query.results.internal.dynamic.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>

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.

addEntity

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(String, String) if you need further control of the mapping

Specified by:

addEntity in interface NativeQuery<R>

Parameters:

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

Returns:

this, for method chaining

addEntity

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

Description copied from interface: NativeQuery

Declare a "root" entity.

Specified by:

addEntity in interface NativeQuery<R>

Parameters:

tableAlias - The SQL table alias

entityName - The entity name

Returns:

this, for method chaining

addEntity

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>

Parameters:

tableAlias - The SQL table alias

entityName - The entity name

lockMode - The lock mode for this return.

Returns:

this, for method chaining

addEntity

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>

Parameters:

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

Returns:

this, for method chaining

addEntity

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

addEntity

NativeQueryImplementor<R> addEntity(String tableAlias,
 Class entityType)

Description copied from interface: NativeQuery

Declare a "root" entity.

Specified by:

addEntity in interface NativeQuery<R>

Parameters:

tableAlias - The SQL table alias

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

Returns:

this, for method chaining

addEntity

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>

Parameters:

tableAlias - The SQL table alias

entityClass - The entity Class

lockMode - The lock mode for this return

Returns:

this, for method chaining

addJoin

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

Description copied from interface: NativeQuery

Declare a join fetch result.

Specified by:

addJoin in interface NativeQuery<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

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>

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

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>

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