Interface NativeQueryImplementor<R>
-
- All Superinterfaces:
CommonQueryContract
,MutationQuery
,NameableQuery
,NativeQuery<R>
,jakarta.persistence.Query
,Query<R>
,QueryImplementor<R>
,SelectionQuery<R>
,SynchronizeableQuery
,jakarta.persistence.TypedQuery<R>
- All Known Implementing Classes:
NativeQueryImpl
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
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description NativeQueryImplementor<R>
addAttributeResult(String columnAlias, jakarta.persistence.metamodel.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(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.DynamicResultBuilderEntityStandard
addRoot(String tableAlias, String entityName)
Add a new root return mapping, returning aNativeQuery.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, jakarta.persistence.AttributeConverter<?,C> converter)
Declare a scalar query result with an explicit conversion<C> NativeQueryImplementor<R>
addScalar(String columnAlias, Class<C> relationalJavaType, Class<? extends jakarta.persistence.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, jakarta.persistence.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 jakarta.persistence.AttributeConverter<O,J>> converter)
Declare a scalar query result with an explicit conversionNativeQueryImplementor<R>
addScalar(String columnAlias, BasicDomainType type)
Declare a scalar query result.NativeQueryImplementor<R>
addSynchronizedEntityClass(Class entityClass)
Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking.NativeQueryImplementor<R>
addSynchronizedEntityName(String entityName)
Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking.NativeQueryImplementor<R>
addSynchronizedQuerySpace(String querySpace)
Adds 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 currentCacheMode
in effect for this query.NativeQueryImplementor<R>
setCacheRegion(String cacheRegion)
Set the name of the cache region where query results should be cached (assumingSelectionQuery.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 row position to return from the query results.NativeQueryImplementor<R>
setFlushMode(jakarta.persistence.FlushModeType flushMode)
Set theFlushMode
in to use for this query.NativeQueryImplementor<R>
setHibernateFlushMode(FlushMode flushMode)
Set the currentFlushMode
in effect for this query.NativeQueryImplementor<R>
setHibernateLockMode(LockMode lockMode)
Specify the rootLockMode
for the queryNativeQueryImplementor<R>
setHint(String hintName, Object value)
Apply hints to the query.NativeQueryImplementor<R>
setLockMode(jakarta.persistence.LockModeType lockMode)
Specify the rootLockModeType
for the queryNativeQueryImplementor<R>
setLockMode(String alias, LockMode lockMode)
Set theLockMode
to use for particular alias defined in theFROM
clause of the query.NativeQueryImplementor<R>
setLockOptions(LockOptions lockOptions)
Apply the given lock options to this query.NativeQueryImplementor<R>
setMaxResults(int maxResult)
Set the max number of rows requested for the query results.NativeQueryImplementor<R>
setParameter(int position, Object val)
Bind the given argument to an ordinal query parameter.NativeQueryImplementor<R>
setParameter(int position, Instant value, jakarta.persistence.TemporalType temporalType)
Bind anInstant
value to the ordinal query parameter using just the portion indicated by the givenTemporalType
.NativeQueryImplementor<R>
setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)
Query
overrideNativeQueryImplementor<R>
setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)
Query
override<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 theBindableType
to use.<P> NativeQueryImplementor<R>
setParameter(int position, P val, BindableType<P> type)
Bind the given argument to an ordinal query parameter using the givenBindableType
.NativeQueryImplementor<R>
setParameter(jakarta.persistence.Parameter<Calendar> param, Calendar value, jakarta.persistence.TemporalType temporalType)
Query
overrideNativeQueryImplementor<R>
setParameter(jakarta.persistence.Parameter<Date> param, Date value, jakarta.persistence.TemporalType temporalType)
Query
override<P> NativeQueryImplementor<R>
setParameter(jakarta.persistence.Parameter<P> param, P value)
Query
overrideNativeQueryImplementor<R>
setParameter(String name, Object val)
Bind the given argument to a named query parameter.NativeQueryImplementor<R>
setParameter(String name, Instant value, jakarta.persistence.TemporalType temporalType)
Bind anInstant
value to the named query parameter using just the portion indicated by the givenTemporalType
.NativeQueryImplementor<R>
setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)
Query
overrideNativeQueryImplementor<R>
setParameter(String name, Date value, jakarta.persistence.TemporalType temporalType)
Query
override<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 theBindableType
to use.<P> NativeQueryImplementor<R>
setParameter(String name, P val, BindableType<P> type)
Bind the given argument to a named query parameter using the givenBindableType
.<P> NativeQueryImplementor<R>
setParameter(QueryParameter<P> parameter, P val)
Bind an argument to the query parameter represented by the givenQueryParameter
.<P> NativeQueryImplementor<R>
setParameter(QueryParameter<P> parameter, P val, Class<P> type)
Bind an argument to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use.<P> NativeQueryImplementor<R>
setParameter(QueryParameter<P> parameter, P val, BindableType<P> type)
Bind an argument to the query parameter represented by the givenQueryParameter
using the givenBindableType
.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, Class<P> type)
Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> NativeQueryImplementor<R>
setParameterList(int position, Collection<? extends P> values, BindableType<P> type)
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.<P> NativeQueryImplementor<R>
setParameterList(int position, P[] values, Class<P> javaType)
Bind multiple arguments to an ordinal query parameter using the givenClass
reference to attempt to determine theBindableType
to use.<P> NativeQueryImplementor<R>
setParameterList(int position, P[] values, BindableType<P> type)
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.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, Class<P> type)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> NativeQueryImplementor<R>
setParameterList(String name, Collection<? extends P> values, BindableType<P> type)
Bind multiple arguments to a named query parameter using the givenBindableType
.<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 theBindableType
to use.<P> NativeQueryImplementor<R>
setParameterList(String name, P[] values, BindableType<P> type)
Bind multiple arguments to a named query parameter using the givenBindableType
.<P> NativeQueryImplementor<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
.<P> NativeQueryImplementor<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use.<P> NativeQueryImplementor<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.<P> NativeQueryImplementor<R>
setParameterList(QueryParameter<P> parameter, P[] values)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
<P> NativeQueryImplementor<R>
setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use.<P> NativeQueryImplementor<R>
setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.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>
setReadOnly(boolean readOnly)
Set the read-only/modifiable mode for entities and proxies loaded by thisQuery
.NativeQueryImplementor<R>
setResultListTransformer(ResultListTransformer<R> transformer)
Set aResultListTransformer
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 aTupleTransformer
NamedNativeQueryMemento
toMemento(String name)
Convert the query into the memento-
Methods inherited from interface org.hibernate.query.CommonQueryContract
getFlushMode, getHibernateFlushMode, getTimeout
-
Methods inherited from interface org.hibernate.query.NativeQuery
addFetch, addInstantiation, addRoot, addScalar, getHibernateLockMode, getLockMode, getLockOptions, setCacheRetrieveMode, setCacheStoreMode
-
Methods inherited from interface jakarta.persistence.Query
getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap
-
Methods inherited from interface org.hibernate.query.Query
applyFetchGraph, applyGraph, applyLoadGraph, executeUpdate, getComment, getParameterMetadata, getQueryOptions, getQueryString, getResultList, getResultStream, getSingleResult, list, stream, uniqueResult, uniqueResultOptional
-
Methods inherited from interface org.hibernate.query.spi.QueryImplementor
getParameterBindings, getSession, scroll, scroll, setOptionalEntityName, setOptionalId, setOptionalObject
-
Methods inherited from interface org.hibernate.query.SelectionQuery
getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getMaxResults, getSingleResultOrNull, isCacheable, isReadOnly, setAliasSpecificLockMode, setFollowOnLocking
-
Methods inherited from interface org.hibernate.query.SynchronizeableQuery
getSynchronizedQuerySpaces
-
-
-
-
Method Detail
-
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 interfaceNativeQuery<R>
- Specified by:
setResultTransformer
in interfaceQuery<R>
- Specified by:
setResultTransformer
in interfaceQueryImplementor<R>
-
toMemento
NamedNativeQueryMemento toMemento(String name)
Description copied from interface:NameableQuery
Convert the query into the memento- Specified by:
toMemento
in interfaceNameableQuery
-
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/>
inhbm.xml
orColumnResult
in annotations- Specified by:
addScalar
in interfaceNativeQuery<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/>
inhbm.xml
orColumnResult
in annotations- Specified by:
addScalar
in interfaceNativeQuery<R>
- Parameters:
columnAlias
- The column alias in the result-set to be processed as a scalar resulttype
- 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 interfaceNativeQuery<R>
- Returns:
this
, for method chaining
-
addScalar
<C> NativeQueryImplementor<R> addScalar(String columnAlias, Class<C> relationalJavaType, jakarta.persistence.AttributeConverter<?,C> converter)
Description copied from interface:NativeQuery
Declare a scalar query result with an explicit conversion- Specified by:
addScalar
in interfaceNativeQuery<R>
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, jakarta.persistence.AttributeConverter<O,J> converter)
Description copied from interface:NativeQuery
Declare a scalar query result with an explicit conversion- Specified by:
addScalar
in interfaceNativeQuery<R>
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 jakarta.persistence.AttributeConverter<?,C>> converter)
Description copied from interface:NativeQuery
Declare a scalar query result with an explicit conversion- Specified by:
addScalar
in interfaceNativeQuery<R>
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 jakarta.persistence.AttributeConverter<O,J>> converter)
Description copied from interface:NativeQuery
Declare a scalar query result with an explicit conversion- Specified by:
addScalar
in interfaceNativeQuery<R>
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 `jdbcJavaType`.- 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 interfaceNativeQuery<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 interfaceNativeQuery<R>
- Returns:
this
, for method chaining
-
addAttributeResult
NativeQueryImplementor<R> addAttributeResult(String columnAlias, jakarta.persistence.metamodel.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 interfaceNativeQuery<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 aNativeQuery.RootReturn
to allow further definition.- Specified by:
addRoot
in interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table alias to map to this entityentityName
- 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 nameUse
NativeQuery.addRoot(java.lang.String, java.lang.String)
if you need further control of the mapping- Specified by:
addEntity
in interfaceNativeQuery<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 interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table aliasentityName
- 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 interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table aliasentityName
- The entity namelockMode
- 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 interfaceNativeQuery<R>
- Parameters:
entityType
- The java type of the entity to add as a root- Returns:
this
, for method chaining
-
addEntity
NativeQueryImplementor<R> addEntity(String tableAlias, Class entityType)
Description copied from interface:NativeQuery
Declare a "root" entity.- Specified by:
addEntity
in interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table aliasentityType
- 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 interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table aliasentityClass
- The entity ClasslockMode
- 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 interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table alias for the data to be mapped to this fetchpath
- The association path ([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 interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table alias for the data to be mapped to this fetchownerTableAlias
- Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetchjoinPropertyName
- 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 interfaceNativeQuery<R>
- Parameters:
tableAlias
- The SQL table alias for the data to be mapped to this fetchpath
- The association path ([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
Adds a query space.- Specified by:
addSynchronizedQuerySpace
in interfaceNativeQuery<R>
- Specified by:
addSynchronizedQuerySpace
in interfaceSynchronizeableQuery
- Parameters:
querySpace
- The query space to be auto-flushed for this query.- Returns:
this
, for method chaining
-
addSynchronizedEntityName
NativeQueryImplementor<R> addSynchronizedEntityName(String entityName) throws MappingException
Description copied from interface:SynchronizeableQuery
Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking. Same asSynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String)
for all tables associated with the given entity.- Specified by:
addSynchronizedEntityName
in interfaceNativeQuery<R>
- Specified by:
addSynchronizedEntityName
in interfaceSynchronizeableQuery
- Parameters:
entityName
- The name of the entity upon whose defined query spaces we should additionally synchronize.- 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
Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking. Same asSynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String)
for all tables associated with the given entity.- Specified by:
addSynchronizedEntityClass
in interfaceNativeQuery<R>
- Specified by:
addSynchronizedEntityClass
in interfaceSynchronizeableQuery
- Parameters:
entityClass
- The class of the entity upon whose defined query spaces we should additionally synchronize.- 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
Apply hints to the query.- Specified by:
setHint
in interfaceCommonQueryContract
- Specified by:
setHint
in interfaceNativeQuery<R>
- Specified by:
setHint
in interfacejakarta.persistence.Query
- Specified by:
setHint
in interfaceQuery<R>
- Specified by:
setHint
in interfaceSelectionQuery<R>
- Specified by:
setHint
in interfacejakarta.persistence.TypedQuery<R>
-
setHibernateFlushMode
NativeQueryImplementor<R> setHibernateFlushMode(FlushMode flushMode)
Description copied from interface:CommonQueryContract
Set the currentFlushMode
in effect for this query.- Specified by:
setHibernateFlushMode
in interfaceCommonQueryContract
- Specified by:
setHibernateFlushMode
in interfaceMutationQuery
- Specified by:
setHibernateFlushMode
in interfaceNativeQuery<R>
- Specified by:
setHibernateFlushMode
in interfaceQuery<R>
- Specified by:
setHibernateFlushMode
in interfaceSelectionQuery<R>
- See Also:
CommonQueryContract.getHibernateFlushMode()
,Session.getHibernateFlushMode()
-
setFlushMode
NativeQueryImplementor<R> setFlushMode(jakarta.persistence.FlushModeType flushMode)
Description copied from interface:CommonQueryContract
Set theFlushMode
in to use for this query.- Specified by:
setFlushMode
in interfaceCommonQueryContract
- Specified by:
setFlushMode
in interfaceNativeQuery<R>
- Specified by:
setFlushMode
in interfacejakarta.persistence.Query
- Specified by:
setFlushMode
in interfaceQuery<R>
- Specified by:
setFlushMode
in interfaceSelectionQuery<R>
- Specified by:
setFlushMode
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
CommonQueryContract.getHibernateFlushMode()
,Session.getHibernateFlushMode()
-
setCacheMode
NativeQueryImplementor<R> setCacheMode(CacheMode cacheMode)
Description copied from interface:SelectionQuery
Set the currentCacheMode
in effect for this query.- Specified by:
setCacheMode
in interfaceNativeQuery<R>
- Specified by:
setCacheMode
in interfaceQuery<R>
- Specified by:
setCacheMode
in interfaceSelectionQuery<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 interfaceNativeQuery<R>
- Specified by:
setCacheable
in interfaceQuery<R>
- Specified by:
setCacheable
in interfaceSelectionQuery<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 (assumingSelectionQuery.isCacheable()
).null
indicates to use the default region.- Specified by:
setCacheRegion
in interfaceNativeQuery<R>
- Specified by:
setCacheRegion
in interfaceQuery<R>
- Specified by:
setCacheRegion
in interfaceSelectionQuery<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.
A value of zero indicates no timeout.
- Specified by:
setTimeout
in interfaceCommonQueryContract
- Specified by:
setTimeout
in interfaceNativeQuery<R>
- Specified by:
setTimeout
in interfaceQuery<R>
- Specified by:
setTimeout
in interfaceSelectionQuery<R>
- Parameters:
timeout
- the timeout in seconds- Returns:
this
, for method chaining- See Also:
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 interfaceNativeQuery<R>
- Specified by:
setFetchSize
in interfaceQuery<R>
- Specified by:
setFetchSize
in interfaceSelectionQuery<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 thisQuery
. This setting overrides the default setting for the persistence context,Session.isDefaultReadOnly()
.To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, 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 interfaceNativeQuery<R>
- Specified by:
setReadOnly
in interfaceQuery<R>
- Specified by:
setReadOnly
in interfaceSelectionQuery<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
NativeQueryImplementor<R> setLockOptions(LockOptions lockOptions)
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 interfaceNativeQuery<R>
- Specified by:
setLockOptions
in interfaceQuery<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 rootLockMode
for the query- Specified by:
setHibernateLockMode
in interfaceNativeQuery<R>
- Specified by:
setHibernateLockMode
in interfaceSelectionQuery<R>
- See Also:
SelectionQuery.setLockMode(LockModeType)
-
setLockMode
NativeQueryImplementor<R> setLockMode(jakarta.persistence.LockModeType lockMode)
Description copied from interface:SelectionQuery
Specify the rootLockModeType
for the query- Specified by:
setLockMode
in interfaceNativeQuery<R>
- Specified by:
setLockMode
in interfacejakarta.persistence.Query
- Specified by:
setLockMode
in interfaceQuery<R>
- Specified by:
setLockMode
in interfaceSelectionQuery<R>
- Specified by:
setLockMode
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)
-
setLockMode
NativeQueryImplementor<R> setLockMode(String alias, LockMode lockMode)
Description copied from interface:Query
Set theLockMode
to use for particular alias defined in theFROM
clause of the query.The alias-specific lock modes specified here are added to the
LockOption
s.The effect of alias-specific locking is quite dependent on the driver and database. For maximum portability, the given lock mode should be
LockMode.PESSIMISTIC_WRITE
.- Specified by:
setLockMode
in interfaceNativeQuery<R>
- Specified by:
setLockMode
in interfaceQuery<R>
- Specified by:
setLockMode
in interfaceSelectionQuery<R>
- Parameters:
alias
- A query aliaslockMode
- The lock mode to apply- Returns:
this
, for method chaining- See Also:
Query.getLockOptions()
-
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 interfaceCommonQueryContract
- Specified by:
setComment
in interfaceNativeQuery<R>
- Specified by:
setComment
in interfaceQuery<R>
- Parameters:
comment
- The human-readable comment- Returns:
this
, for method chaining- See Also:
Query.getComment()
-
setMaxResults
NativeQueryImplementor<R> setMaxResults(int maxResult)
Description copied from interface:SelectionQuery
Set the max number of rows requested for the query results. Applied to the SQL query- Specified by:
setMaxResults
in interfaceNativeQuery<R>
- Specified by:
setMaxResults
in interfacejakarta.persistence.Query
- Specified by:
setMaxResults
in interfaceQuery<R>
- Specified by:
setMaxResults
in interfaceSelectionQuery<R>
- Specified by:
setMaxResults
in interfacejakarta.persistence.TypedQuery<R>
-
setFirstResult
NativeQueryImplementor<R> setFirstResult(int startPosition)
Description copied from interface:SelectionQuery
Set the first row position to return from the query results. Applied to the SQL query- Specified by:
setFirstResult
in interfaceNativeQuery<R>
- Specified by:
setFirstResult
in interfacejakarta.persistence.Query
- Specified by:
setFirstResult
in interfaceQuery<R>
- Specified by:
setFirstResult
in interfaceSelectionQuery<R>
- Specified by:
setFirstResult
in interfacejakarta.persistence.TypedQuery<R>
-
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
orQuery.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 interfaceNativeQuery<R>
- Specified by:
addQueryHint
in interfaceQuery<R>
- Parameters:
hint
- The database specific query hint to add.
-
setTupleTransformer
<T> NativeQueryImplementor<T> setTupleTransformer(TupleTransformer<T> transformer)
Description copied from interface:Query
Set aTupleTransformer
- Specified by:
setTupleTransformer
in interfaceNativeQuery<R>
- Specified by:
setTupleTransformer
in interfaceQuery<R>
- Specified by:
setTupleTransformer
in interfaceQueryImplementor<R>
-
setResultListTransformer
NativeQueryImplementor<R> setResultListTransformer(ResultListTransformer<R> transformer)
Description copied from interface:Query
Set aResultListTransformer
- Specified by:
setResultListTransformer
in interfaceNativeQuery<R>
- Specified by:
setResultListTransformer
in interfaceQuery<R>
- Specified by:
setResultListTransformer
in interfaceQueryImplementor<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 interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(String, Object, Class)
,Query.setParameter(String, Object, BindableType)
-
setParameter
<P> NativeQueryImplementor<R> setParameter(String name, P val, BindableType<P> type)
Description copied from interface:Query
Bind the given argument to a named query parameter using the givenBindableType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<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 theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameter(String, Object)
is used.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- See Also:
Query.setParameter(String, Object, BindableType)
-
setParameter
NativeQueryImplementor<R> setParameter(String name, Instant value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Bind anInstant
value to the named query parameter using just the portion indicated by the givenTemporalType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
-
setParameter
NativeQueryImplementor<R> setParameter(String name, Date value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(String, Date, TemporalType)
-
setParameter
NativeQueryImplementor<R> setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.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 interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(int, Object, Class)
,Query.setParameter(int, Object, BindableType)
-
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 theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameter(int, Object)
is used.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- See Also:
Query.setParameter(int, Object, BindableType)
-
setParameter
<P> NativeQueryImplementor<R> setParameter(int position, P val, BindableType<P> type)
Description copied from interface:Query
Bind the given argument to an ordinal query parameter using the givenBindableType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
-
setParameter
NativeQueryImplementor<R> setParameter(int position, Instant value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Bind anInstant
value to the ordinal query parameter using just the portion indicated by the givenTemporalType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
-
setParameter
NativeQueryImplementor<R> setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(int, Date, TemporalType)
-
setParameter
NativeQueryImplementor<R> setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.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 givenQueryParameter
.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 interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the query parameter mementoval
- the argument, which might be null- Returns:
this
, for method chaining- See Also:
Query.setParameter(QueryParameter, Object, BindableType)
-
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 givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameter(QueryParameter, Object)
is used- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the query parameter mementoval
- the argument, which might be nulltype
- aBindableType
representing the type of the parameter- Returns:
this
, for method chaining- See Also:
Query.setParameter(QueryParameter, Object, BindableType)
-
setParameter
<P> NativeQueryImplementor<R> setParameter(QueryParameter<P> parameter, P val, BindableType<P> type)
Description copied from interface:Query
Bind an argument to the query parameter represented by the givenQueryParameter
using the givenBindableType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the query parameter mementoval
- the argument, which might be nulltype
- anBindableType
representing the type of the parameter- Returns:
this
, for method chaining
-
setParameter
<P> NativeQueryImplementor<R> setParameter(jakarta.persistence.Parameter<P> param, P value)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Object)
-
setParameter
NativeQueryImplementor<R> setParameter(jakarta.persistence.Parameter<Date> param, Date value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Date, TemporalType)
-
setParameter
NativeQueryImplementor<R> setParameter(jakarta.persistence.Parameter<Calendar> param, Calendar value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceNativeQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(java.lang.String, java.util.Collection, BindableType)
-
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 theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(java.lang.String, java.util.Collection, BindableType)
-
setParameterList
<P> NativeQueryImplementor<R> setParameterList(String name, Collection<? extends P> values, BindableType<P> type)
Description copied from interface:Query
Bind multiple arguments to a named query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(java.lang.String, Object[], BindableType)
-
setParameterList
<P> NativeQueryImplementor<R> setParameterList(String name, P[] values, BindableType<P> type)
Description copied from interface:Query
Bind multiple arguments to a named query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(int, Collection, BindableType)
-
setParameterList
<P> NativeQueryImplementor<R> setParameterList(int position, Collection<? extends P> values, BindableType<P> type)
Description copied from interface:Query
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 givenClass
reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(int, Object[], BindableType)
-
setParameterList
<P> NativeQueryImplementor<R> setParameterList(int position, P[] values, BindableType<P> type)
Description copied from interface:Query
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 givenQueryParameter
.The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.
- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the parameter mementovalues
- 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 givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(QueryParameter, java.util.Collection, BindableType)
-
setParameterList
<P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)
Description copied from interface:Query
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.The "type mapping" for the binding is inferred from the type of the first collection element.
- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 givenQueryParameter
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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the parameter mementovalues
- 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 givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,Query.setParameterList(String, Collection)
is used- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
Query.setParameterList(QueryParameter, Object[], BindableType)
-
setParameterList
<P> NativeQueryImplementor<R> setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)
Description copied from interface:Query
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.The "type mapping" for the binding is inferred from the type of the first collection element
- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceNativeQuery<R>
- Specified by:
setParameterList
in interfaceQuery<R>
- Specified by:
setParameterList
in interfaceQueryImplementor<R>
- Specified by:
setParameterList
in interfaceSelectionQuery<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 interfaceCommonQueryContract
- Specified by:
setProperties
in interfaceMutationQuery
- Specified by:
setProperties
in interfaceNativeQuery<R>
- Specified by:
setProperties
in interfaceQuery<R>
- Specified by:
setProperties
in interfaceQueryImplementor<R>
- Specified by:
setProperties
in interfaceSelectionQuery<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 interfaceCommonQueryContract
- Specified by:
setProperties
in interfaceMutationQuery
- Specified by:
setProperties
in interfaceNativeQuery<R>
- Specified by:
setProperties
in interfaceQuery<R>
- Specified by:
setProperties
in interfaceQueryImplementor<R>
- Specified by:
setProperties
in interfaceSelectionQuery<R>
- Parameters:
bean
- aMap
of names to arguments- Returns:
this
, for method chaining
-
-