Package org.hibernate.search.mapper.orm.search.query.impl

Class HibernateOrmSearchQueryAdapter<R>

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

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

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

org.hibernate.search.mapper.orm.search.query.impl.HibernateOrmSearchQueryAdapter<R>

All Implemented Interfaces:

Query, TypedQuery<R>, CommonQueryContract, MutationQuery, Query<R>, SelectionQuery<R>, DomainQueryExecutionContext, QueryImplementor<R>

@SuppressForbiddenApis(reason="We need to use the internal QueryOptionsImpl in order to implement a org.hibernate.query.Query")
public final class HibernateOrmSearchQueryAdapter<R>
extends AbstractQuery<R>

Field Summary

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

CRITERIA_HQL_STRING

Method Summary

Modifier and Type	Method	Description
HibernateOrmSearchQueryAdapter<R>	applyGraph(RootGraph graph, GraphSemantic semantic)	Apply the given graph using the given semantic
protected void	beforeQuery()
static <R> HibernateOrmSearchQueryAdapter<R>	create(SearchQuery<R> query)
protected int	doExecuteUpdate()
protected List<R>	doList()
protected ScrollableResultsImplementor<R>	doScroll(ScrollMode scrollMode)
int	executeUpdate()	Execute an insert, update, or delete statement, and return the number of affected entities.
Map<String,Object>	getHints()	Get the properties and hints and associated values that are in effect for the query instance.
KeyedResultList<R>	getKeyedResultList(KeyedPage<R> page)	Execute the query and return the results for the given page, using key-based pagination.
LockModeType	getLockMode()	Get the root LockModeType for the query
LockOptions	getLockOptions()	The LockOptions currently in effect for the query
QueryParameterBindings	getParameterBindings()
ParameterMetadataImplementor	getParameterMetadata()	Access to information about query parameters.
QueryParameterBindings	getQueryParameterBindings()	The domain parameter bindings
String	getQueryString()	The query as a string, or null in the case of a criteria query.
long	getResultCount()	Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.
List<R>	list()	Execute the query and return the query results as a List.
protected <P> QueryParameterBinding<P>	locateBinding(int position)
protected <P> QueryParameterBinding<P>	locateBinding(Parameter<P> parameter)
protected <P> QueryParameterBinding<P>	locateBinding(String name)
protected <P> QueryParameterBinding<P>	locateBinding(QueryParameterImplementor<P> parameter)
ScrollableResultsImplementor<R>	scroll()	Returns scrollable access to the query results.
HibernateOrmSearchQueryAdapter<R>	setHint(String hintName, Object value)	Set a hint.
HibernateOrmSearchQueryAdapter<R>	setLockMode(LockModeType lockModeType)	Specify the root LockModeType for the query
HibernateOrmSearchQueryAdapter<R>	setLockMode(String alias, LockMode lockMode)	Specify a LockMode to apply to a specific alias defined in the query
QueryImplementor<R>	setResultListTransformer(ResultListTransformer<R> resultListTransformer)	Set a ResultListTransformer.
HibernateOrmSearchQueryAdapter<R>	setTimeout(int timeout)	Set the query timeout in seconds.
<T> QueryImplementor<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.
String	toString()
<T> T	unwrap(Class<T> cls)	Return an object of the specified type to allow access to the provider-specific API.

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

addQueryHint, applyOptions, collectHints, disableFetchProfile, enableFetchProfile, getComment, getFirstResult, getFlushMode, getMaxResults, getParameters, getQueryOptions, getSupportedHints, isCacheable, prepareForExecution, resolveJdbcParameterTypeIfNecessary, setCacheable, setCacheMode, setCacheRegion, setCacheRetrieveMode, setCacheStoreMode, setComment, setEntityGraph, setFetchSize, setFirstResult, setFlushMode, setHibernateFlushMode, setLockOptions, setMaxResults, setOptionalEntityName, setOptionalId, setOptionalObject, setOrder, setOrder, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setProperties, setProperties, setQueryPlanCacheable, setReadOnly

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

afterQuery, afterQuery, afterQueryHandlingFetchProfiles, beforeQueryHandlingFetchProfiles, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getCallback, getFetchSize, getHibernateLockMode, getResultStream, getSessionFactory, getSingleResult, getSingleResultOrNull, hasCallbackActions, isQueryPlanCacheable, isReadOnly, requiresTxn, resetCallback, scroll, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode, stream, uniqueElement, uniqueResult, uniqueResultOptional

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

applyAdditionalPossibleHints, applyAliasSpecificLockModeHint, applyCacheableHint, applyCacheModeHint, applyCacheRegionHint, applyCommentHint, applyDatabaseHint, applyEntityGraphHint, applyFetchSizeHint, applyFirstResult, applyFlushModeHint, applyFollowOnLockingHint, applyGraph, applyGraph, applyHibernateLockMode, applyHint, applyJpaCacheRetrieveModeHint, applyJpaCacheStoreModeHint, applyJpaFlushMode, applyLockModeHint, applyLockModeType, applyLockTimeoutHint, applyLockTimeoutHint, applyMaxResults, applyQueryPlanCacheableHint, applyResultListTransformer, applySelectionHint, applySynchronizeSpacesHint, applyTimeoutHint, applyTupleTransformer, determineType, getHibernateFlushMode, getIntegerLiteral, getJpaFlushMode, getMaxRows, getParameter, getParameter, getParameter, getParameter, getParameterValue, getParameterValue, getParameterValue, getSession, getTimeout, isBound, putIfNotNull, putIfNotNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.query.CommonQueryContract

getHibernateFlushMode, getTimeout

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

getResultType, getSession

Methods inherited from interface jakarta.persistence.Query

getParameter, getParameter, getParameter, getParameter, getParameterValue, getParameterValue, getParameterValue, isBound

Methods inherited from interface org.hibernate.query.Query

applyFetchGraph, applyLoadGraph, getResultList, getResultStream, getSingleResult, setPage, stream, uniqueResult, uniqueResultOptional

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

getSession, scroll, setResultTransformer

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getHibernateLockMode, getSingleResultOrNull, isQueryPlanCacheable, isReadOnly, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode

Method Details

create

public static <R> HibernateOrmSearchQueryAdapter<R> create(SearchQuery<R> query)

toString

public String toString()

Overrides:

toString in class Object

unwrap

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

Description copied from interface: Query

Return an object of the specified type to allow access to the provider-specific API. If the provider's query implementation does not support the specified class, the PersistenceException is thrown.

Parameters:

cls - the class of the object to be returned. This is normally either the underlying query implementation class or an interface that it implements.

Returns:

an instance of the specified class

list

public List<R> list()

Description copied from interface: SelectionQuery

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

Specified by:

list in interface Query<R>

Specified by:

list in interface SelectionQuery<R>

Overrides:

list in class AbstractSelectionQuery<R>

Returns:

the result list

getQueryString

public String getQueryString()

Description copied from interface: Query

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

Specified by:

getQueryString in interface Query<R>

Specified by:

getQueryString in class AbstractSelectionQuery<R>

setHint

public HibernateOrmSearchQueryAdapter<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 Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface TypedQuery<R>

Overrides:

setHint in class AbstractQuery<R>

Parameters:

hintName - name of property or hint

value - value for the property or hint

Returns:

the same query instance

See Also:

• HibernateHints
• SpecHints

setTimeout

public HibernateOrmSearchQueryAdapter<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 interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Overrides:

setTimeout in class AbstractQuery<R>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

• CommonQueryContract.getTimeout()

applyGraph

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

Description copied from interface: Query

Apply the given graph using the given semantic

Parameters:

graph - The graph to apply.

semantic - The semantic to use when applying the graph

scroll

public ScrollableResultsImplementor<R> scroll()

Description copied from interface: SelectionQuery

Returns scrollable access to the query results.

This form calls SelectionQuery.scroll(ScrollMode) using Dialect.defaultScrollMode()

Specified by:

scroll in interface Query<R>

Specified by:

scroll in interface QueryImplementor<R>

Specified by:

scroll in interface SelectionQuery<R>

Overrides:

scroll in class AbstractSelectionQuery<R>

getResultCount

public long getResultCount()

Description copied from interface: SelectionQuery

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

Returns:

the size of the list that would be returned

getKeyedResultList

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

Description copied from interface: SelectionQuery

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

Specified by:

getKeyedResultList in interface SelectionQuery<R>

Overrides:

getKeyedResultList in class AbstractQuery<R>

Parameters:

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

Returns:

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

See Also:

• KeyedPage
• KeyedResultList

doScroll

protected ScrollableResultsImplementor<R> doScroll(ScrollMode scrollMode)

Specified by:

doScroll in class AbstractSelectionQuery<R>

doList

protected List<R> doList()

Specified by:

doList in class AbstractSelectionQuery<R>

beforeQuery

protected void beforeQuery()

Overrides:

beforeQuery in class AbstractSelectionQuery<R>

getHints

public Map<String,Object> getHints()

Description copied from interface: Query

Get the properties and hints and associated values that are in effect for the query instance.

Specified by:

getHints in interface Query

Overrides:

getHints in class AbstractCommonQueryContract

Returns:

query properties and hints

getParameterMetadata

public ParameterMetadataImplementor getParameterMetadata()

Description copied from interface: Query

Access to information about query parameters.

Specified by:

getParameterMetadata in interface Query<R>

Specified by:

getParameterMetadata in class AbstractCommonQueryContract

Returns:

information about query parameters.

getParameterBindings

public QueryParameterBindings getParameterBindings()

getQueryParameterBindings

public QueryParameterBindings getQueryParameterBindings()

Description copied from interface: DomainQueryExecutionContext

The domain parameter bindings

Specified by:

getQueryParameterBindings in interface DomainQueryExecutionContext

Specified by:

getQueryParameterBindings in class AbstractCommonQueryContract

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(String name)

Overrides:

locateBinding in class AbstractCommonQueryContract

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(int position)

Overrides:

locateBinding in class AbstractCommonQueryContract

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(Parameter<P> parameter)

Overrides:

locateBinding in class AbstractCommonQueryContract

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(QueryParameterImplementor<P> parameter)

Overrides:

locateBinding in class AbstractCommonQueryContract

setTupleTransformer

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

Description copied from interface: Query

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface Query<R>

Specified by:

setTupleTransformer in interface QueryImplementor<R>

Overrides:

setTupleTransformer in class AbstractQuery<R>

setResultListTransformer

public QueryImplementor<R> setResultListTransformer(ResultListTransformer<R> resultListTransformer)

Description copied from interface: Query

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface Query<R>

Specified by:

setResultListTransformer in interface QueryImplementor<R>

Overrides:

setResultListTransformer in class AbstractQuery<R>

setLockMode

public HibernateOrmSearchQueryAdapter<R> setLockMode(LockModeType lockModeType)

Description copied from class: AbstractSelectionQuery

Specify the root LockModeType for the query

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Specified by:

setLockMode in interface TypedQuery<R>

Overrides:

setLockMode in class AbstractQuery<R>

Parameters:

lockModeType - lock mode

Returns:

the same query instance

See Also:

• AbstractSelectionQuery.setHibernateLockMode(org.hibernate.LockMode)

getLockMode

public LockModeType getLockMode()

Description copied from interface: SelectionQuery

Get the root LockModeType for the query

Specified by:

getLockMode in interface Query

Specified by:

getLockMode in interface SelectionQuery<R>

Overrides:

getLockMode in class AbstractQuery<R>

Returns:

lock mode

See Also:

• SelectionQuery.getHibernateLockMode()

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: SelectionQuery

The LockOptions currently in effect for the query

Specified by:

getLockOptions in interface Query<R>

Specified by:

getLockOptions in interface SelectionQuery<R>

Overrides:

getLockOptions in class AbstractQuery<R>

Returns:

The LockOptions currently in effect

See Also:

• LockOptions

executeUpdate

public int executeUpdate()
                  throws HibernateException

Description copied from interface: Query

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

For use with instances of MutationQuery created using QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaUpdate), or QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaDelete).

Specified by:

executeUpdate in interface MutationQuery

Specified by:

executeUpdate in interface Query

Specified by:

executeUpdate in interface Query<R>

Overrides:

executeUpdate in class AbstractQuery<R>

Returns:

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

Throws:

HibernateException

See Also:

• QueryProducer.createMutationQuery(java.lang.String)
• QueryProducer.createMutationQuery(String)
• QueryProducer.createNamedMutationQuery(String)
• QueryProducer.createNativeMutationQuery(String)
• Query.executeUpdate()
• QueryProducer.createMutationQuery(java.lang.String)

doExecuteUpdate

protected int doExecuteUpdate()

Specified by:

doExecuteUpdate in class AbstractQuery<R>

setLockMode

public HibernateOrmSearchQueryAdapter<R> setLockMode(String alias,
 LockMode lockMode)

Description copied from interface: SelectionQuery

Specify a LockMode to apply to a specific alias defined in the query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Overrides:

setLockMode in class AbstractQuery<R>

Parameters:

alias - A query alias

lockMode - The lock mode to apply

Returns:

this, for method chaining

See Also:

• Query.getLockOptions()