org.hibernate.search.query.hibernate.impl

Class FullTextQueryImpl

java.lang.Object

org.hibernate.internal.AbstractQueryImpl

org.hibernate.search.query.hibernate.impl.FullTextQueryImpl

All Implemented Interfaces:

BasicQueryContract, Query, org.hibernate.search.engine.ProjectionConstants, FullTextQuery

public class FullTextQueryImpl
extends AbstractQueryImpl
implements FullTextQuery

Implementation of FullTextQuery.

Author:

Emmanuel Bernard, Hardy Ferentschik

Field Summary

Fields inherited from class org.hibernate.internal.AbstractQueryImpl

parameterMetadata, session

Fields inherited from interface org.hibernate.search.engine.ProjectionConstants

DOCUMENT, DOCUMENT_ID, EXPLANATION, ID, OBJECT_CLASS, SCORE, SPATIAL_DISTANCE, THIS

Constructor Summary

Constructors

Constructor and Description
FullTextQueryImpl(org.apache.lucene.search.Query query, Class<?>[] classes, SessionImplementor session, ParameterMetadata parameterMetadata) Constructs a FullTextQueryImpl instance.

Method Summary

Modifier and Type	Method and Description
void	disableFullTextFilter(String name) Disable a given filter by its name.
org.hibernate.search.filter.FullTextFilter	enableFullTextFilter(String name) Enable a given filter by its name.
int	executeUpdate() Execute the update or delete statement.
org.apache.lucene.search.Explanation	explain(int documentId) Return the Lucene Explanation object describing the score computation for the matching object/document in the current query
org.hibernate.search.query.engine.spi.FacetManager	getFacetManager()
protected Map	getLockModes()
LockOptions	getLockOptions() Obtains the LockOptions in effect for this query.
int	getResultSize()
boolean	hasPartialResults() Experimental API, subject to change or removal
FullTextQuery	initializeObjectsWith(org.hibernate.search.query.ObjectLookupMethod lookupMethod, org.hibernate.search.query.DatabaseRetrievalMethod retrievalMethod) Refine the strategies used to load entities.
Iterator	iterate() Return an iterator on the results.
FullTextQuery	limitExecutionTimeTo(long timeout, TimeUnit timeUnit) *Experimental* API, subject to change or removal Limit the time used by Hibernate Search to execute the query.
List	list() Return the query results as a List.
ScrollableResults	scroll() Return the query results as ScrollableResults.
ScrollableResults	scroll(ScrollMode scrollMode) Return the query results as ScrollableResults.
FullTextQuery	setCriteriaQuery(Criteria criteria) Defines the Database Query used to load the Lucene results.
FullTextQuery	setFetchSize(int fetchSize) Sets a JDBC fetch size hint for the query.
FullTextQuery	setFilter(org.apache.lucene.search.Filter filter) Allows to set a single Lucene filter.
FullTextQuery	setFirstResult(int firstResult) Set the first row to retrieve.
Query	setLockMode(String alias, LockMode lockMode) Set the LockMode to use for specific alias (as defined in the query's FROM clause).
Query	setLockOptions(LockOptions lockOptions) Set the lock options for the query.
FullTextQuery	setMaxResults(int maxResults) Set the maximum number of rows to retrieve.
FullTextQuery	setProjection(String... fields) Defines the Lucene field names projected and returned in a query result Each field is converted back to it's object representation, an Object[] being returned for each "row" (similar to an HQL or a Criteria API projection).
FullTextQuery	setResultTransformer(ResultTransformer transformer) Set a strategy for handling the query results.
FullTextQuery	setSort(org.apache.lucene.search.Sort sort) Allows to let lucene sort the results.
FullTextQuery	setSpatialParameters(org.hibernate.search.spatial.Coordinates center, String fieldName) Defines the center of the spatial search for this query to project distance in results
FullTextQuery	setSpatialParameters(double latitude, double longitude, String fieldName) Defines the center of the spatial search for this query to project distance in results
FullTextQuery	setTimeout(int timeout) Set the query timeout in seconds.
FullTextQuery	setTimeout(long timeout, TimeUnit timeUnit) Define a timeout period for a given unit of time.
<T> T	unwrap(Class<T> type)

Methods inherited from class org.hibernate.internal.AbstractQueryImpl

addQueryHint, after, applyEntityGraphQueryHint, before, determineType, determineType, determineType, determineType, determineType, expandParameterLists, getCacheMode, getCacheRegion, getComment, getFetchSize, getFirstResult, getFlushMode, getMaxResults, getNamedParameterLists, getNamedParameters, getNamedParams, getParameterMetadata, getQueryParameters, getQueryString, getReturnAliases, getReturnTypes, getRowSelection, getTimeout, getTypes, getValues, guessType, hasNamedParameters, isCacheable, isReadOnly, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setCacheable, setCacheMode, setCacheRegion, setCalendar, setCalendar, setCalendarDate, setCalendarDate, setCharacter, setCharacter, setCollectionKey, setComment, setDate, setDate, setDouble, setDouble, setEntity, setEntity, setFloat, setFloat, setFlushMode, setInteger, setInteger, setLocale, setLocale, setLong, setLong, setOptionalEntityName, setOptionalId, setOptionalObject, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameters, setProperties, setProperties, setReadOnly, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimestamp, setTimestamp, toString, typeArray, uniqueResult, valueArray, verifyParameters, verifyParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.Query

addQueryHint, getComment, getFirstResult, getMaxResults, getNamedParameters, getQueryString, getReturnAliases, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setCacheable, setCacheMode, setCacheRegion, setCalendar, setCalendar, setCalendarDate, setCalendarDate, setCharacter, setCharacter, setComment, setDate, setDate, setDouble, setDouble, setEntity, setEntity, setFloat, setFloat, setFlushMode, setInteger, setInteger, setLocale, setLocale, setLong, setLong, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameters, setProperties, setProperties, setReadOnly, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimestamp, setTimestamp, uniqueResult

Methods inherited from interface org.hibernate.BasicQueryContract

getCacheMode, getCacheRegion, getFetchSize, getFlushMode, getReturnTypes, getTimeout, isCacheable, isReadOnly

Constructor Detail

FullTextQueryImpl

public FullTextQueryImpl(org.apache.lucene.search.Query query,
                         Class<?>[] classes,
                         SessionImplementor session,
                         ParameterMetadata parameterMetadata)

Constructs a FullTextQueryImpl instance.

Parameters:

query - The Lucene query.

classes - Array of classes (must be immutable) used to filter the results to the given class types.

session - Access to the Hibernate session.

parameterMetadata - Additional query metadata.

Method Detail

setSort

public FullTextQuery setSort(org.apache.lucene.search.Sort sort)

Description copied from interface: FullTextQuery

Allows to let lucene sort the results. This is useful when you have additional sort requirements on top of the default lucene ranking. Without lucene sorting you would have to retrieve the full result set and order the hibernate objects.

Specified by:

setSort in interface FullTextQuery

Parameters:

sort - The lucene sort object.

Returns:

this for method chaining

setFilter

public FullTextQuery setFilter(org.apache.lucene.search.Filter filter)

Description copied from interface: FullTextQuery

Allows to set a single Lucene filter.

Specified by:

setFilter in interface FullTextQuery

Parameters:

filter - The Lucene filter.

Returns:

this for method chaining

See Also:

Filter

iterate

public Iterator iterate()

Return an iterator on the results. Retrieve the object one by one (initialize it during the next() operation)

Specified by:

iterate in interface Query

Returns:

the result iterator

scroll

public ScrollableResults scroll()

Description copied from interface: Query

Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.

Specified by:

scroll in interface Query

Returns:

the result iterator

See Also:

ScrollableResults

scroll

public ScrollableResults scroll(ScrollMode scrollMode)

Description copied from interface: Query

Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.

Specified by:

scroll in interface Query

Parameters:

scrollMode - The scroll mode

Returns:

the result iterator

See Also:

ScrollableResults, ScrollMode

list

public List list()

Description copied from interface: Query

Return the query results as a List. If the query contains multiple results per row, the results are returned in an instance of Object[].

Specified by:

list in interface Query

Returns:

the result list

explain

public org.apache.lucene.search.Explanation explain(int documentId)

Description copied from interface: FullTextQuery

Return the Lucene Explanation object describing the score computation for the matching object/document in the current query

Specified by:

explain in interface FullTextQuery

Parameters:

documentId - Lucene Document id to be explain. This is NOT the object id

Returns:

An Lucene Explanation instance

getResultSize

public int getResultSize()

Specified by:

getResultSize in interface FullTextQuery

Returns:

the number of hits for this search.

Caution: The number of results might be slightly different from list().size() because list() if the index is not in sync with the database at the time of query.

setCriteriaQuery

public FullTextQuery setCriteriaQuery(Criteria criteria)

Description copied from interface: FullTextQuery

Defines the Database Query used to load the Lucene results. Useful to load a given object graph by refining the fetch modes.

• No projection (criteria.setProjection()) allowed, the root entity must be the only returned type
• No where restriction can be defined either

Specified by:

setCriteriaQuery in interface FullTextQuery

Parameters:

criteria - Hibernate criteria query used to load results

Returns:

this for method chaining

setProjection

public FullTextQuery setProjection(String... fields)

Description copied from interface: FullTextQuery

Defines the Lucene field names projected and returned in a query result Each field is converted back to it's object representation, an Object[] being returned for each "row" (similar to an HQL or a Criteria API projection).

A projectable field must be stored in the Lucene index and use a TwoWayFieldBridge Unless notified in their JavaDoc, all built-in bridges are two-way. All @DocumentId fields are projectable by design.

If the projected field is not a projectable field, null is returned in the object[]

Specified by:

setProjection in interface FullTextQuery

Parameters:

fields - list of field names to project on

Returns:

this for method chaining

setSpatialParameters

public FullTextQuery setSpatialParameters(org.hibernate.search.spatial.Coordinates center,
                                          String fieldName)

Description copied from interface: FullTextQuery

Defines the center of the spatial search for this query to project distance in results

Specified by:

setSpatialParameters in interface FullTextQuery

Parameters:

center - the search center

fieldName - name of the spatial field

Returns:

this for method chaining

setSpatialParameters

public FullTextQuery setSpatialParameters(double latitude,
                                          double longitude,
                                          String fieldName)

Description copied from interface: FullTextQuery

Defines the center of the spatial search for this query to project distance in results

Specified by:

setSpatialParameters in interface FullTextQuery

Parameters:

latitude - latitude of the search center

longitude - longitude of the search center

fieldName - name of the spatial field

Returns:

this for method chaining

setFirstResult

public FullTextQuery setFirstResult(int firstResult)

Description copied from interface: Query

Set the first row to retrieve.

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface FullTextQuery

Overrides:

setFirstResult in class AbstractQueryImpl

Parameters:

firstResult - a row number, numbered from 0

Returns:

this, for method chaining

See Also:

Query.getFirstResult()

setMaxResults

public FullTextQuery setMaxResults(int maxResults)

Description copied from interface: Query

Set the maximum number of rows to retrieve.

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface FullTextQuery

Overrides:

setMaxResults in class AbstractQueryImpl

Parameters:

maxResults - the maximum number of rows

Returns:

this, for method chaining

See Also:

Query.getMaxResults()

setFetchSize

public FullTextQuery setFetchSize(int fetchSize)

Description copied from interface: BasicQueryContract

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface BasicQueryContract

Specified by:

setFetchSize in interface Query

Specified by:

setFetchSize in interface FullTextQuery

Overrides:

setFetchSize in class AbstractQueryImpl

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

BasicQueryContract.getFetchSize()

setLockOptions

public Query setLockOptions(LockOptions lockOptions)

Description copied from interface: Query

Set the lock options for the query. Specifically only the following are taken into consideration:

1. LockOptions.getLockMode()
2. LockOptions.getScope()
3. LockOptions.getTimeOut()

For alias-specific locking, use Query.setLockMode(String, LockMode).

Specified by:

setLockOptions in interface Query

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

setResultTransformer

public FullTextQuery setResultTransformer(ResultTransformer transformer)

Description copied from interface: Query

Set a strategy for handling the query results. This can be used to change "shape" of the query result.

Specified by:

setResultTransformer in interface Query

Specified by:

setResultTransformer in interface FullTextQuery

Overrides:

setResultTransformer in class AbstractQueryImpl

Parameters:

transformer - The transformer to apply

Returns:

this (for method chaining)

unwrap

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

Specified by:

unwrap in interface FullTextQuery

Type Parameters:

T - the type of the unwrapped object

Parameters:

type - the type to unwrap

Returns:

the underlying type if possible. If not possible to unwrap to the given type an IllegalArgumentException is thrown. Supported types are:

• org.apache.lucene.search.Query the underlying lucene query

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: Query

Obtains the LockOptions in effect for this query.

Specified by:

getLockOptions in interface Query

Specified by:

getLockOptions in class AbstractQueryImpl

Returns:

The LockOptions

See Also:

LockOptions

executeUpdate

public int executeUpdate()

Description copied from interface: Query

Execute the update or delete statement. The semantics are compliant with the ejb3 Query.executeUpdate() method.

Specified by:

executeUpdate in interface Query

Returns:

The number of entities updated or deleted.

setLockMode

public Query setLockMode(String alias,
                         LockMode lockMode)

Description copied from interface: Query

Set the LockMode to use for specific alias (as defined in the query's FROM clause). The alias-specific lock modes specified here are added to the query's internal LockOptions. The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally speaking, for maximum portability, this method should only be used to mark that the rows corresponding to the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE).

Specified by:

setLockMode in interface Query

Parameters:

alias - a query alias, or "this" for a collection filter

lockMode - The lock mode to apply.

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

getLockModes

protected Map getLockModes()

enableFullTextFilter

public org.hibernate.search.filter.FullTextFilter enableFullTextFilter(String name)

Description copied from interface: FullTextQuery

Enable a given filter by its name.

Specified by:

enableFullTextFilter in interface FullTextQuery

Parameters:

name - the name of the filter to enable

Returns:

Returns a FullTextFilter object that allows filter parameter injection

disableFullTextFilter

public void disableFullTextFilter(String name)

Description copied from interface: FullTextQuery

Disable a given filter by its name.

Specified by:

disableFullTextFilter in interface FullTextQuery

Parameters:

name - the name of the filter to disable.

getFacetManager

public org.hibernate.search.query.engine.spi.FacetManager getFacetManager()

Specified by:

getFacetManager in interface FullTextQuery

Returns:

return the manager for all faceting related operations

setTimeout

public FullTextQuery setTimeout(int timeout)

Description copied from interface: BasicQueryContract

Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.

Specified by:

setTimeout in interface BasicQueryContract

Specified by:

setTimeout in interface Query

Overrides:

setTimeout in class AbstractQueryImpl

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

BasicQueryContract.getTimeout()

setTimeout

public FullTextQuery setTimeout(long timeout,
                                TimeUnit timeUnit)

Description copied from interface: FullTextQuery

Define a timeout period for a given unit of time. Note that this is time out is on a best effort basis. When the query goes beyond the timeout, a QueryTimeoutException is raised.

Specified by:

setTimeout in interface FullTextQuery

Parameters:

timeout - time out period

timeUnit - time out unit

Returns:

this to allow method chaining

limitExecutionTimeTo

public FullTextQuery limitExecutionTimeTo(long timeout,
                                          TimeUnit timeUnit)

Description copied from interface: FullTextQuery

*Experimental* API, subject to change or removal Limit the time used by Hibernate Search to execute the query. When the limit is reached, results already fetched are returned. This time limit is a best effort. The query will likely run for longer than the provided time. The time limit only applies to the interactions between Hibernate Search and Lucene. In other words, a query to the database will not be limited. If the limit is reached and all results are not yet fetched, FullTextQuery.hasPartialResults() returns true.

Specified by:

limitExecutionTimeTo in interface FullTextQuery

Parameters:

timeout - time out period

timeUnit - time out unit

Returns:

this to allow method chaining

hasPartialResults

public boolean hasPartialResults()

Description copied from interface: FullTextQuery

Experimental API, subject to change or removal

Specified by:

hasPartialResults in interface FullTextQuery

Returns:

When using FullTextQuery.limitExecutionTimeTo(long, java.util.concurrent.TimeUnit) }, returns true if partial results are returned (ie if the time limit has been reached and the result fetching process has been terminated.

initializeObjectsWith

public FullTextQuery initializeObjectsWith(org.hibernate.search.query.ObjectLookupMethod lookupMethod,
                                           org.hibernate.search.query.DatabaseRetrievalMethod retrievalMethod)

Description copied from interface: FullTextQuery

Refine the strategies used to load entities. The lookup method defines whether or not to lookup first in the second level cache or the persistence context before trying to initialize objects from the database. Defaults to SKIP. The database retrieval method defines how objects are loaded from the database. Defaults to QUERY. Note that Hibernate Search can deviate from these choices when it makes sense.

Specified by:

initializeObjectsWith in interface FullTextQuery

Parameters:

lookupMethod - the lookuip strategy

retrievalMethod - the retrieval strategy

Returns:

this to allow method chaining