org.hibernate.search.query.engine.impl

Class LuceneHSQuery

java.lang.Object

org.hibernate.search.query.engine.impl.AbstractHSQuery

org.hibernate.search.query.engine.impl.LuceneHSQuery

All Implemented Interfaces:

Serializable, ProjectionConstants, HSQuery

public class LuceneHSQuery
extends AbstractHSQuery
implements HSQuery

Author:

Emmanuel Bernard, Hardy Ferentschik

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hibernate.search.query.engine.impl.AbstractHSQuery

extendedIntegrator, filterDefinitions, firstResult, hasThisProjection, HSEARCH_PROJECTION_FIELD_PREFIX, indexedTargetedEntities, maxResults, projectedFields, sort, spatialFieldName, spatialSearchCenter, targetedEntities, tenantId, timeoutExceptionFactory, timeoutManager, userFilter

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
LuceneHSQuery(org.apache.lucene.search.Query luceneQuery, ExtendedSearchIntegrator extendedIntegrator, IndexedTypeMap<CustomTypeMetadata> types)
LuceneHSQuery(org.apache.lucene.search.Query luceneQuery, ExtendedSearchIntegrator extendedIntegrator, IndexedTypeSet types)

Method Summary

Modifier and Type	Method and Description
protected TimeoutManagerImpl	buildTimeoutManager()
protected void	clearCachedResults() This class caches some of the query results and we need to reset the state in case something in the query changes (eg a new filter is set).
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
protected void	extractFacetResults()
FacetManagerImpl	getFacetManager()
protected Set<IndexManager>	getIndexManagers(EntityIndexBinding binding)
org.apache.lucene.search.Query	getLuceneQuery()
String	getQueryString()
protected Set<String>	getSupportedProjectionConstants()
HSQuery	luceneQuery(org.apache.lucene.search.Query query) Defines the underlying Lucene query
DocumentExtractor	queryDocumentExtractor() DocumentExtractor returns a traverser over the full-text results (EntityInfo) This operation is lazy bound: - the query is executed - results are not retrieved until actually requested DocumentExtractor objects *must* be closed when the results are no longer traversed.
List<EntityInfo>	queryEntityInfos() Execute the Lucene query and return the list of EntityInfos populated with metadata and projection.
int	queryResultSize()

Methods inherited from class org.hibernate.search.query.engine.impl.AbstractHSQuery

afterDeserialise, buildFacetingRequestsAndMetadata, buildTargetedEntityIndexBindingsByName, createFilterInstance, disableFullTextFilter, enableFullTextFilter, filter, firstResult, getCustomTypeMetadata, getExtendedSearchIntegrator, getIndexedTargetedEntities, getProjectedFields, getTargetedEntities, getTimeoutManager, hasThisProjection, isPreQueryFilterOnly, maxResults, projection, setSpatialParameters, sort, tenantIdentifier, timeoutExceptionFactory, validateSortFields

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.query.engine.spi.HSQuery

afterDeserialise, disableFullTextFilter, enableFullTextFilter, filter, firstResult, getExtendedSearchIntegrator, getIndexedTargetedEntities, getProjectedFields, getTargetedEntities, getTimeoutManager, hasThisProjection, maxResults, projection, setSpatialParameters, sort, tenantIdentifier, timeoutExceptionFactory

Constructor Detail

LuceneHSQuery

public LuceneHSQuery(org.apache.lucene.search.Query luceneQuery,
                     ExtendedSearchIntegrator extendedIntegrator,
                     IndexedTypeSet types)

LuceneHSQuery

public LuceneHSQuery(org.apache.lucene.search.Query luceneQuery,
                     ExtendedSearchIntegrator extendedIntegrator,
                     IndexedTypeMap<CustomTypeMetadata> types)

Method Detail

luceneQuery

public HSQuery luceneQuery(org.apache.lucene.search.Query query)

Description copied from interface: HSQuery

Defines the underlying Lucene query

Specified by:

luceneQuery in interface HSQuery

Parameters:

query - the Lucene query

Returns:

this to allow method chaining

buildTimeoutManager

protected TimeoutManagerImpl buildTimeoutManager()

Specified by:

buildTimeoutManager in class AbstractHSQuery

getFacetManager

public FacetManagerImpl getFacetManager()

Specified by:

getFacetManager in interface HSQuery

Returns:

return the manager for all faceting related operations

getLuceneQuery

public org.apache.lucene.search.Query getLuceneQuery()

Specified by:

getLuceneQuery in interface HSQuery

Returns:

the underlying Lucene query (if any)

queryEntityInfos

public List<EntityInfo> queryEntityInfos()

Description copied from interface: HSQuery

Execute the Lucene query and return the list of EntityInfos populated with metadata and projection. ProjectionConstants.THIS if projected is not populated. It is the responsibility of the object source integration.

Specified by:

queryEntityInfos in interface HSQuery

Returns:

list of EntityInfos populated with metadata and projection

queryDocumentExtractor

public DocumentExtractor queryDocumentExtractor()

DocumentExtractor returns a traverser over the full-text results (EntityInfo) This operation is lazy bound: - the query is executed - results are not retrieved until actually requested DocumentExtractor objects *must* be closed when the results are no longer traversed.

Specified by:

queryDocumentExtractor in interface HSQuery

Returns:

the DocumentExtractor instance

queryResultSize

public int queryResultSize()

Specified by:

queryResultSize in interface HSQuery

Returns:

the number of hits for this search

Caution: The number of results might be slightly different from what the object source returns if the index is not in sync with the store at the time of query.

explain

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

Description copied from interface: HSQuery

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

Specified by:

explain in interface HSQuery

Parameters:

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

Returns:

Lucene Explanation

clearCachedResults

protected void clearCachedResults()

This class caches some of the query results and we need to reset the state in case something in the query changes (eg a new filter is set).

Specified by:

clearCachedResults in class AbstractHSQuery

extractFacetResults

protected void extractFacetResults()

Specified by:

extractFacetResults in class AbstractHSQuery

getSupportedProjectionConstants

protected Set<String> getSupportedProjectionConstants()

Specified by:

getSupportedProjectionConstants in class AbstractHSQuery

Returns:

the names of the projection constants supported by a specific implementation in addition to projecting actual field values. If a given projection name begins with AbstractHSQuery.HSEARCH_PROJECTION_FIELD_PREFIX and is not part of the set of constants returned by an implementation, an exception will be raised.

getIndexManagers

protected Set<IndexManager> getIndexManagers(EntityIndexBinding binding)

Overrides:

getIndexManagers in class AbstractHSQuery

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HSQuery

Returns:

a String representation of the underlying query