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


AbstractAllTermDocs.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 ABSTRACTALLTERMDOCS_H
8 #define ABSTRACTALLTERMDOCS_H
9 
10 #include "TermDocs.h"
11 
12 namespace Lucene {
13 
18 class LPPAPI AbstractAllTermDocs : public TermDocs, public LuceneObject {
19 public:
20  AbstractAllTermDocs(int32_t maxDoc);
22 
24 
25 protected:
26  int32_t maxDoc;
27  int32_t _doc;
28 
29 public:
30  virtual void seek(const TermPtr& term);
31  virtual void seek(const TermEnumPtr& termEnum);
32  virtual int32_t doc();
33  virtual int32_t freq();
34  virtual bool next();
35  virtual int32_t read(Collection<int32_t> docs, Collection<int32_t> freqs);
36  virtual bool skipTo(int32_t target);
37  virtual void close();
38  virtual bool isDeleted(int32_t doc) = 0;
39 };
40 
41 }
42 
43 #endif
Lucene::AbstractAllTermDocs::seek
virtual void seek(const TermEnumPtr &termEnum)
Sets this to the data for the current term in a TermEnum. This may be optimized in some implementatio...
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene::TermPtr
boost::shared_ptr< Term > TermPtr
Definition: LuceneTypes.h:233
Lucene::Collection< int32_t >
Lucene::AbstractAllTermDocs::~AbstractAllTermDocs
virtual ~AbstractAllTermDocs()
Lucene::AbstractAllTermDocs::isDeleted
virtual bool isDeleted(int32_t doc)=0
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::AbstractAllTermDocs::next
virtual bool next()
Moves to the next pair in the enumeration. Returns true if there is such a next pair in the enumerati...
Lucene::TermEnumPtr
boost::shared_ptr< TermEnum > TermEnumPtr
Definition: LuceneTypes.h:235
Lucene::AbstractAllTermDocs::freq
virtual int32_t freq()
Returns the frequency of the term within the current document. This is invalid until next() is called...
Lucene::AbstractAllTermDocs::maxDoc
int32_t maxDoc
Definition: AbstractAllTermDocs.h:23
Lucene::AbstractAllTermDocs
Base class for enumerating all but deleted docs.
Definition: AbstractAllTermDocs.h:18
Lucene::AbstractAllTermDocs::read
virtual int32_t read(Collection< int32_t > docs, Collection< int32_t > freqs)
Attempts to read multiple entries from the enumeration, up to length of docs. Document numbers are st...
Lucene::AbstractAllTermDocs::skipTo
virtual bool skipTo(int32_t target)
Skips entries to the first beyond the current whose document number is greater than or equal to targe...
Lucene::AbstractAllTermDocs::seek
virtual void seek(const TermPtr &term)
Sets this to the data for a term. The enumeration is reset to the start of the data for this term.
Lucene::AbstractAllTermDocs::_doc
int32_t _doc
Definition: AbstractAllTermDocs.h:27
TermDocs.h
Lucene::AbstractAllTermDocs::doc
virtual int32_t doc()
Returns the current document number. This is invalid until next() is called for the first time.
Lucene::AbstractAllTermDocs::AbstractAllTermDocs
AbstractAllTermDocs(int32_t maxDoc)
Lucene::AbstractAllTermDocs::close
virtual void close()
Frees associated resources.
Lucene::TermDocs
TermDocs provides an interface for enumerating <document, frequency>; pairs for a term....
Definition: TermDocs.h:19

clucene.sourceforge.net