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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
DocIdSetIterator.h
Go to the documentation of this file.
1 // 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 DOCIDSETITERATOR_H
8 #define DOCIDSETITERATOR_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
17 class LPPAPI DocIdSetIterator : public LuceneObject {
18 public:
19  virtual ~DocIdSetIterator();
20 
22 
23 public:
26  static const int32_t NO_MORE_DOCS;
27 
28 public:
35  virtual int32_t docID() = 0;
36 
42  virtual int32_t nextDoc() = 0;
43 
70  virtual int32_t advance(int32_t target) = 0;
71 };
72 
73 }
74 
75 #endif
This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore NO_MORE_DOCS is set to { NO_MORE_DOCS} in order to be used as a sentinel object. Implementations of this class are expected to consider INT_MAX as an invalid value.
Definition: DocIdSetIterator.h:17
Base class for all Lucene classes.
Definition: LuceneObject.h:31
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Definition: AbstractAllTermDocs.h:12

clucene.sourceforge.net