Package org.hibernate.query.sql.spi

Interface NativeQueryImplementor<R>

All Superinterfaces:

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

All Known Implementing Classes:

NativeQueryImpl

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

Nested Class Summary

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

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

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)
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.
Boolean	isSelectQuery()	Best guess whether this is a select query.
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>	setComment(String comment)	Set the comment for this query.
NativeQueryImplementor<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
NativeQueryImplementor<R>	setFirstResult(int startPosition)	Set the first query result row to return.
NativeQueryImplementor<R>	setFlushMode(FlushModeType flushMode)	Deprecated.
NativeQueryImplementor<R>	setHibernateFlushMode(FlushMode flushMode)	Deprecated.
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)	Specify the root LockModeType for the query
NativeQueryImplementor<R>	setLockOptions(LockOptions lockOptions)	Deprecated.
NativeQueryImplementor<R>	setMaxResults(int maxResults)	Set the maximum number of query result rows 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 determine the Type to use.
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)	Query override
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 determine the Type to use.
<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 determine 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 determine the Type to use.
<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 determine the Type to use.
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 determine the Type to use.
<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, inferring the 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 determine 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, inferring 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 determine 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 for each 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>	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.
default <T> NativeQueryImplementor<T>	setResultTransformer(ResultTransformer<T> transformer)	Deprecated.
NativeQueryImplementor<R>	setTimeout(int timeout)	Set the query timeout in seconds.
<T> NativeQueryImplementor<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.
NamedNativeQueryMemento<R>	toMemento(String name)	Convert this query into the memento.

Methods inherited from interface org.hibernate.query.CommonQueryContract

getFlushMode, getHibernateFlushMode, getParameterMetadata, getQueryFlushMode, getTimeout

Methods inherited from interface org.hibernate.query.NativeQuery

addFetch, addInstantiation, addRoot, addScalar, getHibernateLockMode, getLockMode, getLockOptions, setCacheRetrieveMode, setCacheStoreMode, setLockScope, setTimeout

Methods inherited from interface jakarta.persistence.Query

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

Methods inherited from interface org.hibernate.query.Query

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

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

getParameterBindings, getSession, scroll, scroll

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getKeyedResultList, getMaxResults, getResultCount, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, setFollowOnLocking, setFollowOnStrategy, setLockMode, setLockScope, setQueryPlanCacheable

Methods inherited from interface org.hibernate.query.SynchronizeableQuery

getSynchronizedQuerySpaces

Methods inherited from interface jakarta.persistence.TypedQuery

getSingleResultOrNull, setTimeout

Method Details

isSelectQuery

Boolean isSelectQuery()

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

setResultTransformer

@Deprecated
default <T> NativeQueryImplementor<T> setResultTransformer(ResultTransformer<T> transformer)

Deprecated.

Specified by:

setResultTransformer in interface NativeQuery<R>

Specified by:

setResultTransformer in interface Query<R>

Specified by:

setResultTransformer in interface QueryImplementor<R>

toMemento

NamedNativeQueryMemento<R> 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, Query)

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

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(java.lang.String, java.lang.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

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(java.lang.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(java.lang.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: CommonQueryContract

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

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface MutationQuery

Specified by:

setHint in interface NativeQuery<R>

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface TypedQuery<R>

See Also:

• HibernateHints
• SpecHints

setHibernateFlushMode

@Deprecated(since="7")
NativeQueryImplementor<R> setHibernateFlushMode(FlushMode flushMode)

Deprecated.

Description copied from interface: CommonQueryContract

Set the current FlushMode in effect for this query.

Specified by:

setHibernateFlushMode in interface CommonQueryContract

Specified by:

setHibernateFlushMode in interface MutationQuery

Specified by:

setHibernateFlushMode in interface NativeQuery<R>

Specified by:

setHibernateFlushMode in interface Query<R>

Specified by:

setHibernateFlushMode in interface SelectionQuery<R>

See Also:

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

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 MutationQuery

Specified by:

setQueryFlushMode in interface NativeQuery<R>

Specified by:

setQueryFlushMode in interface Query<R>

Specified by:

setQueryFlushMode in interface SelectionQuery<R>

See Also:

• Session.getHibernateFlushMode()

setFlushMode

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

Deprecated.

Description copied from interface: CommonQueryContract

Set the FlushMode to use for this query.

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

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface NativeQuery<R>

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface SelectionQuery<R>

Specified by:

setFlushMode in interface TypedQuery<R>

See Also:

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

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>

See Also:

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

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>

See Also:

• SelectionQuery.isCacheable()

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>

See Also:

• SelectionQuery.getCacheRegion()

setTimeout

NativeQueryImplementor<R> setTimeout(int timeout)

Description copied from interface: CommonQueryContract

Set the query timeout in seconds.

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

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface NativeQuery<R>

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

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

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>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()

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>

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

setLockOptions

@Deprecated
NativeQueryImplementor<R> setLockOptions(LockOptions lockOptions)

Deprecated.

Description copied from interface: Query

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

Specified by:

setLockOptions in interface NativeQuery<R>

Specified by:

setLockOptions in interface Query<R>

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

• Query.getLockOptions()

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

See Also:

• SelectionQuery.setLockMode(LockModeType)

setLockMode

NativeQueryImplementor<R> setLockMode(LockModeType lockMode)

Description copied from interface: SelectionQuery

Specify the root LockModeType for the query

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

Specified by:

setLockMode in interface TypedQuery<R>

See Also:

• SelectionQuery.setHibernateLockMode(org.hibernate.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 MutationQuery

Specified by:

setComment in interface NativeQuery<R>

Specified by:

setComment in interface Query<R>

Specified by:

setComment in interface SelectionQuery<R>

Parameters:

comment - The human-readable comment

Returns:

this, for method chaining

See Also:

• Query.getComment()

setMaxResults

NativeQueryImplementor<R> setMaxResults(int maxResults)

Description copied from interface: SelectionQuery

Set the maximum number of query result rows to return.

Specified by:

setMaxResults in interface NativeQuery<R>

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<R>

Specified by:

setMaxResults in interface SelectionQuery<R>

Specified by:

setMaxResults in interface TypedQuery<R>

Parameters:

maxResults - the maximum length of the query result list

setFirstResult

NativeQueryImplementor<R> setFirstResult(int startPosition)

Description copied from interface: SelectionQuery

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

Specified by:

setFirstResult in interface NativeQuery<R>

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<R>

Specified by:

setFirstResult in interface SelectionQuery<R>

Specified by:

setFirstResult in interface TypedQuery<R>

Parameters:

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

addQueryHint

NativeQueryImplementor<R> addQueryHint(String hint)

Description copied from interface: Query

Add a database query hint to the SQL query.

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

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

Specified by:

addQueryHint in interface NativeQuery<R>

Specified by:

addQueryHint in interface Query<R>

Parameters:

hint - The database specific query hint to add.

setTupleTransformer

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

Description copied from interface: Query

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface NativeQuery<R>

Specified by:

setTupleTransformer in interface Query<R>

Specified by:

setTupleTransformer in interface QueryImplementor<R>

Specified by:

setTupleTransformer in interface SelectionQuery<R>

setResultListTransformer

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

Description copied from interface: Query

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface NativeQuery<R>

Specified by:

setResultListTransformer in interface Query<R>

Specified by:

setResultListTransformer in interface QueryImplementor<R>

Specified by:

setResultListTransformer in interface SelectionQuery<R>

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 forms accept a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(String, Object, Class)
• Query.setParameter(String, Object, Type)

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 MutationQuery

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>

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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameter(String, Object) is used.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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>

See Also:

• Query.setParameter(String, Object, Type)

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 MutationQuery

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>

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 MutationQuery

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

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 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 forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(int, Object, Class)
• Query.setParameter(int, Object, Type)

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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameter(int, Object) is used.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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>

See Also:

• Query.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 MutationQuery

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>

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 MutationQuery

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>

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 MutationQuery

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

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 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 forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

Returns:

this, for method chaining

See Also:

• Query.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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameter(QueryParameter, Object) is used

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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>

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:

• Query.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 MutationQuery

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>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

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

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface NativeQuery<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface TypedQuery<R>

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 MutationQuery

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

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

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>

Returns:

this, for method chaining

See Also:

• Query.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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameterList(String, Collection) is used.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Returns:

this, for method chaining

See Also:

• Query.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 MutationQuery

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>

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 MutationQuery

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>

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, Query.setParameterList(String, Collection) is used.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Returns:

this, for method chaining

See Also:

• Query.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 MutationQuery

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>

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 MutationQuery

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>

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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameterList(String, Collection) is used.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Returns:

this, for method chaining

See Also:

• Query.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 MutationQuery

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>

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 MutationQuery

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>

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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameterList(String, Collection) is used.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Returns:

this, for method chaining

See Also:

• Query.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 MutationQuery

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>

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 MutationQuery

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>

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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameterList(String, Collection) is used.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Returns:

this, for method chaining

See Also:

• Query.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, inferring the Type.

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<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 MutationQuery

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>

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 determine the Type to use. If unable to determine an appropriate Type, Query.setParameterList(String, Collection) is used.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Returns:

this, for method chaining

See Also:

• Query.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, inferring the Type.

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface NativeQuery<R>

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<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 MutationQuery

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>

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 for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface MutationQuery

Specified by:

setProperties in interface NativeQuery<R>

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

addResultTypeClass

void addResultTypeClass(Class<?> resultClass)