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


TermEnum.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 TERMENUM_H
8 #define TERMENUM_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
18 class LPPAPI TermEnum : public LuceneObject {
19 public:
20  virtual ~TermEnum();
22 
23 public:
25  virtual bool next() = 0;
26 
28  virtual TermPtr term() = 0;
29 
31  virtual int32_t docFreq() = 0;
32 
34  virtual void close() = 0;
35 };
36 
37 }
38 
39 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Abstract class for enumerating terms.
Definition: TermEnum.h:18
virtual void close()=0
Closes the enumeration to further activity, freeing resources.
virtual TermPtr term()=0
Returns the current Term in the enumeration.
virtual bool next()=0
Increments the enumeration to the next element. True if one exists.
virtual int32_t docFreq()=0
Returns the docFreq of the current Term in the enumeration.
virtual ~TermEnum()
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< Term > TermPtr
Definition: LuceneTypes.h:233

clucene.sourceforge.net