Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Collector.h
Go to the documentation of this file.
1
2// Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3// Distributable under the terms of either the Apache License (Version 2.0)
4// or the GNU Lesser General Public License.
6
7#ifndef COLLECTOR_H
8#define COLLECTOR_H
9
10#include "LuceneObject.h"
11
12namespace Lucene {
13
100class LPPAPI Collector : public LuceneObject {
101public:
102 virtual ~Collector();
104
105public:
109 virtual void setScorer(const ScorerPtr& scorer) = 0;
110
116 virtual void collect(int32_t doc) = 0;
117
123 virtual void setNextReader(const IndexReaderPtr& reader, int32_t docBase) = 0;
124
133 virtual bool acceptsDocsOutOfOrder() = 0;
134};
135
136}
137
138#endif
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Collectors are primarily meant to be used to gather raw results from a search, and implement sorting ...
Definition Collector.h:100
virtual bool acceptsDocsOutOfOrder()=0
Return true if this collector does not require the matching docIDs to be delivered in int sort order ...
virtual ~Collector()
virtual void setNextReader(const IndexReaderPtr &reader, int32_t docBase)=0
Called before collecting from each IndexReader. All doc ids in collect(int32_t) will correspond to re...
virtual void setScorer(const ScorerPtr &scorer)=0
Called before successive calls to collect(int32_t). Implementations that need the score of the curren...
virtual void collect(int32_t doc)=0
Called once for every document matching a query, with the unbased document number.
Base class for all Lucene classes.
Definition LuceneObject.h:31
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition LuceneTypes.h:157
boost::shared_ptr< Scorer > ScorerPtr
Definition LuceneTypes.h:429

clucene.sourceforge.net