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


Loading...
Searching...
No Matches
AbstractAllTermDocs.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 ABSTRACTALLTERMDOCS_H
8#define ABSTRACTALLTERMDOCS_H
9
10#include "TermDocs.h"
11
12namespace Lucene {
13
18class LPPAPI AbstractAllTermDocs : public TermDocs, public LuceneObject {
19public:
20 AbstractAllTermDocs(int32_t maxDoc);
22
24
25protected:
26 int32_t maxDoc;
27 int32_t _doc;
28
29public:
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
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Base class for enumerating all but deleted docs.
Definition AbstractAllTermDocs.h:18
virtual bool isDeleted(int32_t doc)=0
virtual int32_t doc()
Returns the current document number. This is invalid until next() is called for the first time.
virtual void close()
Frees associated resources.
virtual bool skipTo(int32_t target)
Skips entries to the first beyond the current whose document number is greater than or equal to targe...
virtual bool next()
Moves to the next pair in the enumeration. Returns true if there is such a next pair in the enumerati...
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...
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...
virtual int32_t freq()
Returns the frequency of the term within the current document. This is invalid until next() is called...
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.
int32_t maxDoc
Definition AbstractAllTermDocs.h:26
int32_t _doc
Definition AbstractAllTermDocs.h:27
AbstractAllTermDocs(int32_t maxDoc)
Utility template class to handle collections that can be safely copied and shared.
Definition Collection.h:17
Base class for all Lucene classes.
Definition LuceneObject.h:31
TermDocs provides an interface for enumerating <document, frequency>; pairs for a term....
Definition TermDocs.h:19
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< Term > TermPtr
Definition LuceneTypes.h:233
boost::shared_ptr< TermEnum > TermEnumPtr
Definition LuceneTypes.h:235

clucene.sourceforge.net