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


TermDocs.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 TERMDOCS_H
8 #define TERMDOCS_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
19 class LPPAPI TermDocs {
20 protected:
21  TermDocs();
22 
23 public:
25 
26 public:
28  virtual void seek(const TermPtr& term) = 0;
29 
32  virtual void seek(const TermEnumPtr& termEnum) = 0;
33 
35  virtual int32_t doc() = 0;
36 
39  virtual int32_t freq() = 0;
40 
42  virtual bool next() = 0;
43 
47  virtual int32_t read(Collection<int32_t> docs, Collection<int32_t> freqs) = 0;
48 
51  virtual bool skipTo(int32_t target) = 0;
52 
54  virtual void close() = 0;
55 };
56 
57 }
58 
59 #endif
Lucene::TermPtr
boost::shared_ptr< Term > TermPtr
Definition: LuceneTypes.h:233
Lucene::Collection< int32_t >
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::TermEnumPtr
boost::shared_ptr< TermEnum > TermEnumPtr
Definition: LuceneTypes.h:235
LUCENE_INTERFACE
#define LUCENE_INTERFACE(Name)
Definition: LuceneObject.h:19
Lucene::TermDocs
TermDocs provides an interface for enumerating <document, frequency>; pairs for a term....
Definition: TermDocs.h:19
LuceneObject.h

clucene.sourceforge.net