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


TermPositions.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 TERMPOSITIONS_H
8 #define TERMPOSITIONS_H
9 
10 #include "TermDocs.h"
11 
12 namespace Lucene {
13 
18 class LPPAPI TermPositions : public TermDocs {
19 protected:
20  TermPositions();
21 
22 public:
23  virtual ~TermPositions();
25 
26 public:
29  // the first time.
30  virtual int32_t nextPosition();
31 
35  virtual int32_t getPayloadLength();
36 
45  virtual ByteArray getPayload(ByteArray data, int32_t offset);
46 
50  virtual bool isPayloadAvailable();
51 };
52 
53 }
54 
55 #endif
#define LUCENE_INTERFACE(Name)
Definition: LuceneObject.h:19
TermPositions provides an interface for enumerating the <document, frequency, <position>*> tuples for...
Definition: TermPositions.h:18
Definition: AbstractAllTermDocs.h:12
TermDocs provides an interface for enumerating <document, frequency>; pairs for a term...
Definition: TermDocs.h:19

clucene.sourceforge.net