7#ifndef TOPDOCSCOLLECTOR_H
8#define TOPDOCSCOLLECTOR_H
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Utility template class to handle collections that can be safely copied and shared.
Definition Collection.h:17
Collectors are primarily meant to be used to gather raw results from a search, and implement sorting ...
Definition Collector.h:100
A base class for all collectors that return a TopDocs output. This collector allows easy extension by...
Definition TopDocsCollector.h:21
HitQueueBasePtr pq
The priority queue which holds the top documents. Note that different implementations of PriorityQueu...
Definition TopDocsCollector.h:32
static TopDocsPtr EMPTY_TOPDOCS()
This is used in case topDocs() is called with illegal parameters, or there simply aren't (enough) res...
int32_t totalHits
The total number of documents that the collector encountered.
Definition TopDocsCollector.h:35
TopDocsCollector(const HitQueueBasePtr &pq)
virtual ~TopDocsCollector()
virtual TopDocsPtr topDocs(int32_t start, int32_t howMany)
Returns the documents in the rage [start .. start + howMany) that were collected by this collector....
virtual void populateResults(Collection< ScoreDocPtr > results, int32_t howMany)
Populates the results array with the ScoreDoc instances. This can be overridden in case a different S...
virtual int32_t getTotalHits()
The total number of documents that matched this query.
virtual TopDocsPtr newTopDocs(Collection< ScoreDocPtr > results, int32_t start)
Returns a TopDocs instance containing the given results. If results is null it means there are no res...
virtual TopDocsPtr topDocs(int32_t start)
Returns the documents in the range [start .. pq.size()) that were collected by this collector....
virtual TopDocsPtr topDocs()
Returns the top docs that were collected by this collector.
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< TopDocs > TopDocsPtr
Definition LuceneTypes.h:471
boost::shared_ptr< HitQueueBase > HitQueueBasePtr
Definition LuceneTypes.h:371