lucene::index::TermEnum Class Reference

#include <Terms.h>

Inheritance diagram for lucene::index::TermEnum:

Public Member Functions
virtual bool	next ()=0
virtual Term *	term ()=0
virtual Term *	term (bool pointer)
virtual int32_t	docFreq () const =0
virtual void	close ()=0
virtual	~TermEnum ()
virtual bool	skipTo (Term *target)
	Skips terms to the first beyond the current whose value is greater or equal to target.
virtual const char *	getObjectName ()=0
	Because we need to know how to cast the object, we need the objects name.

---

Constructor & Destructor Documentation

virtual lucene::index::TermEnum::~TermEnum

(

)

[virtual]

---

Member Function Documentation

virtual bool lucene::index::TermEnum::next

(

)

[pure virtual]

Implemented in lucene::search::FilteredTermEnum.

virtual Term* lucene::index::TermEnum::term

(

)

[pure virtual]

Implemented in lucene::search::FilteredTermEnum.

virtual Term* lucene::index::TermEnum::term

(

bool

pointer

)

[virtual]

Reimplemented in lucene::search::FilteredTermEnum.

virtual int32_t lucene::index::TermEnum::docFreq

(

)

const [pure virtual]

Implemented in lucene::search::FilteredTermEnum.

virtual void lucene::index::TermEnum::close

(

)

[pure virtual]

Implemented in lucene::search::FilteredTermEnum, lucene::search::FuzzyTermEnum, and lucene::search::WildcardTermEnum.

virtual bool lucene::index::TermEnum::skipTo

(

Term *

target

)

[virtual]

Skips terms to the first beyond the current whose value is greater or equal to target.

Returns true iff there is such an entry.

Behaves as if written:

   public boolean skipTo(Term target) {
     do {
       if (!next())
 	     return false;
     } while (target > term());
     return true;
   }
 

Some implementations are considerably more efficient than that.

virtual const char* lucene::index::TermEnum::getObjectName

(

)

[pure virtual]

Because we need to know how to cast the object, we need the objects name.

Implemented in lucene::search::FuzzyTermEnum, and lucene::search::WildcardTermEnum.

---

The documentation for this class was generated from the following file:

• Terms.h