Lucene::FilterTermEnum Class Reference

Base class for filtering TermEnum implementations. More...

#include <FilterIndexReader.h>

Inheritance diagram for Lucene::FilterTermEnum:

Public Member Functions
	FilterTermEnum (TermEnumPtr in)
virtual	~FilterTermEnum ()
virtual String	getClassName ()
boost::shared_ptr< FilterTermEnum >	shared_from_this ()
virtual bool	next ()
	Increments the enumeration to the next element. True if one exists. More...
virtual TermPtr	term ()
	Returns the current Term in the enumeration. More...
virtual int32_t	docFreq ()
	Returns the docFreq of the current Term in the enumeration. More...
virtual void	close ()
	Closes the enumeration to further activity, freeing resources. More...
Public Member Functions inherited from Lucene::TermEnum
virtual	~TermEnum ()
boost::shared_ptr< TermEnum >	shared_from_this ()
Public Member Functions inherited from Lucene::LuceneObject
virtual	~LuceneObject ()
virtual void	initialize ()
	Called directly after instantiation to create objects that depend on this object being fully constructed. More...
virtual LuceneObjectPtr	clone (LuceneObjectPtr other=LuceneObjectPtr())
	Return clone of this object. More...
virtual int32_t	hashCode ()
	Return hash code for this object. More...
virtual bool	equals (LuceneObjectPtr other)
	Return whether two objects are equal. More...
virtual int32_t	compareTo (LuceneObjectPtr other)
	Compare two objects. More...
virtual String	toString ()
	Returns a string representation of the object. More...
Public Member Functions inherited from Lucene::LuceneSync
virtual	~LuceneSync ()
virtual SynchronizePtr	getSync ()
	Return this object synchronize lock. More...
virtual LuceneSignalPtr	getSignal ()
	Return this object signal. More...
virtual void	lock (int32_t timeout=0)
	Lock this object using an optional timeout. More...
virtual void	unlock ()
	Unlock this object. More...
virtual bool	holdsLock ()
	Returns true if this object is currently locked by current thread. More...
virtual void	wait (int32_t timeout=0)
	Wait for signal using an optional timeout. More...
virtual void	notifyAll ()
	Notify all threads waiting for signal. More...

Static Public Member Functions
static String	_getClassName ()
Static Public Member Functions inherited from Lucene::TermEnum
static String	_getClassName ()

Protected Attributes
TermEnumPtr	in

Additional Inherited Members
Protected Member Functions inherited from Lucene::LuceneObject
	LuceneObject ()

Detailed Description

Base class for filtering TermEnum implementations.

Constructor & Destructor Documentation

Lucene::FilterTermEnum::FilterTermEnum

(

TermEnumPtr

in)

virtual Lucene::FilterTermEnum::~FilterTermEnum ( )

virtual

Member Function Documentation

static String Lucene::FilterTermEnum::_getClassName ( )

inlinestatic

virtual void Lucene::FilterTermEnum::close ( )

virtual

Closes the enumeration to further activity, freeing resources.

Implements Lucene::TermEnum.

virtual int32_t Lucene::FilterTermEnum::docFreq ( )

virtual

Returns the docFreq of the current Term in the enumeration.

Implements Lucene::TermEnum.

virtual String Lucene::FilterTermEnum::getClassName ( )

inlinevirtual

Reimplemented from Lucene::TermEnum.

virtual bool Lucene::FilterTermEnum::next ( )

virtual

Increments the enumeration to the next element. True if one exists.

Implements Lucene::TermEnum.

boost::shared_ptr< FilterTermEnum > Lucene::FilterTermEnum::shared_from_this ( )

inline

virtual TermPtr Lucene::FilterTermEnum::term ( )

virtual

Returns the current Term in the enumeration.

Implements Lucene::TermEnum.

Field Documentation

TermEnumPtr Lucene::FilterTermEnum::in

protected

---

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

• FilterIndexReader.h