org.hibernate.search.query.engine.impl

Class QueryHits

java.lang.Object

org.hibernate.search.query.engine.impl.QueryHits

public class QueryHits
extends Object

A helper class which gives access to the current query and its hits. This class will dynamically reload the underlying TopDocs if required.

Author:

Hardy Ferentschik, Sanne Grinovero (C) 2011 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
QueryHits(IndexSearcherWithPayload searcher, Query preparedQuery, Filter filter, Sort sort, Integer n, TimeoutManagerImpl timeoutManager, Map<String,FacetingRequestImpl> facetRequests, boolean enableFieldCacheOnTypes, FieldCacheCollectorFactory idFieldCollector, TimeoutExceptionFactory timeoutExceptionFactory, Coordinates spatialSearchCenter, String spatialFieldName)
QueryHits(IndexSearcherWithPayload searcher, Query preparedQuery, Filter filter, Sort sort, TimeoutManagerImpl timeoutManager, Map<String,FacetingRequestImpl> facetRequests, boolean enableFieldCacheOnTypes, FieldCacheCollectorFactory idFieldCollector, TimeoutExceptionFactory timeoutExceptionFactory, Coordinates spatialSearchCenter, String spatialFieldName)

Method Summary

Methods

Modifier and Type	Method and Description
Document	doc(int index)
Document	doc(int index, FieldSelector selector)
int	docId(int index)
Explanation	explain(int index)
FieldCacheCollector	getClassTypeCollector()
Map<String,List<Facet>>	getFacets()
FieldCacheCollector	getIdsCollector()
TopDocs	getTopDocs()
int	getTotalHits()
float	score(int index)
ScoreDoc	scoreDoc(int index)
Double	spatialDistance(int index)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryHits

public QueryHits(IndexSearcherWithPayload searcher,
         Query preparedQuery,
         Filter filter,
         Sort sort,
         TimeoutManagerImpl timeoutManager,
         Map<String,FacetingRequestImpl> facetRequests,
         boolean enableFieldCacheOnTypes,
         FieldCacheCollectorFactory idFieldCollector,
         TimeoutExceptionFactory timeoutExceptionFactory,
         Coordinates spatialSearchCenter,
         String spatialFieldName)
          throws IOException

Throws:

IOException

QueryHits

public QueryHits(IndexSearcherWithPayload searcher,
         Query preparedQuery,
         Filter filter,
         Sort sort,
         Integer n,
         TimeoutManagerImpl timeoutManager,
         Map<String,FacetingRequestImpl> facetRequests,
         boolean enableFieldCacheOnTypes,
         FieldCacheCollectorFactory idFieldCollector,
         TimeoutExceptionFactory timeoutExceptionFactory,
         Coordinates spatialSearchCenter,
         String spatialFieldName)
          throws IOException

Throws:

IOException

Method Detail

doc

public Document doc(int index)
             throws IOException

Throws:

IOException

doc

public Document doc(int index,
           FieldSelector selector)
             throws IOException

Throws:

IOException

scoreDoc

public ScoreDoc scoreDoc(int index)
                  throws IOException

Throws:

IOException

docId

public int docId(int index)
          throws IOException

Throws:

IOException

score

public float score(int index)
            throws IOException

Throws:

IOException

spatialDistance

public Double spatialDistance(int index)
                       throws IOException

Throws:

IOException

explain

public Explanation explain(int index)
                    throws IOException

Throws:

IOException

getTotalHits

public int getTotalHits()

getTopDocs

public TopDocs getTopDocs()

getFacets

public Map<String,List<Facet>> getFacets()

getClassTypeCollector

public FieldCacheCollector getClassTypeCollector()

getIdsCollector

public FieldCacheCollector getIdsCollector()