org.hibernate.search.query.hibernate.impl

Class FullTextQueryImpl

java.lang.Object

org.hibernate.query.internal.AbstractProducedQuery

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

All Implemented Interfaces:

Query, TypedQuery, BasicQueryContract<CommonQueryContract>, CommonQueryContract, QueryImplementor, org.hibernate.search.engine.ProjectionConstants, FullTextQuery

public class FullTextQueryImpl
extends AbstractProducedQuery
implements FullTextQuery

Implementation of FullTextQuery.

Author:

Emmanuel Bernard, Hardy Ferentschik

Field Summary

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.hibernate.search.query.engine.spi.HSQuery hSearchQuery, 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
int	doGetResultSize()
protected List	doHibernateSearchList()
org.hibernate.search.filter.FullTextFilter	enableFullTextFilter(String name) Enable a given filter by its name.
int	executeUpdate() Execute an 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()
int	getFirstResult() The position of the first result the query object was set to retrieve.
Map<String,Object>	getHints() Get the properties and hints and associated values that are in effect for the query instance.
LockModeType	getLockMode() Get the current lock mode for the query.
protected Map	getLockModes()
LockOptions	getLockOptions() Obtains the LockOptions in effect for this query.
int	getMaxResults() The maximum number of results the query object was set to retrieve.
QueryParameter<?>	getParameter(int position) Get the parameter object corresponding to the declared positional parameter with the given position.
QueryParameter	getParameter(int position, Class type) Get the parameter object corresponding to the declared positional parameter with the given position and type.
QueryParameter<?>	getParameter(String name) Get the parameter object corresponding to the declared parameter of the given name.
QueryParameter	getParameter(String name, Class type) Get the parameter object corresponding to the declared parameter of the given name and type.
Set<Parameter<?>>	getParameters() Get the parameter objects corresponding to the declared parameters of the query.
Object	getParameterValue(int position) Return the input value bound to the positional parameter.
Object	getParameterValue(Parameter param) Return the input value bound to the parameter.
Object	getParameterValue(String name) Return the input value bound to the named parameter.
protected QueryParameterBindings	getQueryParameterBindings()
String	getQueryString() Get the query string.
List	getResultList() Execute a SELECT query and return the query results as an untyped List.
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.
String[]	getReturnAliases() Deprecated.
Type[]	getReturnTypes() Deprecated.
boolean	hasPartialResults()
FullTextQueryImpl	initializeObjectsWith(org.hibernate.search.query.ObjectLookupMethod lookupMethod, org.hibernate.search.query.DatabaseRetrievalMethod retrievalMethod) Refine the strategies used to load entities.
boolean	isBound(Parameter param) Return a boolean indicating whether a value has been bound to the parameter.
protected boolean	isNativeQuery() Is the query represented here a native (SQL) query?
Iterator	iterate() Return an iterator on the results.
FullTextQueryImpl	limitExecutionTimeTo(long timeout, TimeUnit timeUnit) Limit the time used by Hibernate Search to execute the query.
List	list() Return the query results as a List.
ScrollableResultsImpl	scroll() Return the query results as ScrollableResults.
ScrollableResultsImplementor	scroll(ScrollMode scrollMode) Return the query results as ScrollableResults.
FullTextQueryImpl	setCriteriaQuery(Criteria criteria) Defines the Database Query used to load the Lucene results.
FullTextQueryImpl	setEntity(int position, Object val) Deprecated.
FullTextQueryImpl	setEntity(String name, Object val) Deprecated.
FullTextQueryImpl	setFetchSize(int fetchSize) Sets a JDBC fetch size hint for the query.
FullTextQueryImpl	setFilter(org.apache.lucene.search.Filter filter) Deprecated.
FullTextQuery	setFirstResult(int firstResult) Set the position of the first result to retrieve.
FullTextQueryImpl	setFlushMode(FlushModeType flushModeType) Set the flush mode type to be used for the query execution.
FullTextQuery	setHint(String hintName, Object value) Set a query property or hint.
FullTextQueryImpl	setLockMode(LockModeType lockModeType) Set the lock mode type to be used for the query execution.
QueryImplementor	setLockMode(String alias, LockMode lockMode) Set the LockMode to use for specific alias (as defined in the query's FROM clause).
QueryImplementor	setLockOptions(LockOptions lockOptions) Set the lock options for the query.
FullTextQuery	setMaxResults(int maxResults) Set the maximum number of results to retrieve.
FullTextQueryImpl	setParameter(int position, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
FullTextQueryImpl	setParameter(int position, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
FullTextQueryImpl	setParameter(int position, Object value) Bind an argument value to a positional parameter.
FullTextQueryImpl	setParameter(Parameter calendarParameter, Calendar calendar, TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object.
FullTextQueryImpl	setParameter(Parameter dateParameter, Date date, TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object.
FullTextQueryImpl	setParameter(Parameter tParameter, Object t) Bind the value of a Parameter object.
FullTextQueryImpl	setParameter(String name, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
FullTextQueryImpl	setParameter(String name, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
FullTextQueryImpl	setParameter(String name, Object value) Bind an argument value to a named parameter.
FullTextQueryImpl	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).
FullTextQueryImpl	setResultTransformer(ResultTransformer transformer) Deprecated.
FullTextQueryImpl	setSort(org.apache.lucene.search.Sort sort) Allows to let lucene sort the results.
FullTextQueryImpl	setSpatialParameters(org.hibernate.search.spatial.Coordinates center, String fieldName) Defines the center of the spatial search for this query to project distance in results
FullTextQueryImpl	setSpatialParameters(double latitude, double longitude, String fieldName) Defines the center of the spatial search for this query to project distance in results
FullTextQueryImpl	setTimeout(int timeout) Set the query timeout in seconds.
FullTextQueryImpl	setTimeout(long timeout, TimeUnit timeUnit) Define a timeout period for a given unit of time.
String	toString()
Object	unwrap(Class type) Return an object of the specified type to allow access to the provider-specific API.

Methods inherited from class org.hibernate.query.internal.AbstractProducedQuery

addQueryHint, afterQuery, applyAliasSpecificLockModeHint, applyCacheableHint, applyCacheModeHint, applyCacheRegionHint, applyCommentHint, applyEntityGraphQueryHint, applyFetchSizeHint, applyFlushModeHint, applyFollowOnLockingHint, applyHibernateLockModeHint, applyJpaCacheRetrieveMode, applyJpaCacheStoreMode, applyLockModeTypeHint, applyLockTimeoutHint, applyNativeQueryLockMode, applyPassDistinctThrough, applyReadOnlyHint, applyTimeoutHint, beforeQuery, canApplyAliasSpecificLockModeHints, collectBaselineHints, collectHints, determineProperBooleanType, determineProperBooleanType, determineType, doExecuteUpdate, doIterate, doList, doScroll, getCacheMode, getCacheRegion, getComment, getExceptionConverter, getFetchSize, getFlushMode, getHibernateFlushMode, getNamedParameterMap, getNamedParameters, getParameterMetadata, getPositionalParameterTypes, getPositionalParameterValues, getProducer, getQueryOptions, getQueryParameters, getSingleResult, getSupportedHints, getTimeout, handleUnrecognizedHint, isCacheable, isCallable, isReadOnly, makeQueryParametersForExecution, putIfNotNull, putIfNotNull, resolveEntityName, setCacheable, setCacheMode, setCacheRegion, setComment, setFlushMode, setHibernateFlushMode, setOptionalEntityName, setOptionalId, setOptionalObject, setParameter, 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, setProperties, setProperties, setReadOnly, stream, uniqueElement, uniqueResult, uniqueResultOptional

Methods inherited from class java.lang.Object

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

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

getProducer, setOptionalEntityName, setOptionalId, setOptionalObject

Methods inherited from interface org.hibernate.query.Query

addQueryHint, getCacheMode, getCacheRegion, getComment, getFetchSize, getHibernateFlushMode, getParameterMetadata, getResultStream, getSingleResult, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setCacheable, setCacheMode, setCacheRegion, setCalendar, setCalendar, setCalendarDate, setCalendarDate, setCharacter, setCharacter, setComment, setDate, setDate, setDouble, setDouble, setFloat, setFloat, setFlushMode, setHibernateFlushMode, setInteger, setInteger, setLocale, setLocale, setLong, setLong, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameters, setProperties, setProperties, setReadOnly, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimestamp, setTimestamp, stream, uniqueResult, uniqueResultOptional

Methods inherited from interface org.hibernate.Query

determineProperBooleanType, determineProperBooleanType, getFlushMode, getHibernateFirstResult, getHibernateMaxResults, getNamedParameters, getQueryOptions, getTimeout, isCacheable, isReadOnly, setHibernateFirstResult, setHibernateMaxResults, setParameterList, setParameterList, setParameterList, setParameterList

Constructor Detail

FullTextQueryImpl

public FullTextQueryImpl(org.hibernate.search.query.engine.spi.HSQuery hSearchQuery,
                         SessionImplementor session,
                         ParameterMetadata parameterMetadata)

Constructs a FullTextQueryImpl instance.

Parameters:

hSearchQuery - The query

session - Access to the Hibernate session.

parameterMetadata - Additional query metadata.

Method Detail

setSort

public FullTextQueryImpl 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

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

Deprecated.

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

getResultList

public List getResultList()

Description copied from interface: Query

Execute a SELECT query and return the query results as an untyped List.

Specified by:

getResultList in interface Query

Specified by:

getResultList in interface TypedQuery

Returns:

a list of the results

iterate

public Iterator iterate()

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

Overrides:

iterate in class AbstractProducedQuery

Returns:

the result iterator

scroll

public ScrollableResultsImpl 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.

You should call ScrollableResults.close() after processing the ScrollableResults so that the underlying resources are deallocated right away.

Overrides:

scroll in class AbstractProducedQuery

Returns:

the result iterator

See Also:

ScrollableResults

scroll

public ScrollableResultsImplementor 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.

You should call ScrollableResults.close() after processing the ScrollableResults so that the underlying resources are deallocated right away.

Overrides:

scroll in class AbstractProducedQuery

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

Overrides:

list in class AbstractProducedQuery

Returns:

the result list

doHibernateSearchList

protected List doHibernateSearchList()

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:

Lucene Explanation

getResultSize

public int getResultSize()

Description copied from interface: FullTextQuery

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.

Specified by:

getResultSize in interface FullTextQuery

Returns:

the number of hits for this search

doGetResultSize

public int doGetResultSize()

setCriteriaQuery

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

Returns:

this for method chaining

setProjection

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

Returns:

this for method chaining

setSpatialParameters

public FullTextQueryImpl 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 FullTextQueryImpl 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

setMaxResults

public FullTextQuery setMaxResults(int maxResults)

Description copied from interface: TypedQuery

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface TypedQuery

Specified by:

setMaxResults in interface FullTextQuery

Overrides:

setMaxResults in class AbstractProducedQuery

Parameters:

maxResults - maximum number of results to retrieve

Returns:

the same query instance

getMaxResults

public int getMaxResults()

Description copied from interface: Query

The maximum number of results the query object was set to retrieve. Returns Integer.MAX_VALUE if setMaxResults was not applied to the query object.

Specified by:

getMaxResults in interface Query

Overrides:

getMaxResults in class AbstractProducedQuery

Returns:

maximum number of results

setFirstResult

public FullTextQuery setFirstResult(int firstResult)

Description copied from interface: TypedQuery

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface TypedQuery

Specified by:

setFirstResult in interface FullTextQuery

Overrides:

setFirstResult in class AbstractProducedQuery

Parameters:

firstResult - position of the first result, numbered from 0

Returns:

the same query instance

getFirstResult

public int getFirstResult()

Description copied from interface: Query

The position of the first result the query object was set to retrieve. Returns 0 if setFirstResult was not applied to the query object.

Specified by:

getFirstResult in interface Query

Overrides:

getFirstResult in class AbstractProducedQuery

Returns:

position of the first result

setHint

public FullTextQuery setHint(String hintName,
                             Object value)

Description copied from interface: TypedQuery

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

Specified by:

setHint in interface TypedQuery

Specified by:

setHint in interface FullTextQuery

Overrides:

setHint in class AbstractProducedQuery

Parameters:

hintName - name of property or hint

value - value for the property or hint

Returns:

the same query instance

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 AbstractProducedQuery

Returns:

query properties and hints

setParameter

public FullTextQueryImpl setParameter(Parameter tParameter,
                                      Object t)

Description copied from interface: TypedQuery

Bind the value of a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

tParameter - parameter object

t - parameter value

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(Parameter calendarParameter,
                                      Calendar calendar,
                                      TemporalType temporalType)

Description copied from interface: TypedQuery

Bind an instance of java.util.Calendar to a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

calendarParameter - parameter object

calendar - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(Parameter dateParameter,
                                      Date date,
                                      TemporalType temporalType)

Description copied from interface: TypedQuery

Bind an instance of java.util.Date to a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

dateParameter - parameter object

date - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(String name,
                                      Object value)

Description copied from interface: TypedQuery

Bind an argument value to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(String name,
                                      Date value,
                                      TemporalType temporalType)

Description copied from interface: TypedQuery

Bind an instance of java.util.Date to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(String name,
                                      Calendar value,
                                      TemporalType temporalType)

Description copied from interface: TypedQuery

Bind an instance of java.util.Calendar to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(int position,
                                      Object value)

Description copied from interface: TypedQuery

Bind an argument value to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

position - position

value - parameter value

Returns:

the same query instance

setParameter

public FullTextQueryImpl setParameter(int position,
                                      Date value,
                                      TemporalType temporalType)

Description copied from interface: TypedQuery

Bind an instance of java.util.Date to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

getParameters

public Set<Parameter<?>> getParameters()

Description copied from interface: Query

Get the parameter objects corresponding to the declared parameters of the query. Returns empty set if the query has no parameters. This method is not required to be supported for native queries.

Specified by:

getParameters in interface Query

Overrides:

getParameters in class AbstractProducedQuery

Returns:

set of the parameter objects

getQueryParameterBindings

protected QueryParameterBindings getQueryParameterBindings()

Specified by:

getQueryParameterBindings in class AbstractProducedQuery

setParameter

public FullTextQueryImpl setParameter(int position,
                                      Calendar value,
                                      TemporalType temporalType)

Description copied from interface: TypedQuery

Bind an instance of java.util.Calendar to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery

Overrides:

setParameter in class AbstractProducedQuery

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

getParameter

public QueryParameter<?> getParameter(String name)

Description copied from interface: Query

Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.

Specified by:

getParameter in interface Query

Overrides:

getParameter in class AbstractProducedQuery

Parameters:

name - parameter name

Returns:

parameter object

getParameter

public QueryParameter<?> getParameter(int position)

Description copied from interface: Query

Get the parameter object corresponding to the declared positional parameter with the given position. This method is not required to be supported for native queries.

Specified by:

getParameter in interface Query

Overrides:

getParameter in class AbstractProducedQuery

Parameters:

position - position

Returns:

parameter object

getParameter

public QueryParameter getParameter(String name,
                                   Class type)

Description copied from interface: Query

Get the parameter object corresponding to the declared parameter of the given name and type. This method is required to be supported for criteria queries only.

Specified by:

getParameter in interface Query

Overrides:

getParameter in class AbstractProducedQuery

Parameters:

name - parameter name

type - type

Returns:

parameter object

getParameter

public QueryParameter getParameter(int position,
                                   Class type)

Description copied from interface: Query

Get the parameter object corresponding to the declared positional parameter with the given position and type. This method is not required to be supported by the provider.

Specified by:

getParameter in interface Query

Overrides:

getParameter in class AbstractProducedQuery

Parameters:

position - position

type - type

Returns:

parameter object

isBound

public boolean isBound(Parameter param)

Description copied from interface: Query

Return a boolean indicating whether a value has been bound to the parameter.

Specified by:

isBound in interface Query

Overrides:

isBound in class AbstractProducedQuery

Parameters:

param - parameter object

Returns:

boolean indicating whether parameter has been bound

getParameterValue

public Object getParameterValue(Parameter param)

Description copied from interface: Query

Return the input value bound to the parameter. (Note that OUT parameters are unbound.)

Specified by:

getParameterValue in interface Query

Overrides:

getParameterValue in class AbstractProducedQuery

Parameters:

param - parameter object

Returns:

parameter value

getParameterValue

public Object getParameterValue(String name)

Description copied from interface: Query

Return the input value bound to the named parameter. (Note that OUT parameters are unbound.)

Specified by:

getParameterValue in interface Query

Overrides:

getParameterValue in class AbstractProducedQuery

Parameters:

name - parameter name

Returns:

parameter value

getParameterValue

public Object getParameterValue(int position)

Description copied from interface: Query

Return the input value bound to the positional parameter. (Note that OUT parameters are unbound.)

Specified by:

getParameterValue in interface Query

Overrides:

getParameterValue in class AbstractProducedQuery

Parameters:

position - position

Returns:

parameter value

setFlushMode

public FullTextQueryImpl setFlushMode(FlushModeType flushModeType)

Description copied from interface: TypedQuery

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

Specified by:

setFlushMode in interface TypedQuery

Specified by:

setFlushMode in interface FullTextQuery

Overrides:

setFlushMode in class AbstractProducedQuery

Parameters:

flushModeType - flush mode

Returns:

the same query instance

setFetchSize

public FullTextQueryImpl setFetchSize(int fetchSize)

Description copied from interface: Query

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface BasicQueryContract<CommonQueryContract>

Overrides:

setFetchSize in class AbstractProducedQuery

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

Query.getFetchSize()

setLockOptions

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

Overrides:

setLockOptions in class AbstractProducedQuery

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

setResultTransformer

@Deprecated
public FullTextQueryImpl setResultTransformer(ResultTransformer transformer)

Deprecated.

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 FullTextQuery

Overrides:

setResultTransformer in class AbstractProducedQuery

Parameters:

transformer - The transformer to apply

Returns:

this (for method chaining)

unwrap

public Object unwrap(Class type)

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.

Specified by:

unwrap in interface Query

Overrides:

unwrap in class AbstractProducedQuery

Parameters:

type - 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

setLockMode

public FullTextQueryImpl setLockMode(LockModeType lockModeType)

Description copied from interface: TypedQuery

Set the lock mode type to be used for the query execution.

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface TypedQuery

Overrides:

setLockMode in class AbstractProducedQuery

Parameters:

lockModeType - lock mode

Returns:

the same query instance

getLockMode

public LockModeType getLockMode()

Description copied from interface: Query

Get the current lock mode for the query. Returns null if a lock mode has not been set on the query object.

Specified by:

getLockMode in interface Query

Overrides:

getLockMode in class AbstractProducedQuery

Returns:

lock mode

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: Query

Obtains the LockOptions in effect for this query.

Overrides:

getLockOptions in class AbstractProducedQuery

Returns:

The LockOptions

See Also:

LockOptions

executeUpdate

public int executeUpdate()

Description copied from interface: Query

Execute an update or delete statement.

Specified by:

executeUpdate in interface Query

Overrides:

executeUpdate in class AbstractProducedQuery

Returns:

the number of entities updated or deleted

setLockMode

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

Overrides:

setLockMode in class AbstractProducedQuery

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

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 filter nane

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 FullTextQueryImpl setTimeout(int timeout)

Description copied from interface: Query

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<CommonQueryContract>

Overrides:

setTimeout in class AbstractProducedQuery

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

Query.getTimeout()

setTimeout

public FullTextQueryImpl 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 FullTextQueryImpl limitExecutionTimeTo(long timeout,
                                              TimeUnit timeUnit)

Description copied from interface: FullTextQuery

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

hasPartialResults

public boolean hasPartialResults()

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

retrievalMethod - how to initilize an object

Returns:

this for method chaining

getQueryString

public String getQueryString()

Description copied from interface: Query

Get the query string.

Returns:

the query string

isNativeQuery

protected boolean isNativeQuery()

Description copied from class: AbstractProducedQuery

Is the query represented here a native (SQL) query?

Specified by:

isNativeQuery in class AbstractProducedQuery

Returns:

true if it is a native query; false otherwise

getReturnTypes

@Deprecated
public Type[] getReturnTypes()

Deprecated.

Description copied from interface: Query

Return the Hibernate types of the query results.

Specified by:

getReturnTypes in interface BasicQueryContract<CommonQueryContract>

Returns:

an array of types

getReturnAliases

@Deprecated
public String[] getReturnAliases()

Deprecated.

setEntity

@Deprecated
public FullTextQueryImpl setEntity(int position,
                                               Object val)

Deprecated.

Description copied from interface: Query

Bind an instance of a mapped persistent class to a JDBC-style query parameter. Use Query.setParameter(int, Object) for null values.

Parameters:

position - the position of the parameter in the query string, numbered from 0.

val - a non-null instance of a persistent class

Returns:

this, for method chaining

setEntity

@Deprecated
public FullTextQueryImpl setEntity(String name,
                                               Object val)

Deprecated.

Description copied from interface: Query

Bind an instance of a mapped persistent class to a named query parameter. Use Query.setParameter(String, Object) for null values.

Parameters:

name - the name of the parameter

val - a non-null instance of a persistent class

Returns:

this, for method chaining

toString

public String toString()

Overrides:

toString in class Object