org.hibernate.search

Interface FullTextQuery

All Superinterfaces:

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

All Known Implementing Classes:

FullTextQueryImpl

public interface FullTextQuery
extends Query, org.hibernate.search.engine.ProjectionConstants

The base interface for Lucene powered searches.

Author:

Hardy Ferentschik, Emmanuel Bernard

Field Summary

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

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

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.
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()
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.
FullTextQuery	limitExecutionTimeTo(long timeout, TimeUnit timeUnit) *Experimental* API, subject to change or removal Limit the time used by Hibernate Search to execute the query.
FullTextQuery	setCriteriaQuery(Criteria criteria) Defines the Database Query used to load the Lucene results.
FullTextQuery	setFetchSize(int i) Defines scrollable result fetch size as well as the JDBC fetch size
FullTextQuery	setFilter(org.apache.lucene.search.Filter filter) Deprecated.
FullTextQuery	setFirstResult(int firstResult) Query.setFirstResult(int)
FullTextQuery	setMaxResults(int maxResults) Query.setMaxResults(int)
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) defines a result transformer used during projection, the Aliases provided are the projection aliases.
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(long timeout, TimeUnit timeUnit) Define a timeout period for a given unit of time.
<T> T	unwrap(Class<T> type)

Methods inherited from interface org.hibernate.Query

addQueryHint, executeUpdate, getComment, getFirstResult, getLockOptions, getMaxResults, getNamedParameters, getQueryString, getReturnAliases, iterate, list, scroll, scroll, 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, setLockMode, setLockOptions, setLong, setLong, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameters, setProperties, setProperties, setReadOnly, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimeout, setTimestamp, setTimestamp, uniqueResult

Methods inherited from interface org.hibernate.BasicQueryContract

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

Method Detail

setSort

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

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.

Parameters:

sort - The lucene sort object.

Returns:

this for method chaining

setFilter

@Deprecated
FullTextQuery setFilter(org.apache.lucene.search.Filter filter)

Deprecated.

Allows to set a single Lucene filter.

Parameters:

filter - The Lucene filter.

Returns:

this for method chaining

See Also:

Filter

getResultSize

int getResultSize()

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

FullTextQuery setCriteriaQuery(Criteria criteria)

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

Parameters:

criteria - Hibernate criteria query used to load results

Returns:

this for method chaining

setProjection

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

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

Parameters:

fields - list of field names to project on

Returns:

this for method chaining

setSpatialParameters

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

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

Parameters:

latitude - latitude of the search center

longitude - longitude of the search center

fieldName - name of the spatial field

Returns:

this for method chaining

setSpatialParameters

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

Parameters:

center - the search center

fieldName - name of the spatial field

Returns:

this for method chaining

enableFullTextFilter

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

Enable a given filter by its name.

Parameters:

name - the name of the filter to enable

Returns:

Returns a FullTextFilter object that allows filter parameter injection

Throws:

org.hibernate.search.exception.SearchException - in case the filter with the specified name is not defined

disableFullTextFilter

void disableFullTextFilter(String name)

Disable a given filter by its name.

Parameters:

name - the name of the filter to disable.

getFacetManager

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

Returns:

return the manager for all faceting related operations

explain

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

Parameters:

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

Returns:

An Lucene Explanation instance

setFirstResult

FullTextQuery setFirstResult(int firstResult)

Query.setFirstResult(int)

Specified by:

setFirstResult in interface Query

Parameters:

firstResult - a row number, numbered from 0

Returns:

this, for method chaining

See Also:

Query.getFirstResult()

setMaxResults

FullTextQuery setMaxResults(int maxResults)

Query.setMaxResults(int)

Specified by:

setMaxResults in interface Query

Parameters:

maxResults - the maximum number of rows

Returns:

this, for method chaining

See Also:

Query.getMaxResults()

setFetchSize

FullTextQuery setFetchSize(int i)

Defines scrollable result fetch size as well as the JDBC fetch size

Specified by:

setFetchSize in interface BasicQueryContract

Specified by:

setFetchSize in interface Query

Parameters:

i - the fetch size hint

Returns:

this, for method chaining

See Also:

BasicQueryContract.getFetchSize()

setResultTransformer

FullTextQuery setResultTransformer(ResultTransformer transformer)

defines a result transformer used during projection, the Aliases provided are the projection aliases.

Specified by:

setResultTransformer in interface Query

Parameters:

transformer - The transformer to apply

Returns:

this (for method chaining)

unwrap

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

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

setTimeout

FullTextQuery setTimeout(long timeout,
                         TimeUnit timeUnit)

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.

Parameters:

timeout - time out period

timeUnit - time out unit

Returns:

this to allow method chaining

limitExecutionTimeTo

FullTextQuery limitExecutionTimeTo(long timeout,
                                   TimeUnit timeUnit)

*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, hasPartialResults() returns true.

Parameters:

timeout - time out period

timeUnit - time out unit

Returns:

this to allow method chaining

hasPartialResults

boolean hasPartialResults()

Experimental API, subject to change or removal

Returns:

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

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

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.

Parameters:

lookupMethod - the lookuip strategy

retrievalMethod - the retrieval strategy

Returns:

this to allow method chaining