org.hibernate.search.jpa

Interface FullTextQuery

All Superinterfaces:

org.hibernate.search.engine.ProjectionConstants, Query

All Known Subinterfaces:

FullTextQuery

All Known Implementing Classes:

FullTextQueryImpl

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

The base interface for full-text queries using the JPA API (Query).

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() Returns the number of hits for this search Caution: The number of results might be slightly different from getResultList().size() because getResultList() may be not in sync with the database at the time of query.
boolean	hasPartialResults()
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) 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	setFilter(org.apache.lucene.search.Filter filter) Deprecated.
FullTextQuery	setFirstResult(int var1) Set the position of the first result to retrieve.
FullTextQuery	setFlushMode(FlushModeType flushMode) Set the flush mode type to be used for the query execution.
FullTextQuery	setHint(String hintName, Object value) Set a query property or hint.
FullTextQuery	setMaxResults(int maxResult) Set the maximum number of results 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) Defines a result transformer used during projection
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.

Methods inherited from interface javax.persistence.Query

executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getResultList, getResultStream, getSingleResult, isBound, setLockMode, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, unwrap

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 getResultList().size() because getResultList() may be not in sync with the database at the time of query.

Returns:

the number of hits for this search

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 - a query defined using Criteria

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 - the fields to use for projection

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

Returns:

a FullTextFilter object that allows filter parameter injection

disableFullTextFilter

void disableFullTextFilter(String name)

Disable a given filter by its name

Parameters:

name - the filter nane

getFacetManager

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

Returns:

return the manager for all faceting related operations

setResultTransformer

FullTextQuery setResultTransformer(ResultTransformer transformer)

Defines a result transformer used during projection

Parameters:

transformer - the ResultTransformer to use during projection

Returns:

this for method chaining

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:

Lucene Explanation

limitExecutionTimeTo

FullTextQuery limitExecutionTimeTo(long timeout,
                                   TimeUnit timeUnit)

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 for method chaining

hasPartialResults

boolean hasPartialResults()

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 - lookup method

retrievalMethod - how to initilize an object

Returns:

this for method chaining

setMaxResults

FullTextQuery setMaxResults(int maxResult)

Description copied from interface: Query

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface Query

Parameters:

maxResult - maximum number of results to retrieve

Returns:

the same query instance

setFirstResult

FullTextQuery setFirstResult(int var1)

Description copied from interface: Query

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface Query

Parameters:

var1 - position of the first result, numbered from 0

Returns:

the same query instance

setHint

FullTextQuery setHint(String hintName,
                      Object value)

Description copied from interface: Query

Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, this hint may or may not be observed.

Specified by:

setHint in interface Query

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

setFlushMode

FullTextQuery setFlushMode(FlushModeType flushMode)

Description copied from interface: Query

Set the flush mode type to be used for the query execution. The flush mode type applies to the query regardless of the flush mode type in use for the entity manager.

Specified by:

setFlushMode in interface Query

Parameters:

flushMode - flush mode

Returns:

the same query instance

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