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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Lucene::TermRangeTermEnum Class Reference

Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters. More...

#include <TermRangeTermEnum.h>

+ Inheritance diagram for Lucene::TermRangeTermEnum:

Public Member Functions

 TermRangeTermEnum (const IndexReaderPtr &reader, const String &field, StringValue lowerTermText, StringValue upperTermText, bool includeLower, bool includeUpper, const CollatorPtr &collator)
 Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm.
 
virtual ~TermRangeTermEnum ()
 
virtual String getClassName ()
 
boost::shared_ptr< TermRangeTermEnumshared_from_this ()
 
virtual double difference ()
 Equality measure on the term.
 
- Public Member Functions inherited from Lucene::FilteredTermEnum
virtual ~FilteredTermEnum ()
 
boost::shared_ptr< FilteredTermEnumshared_from_this ()
 
virtual int32_t docFreq ()
 Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.
 
virtual bool next ()
 Increments the enumeration to the next element. True if one exists.
 
virtual TermPtr term ()
 Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.
 
virtual void close ()
 Closes the enumeration to further activity, freeing resources.
 
- Public Member Functions inherited from Lucene::TermEnum
virtual ~TermEnum ()
 
boost::shared_ptr< TermEnumshared_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.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

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

Protected Member Functions

virtual bool endEnum ()
 Indicates the end of the enumeration has been reached.
 
virtual bool termCompare (const TermPtr &term)
 Equality compare on the term.
 
- Protected Member Functions inherited from Lucene::FilteredTermEnum
virtual void setEnum (const TermEnumPtr &actualEnum)
 Use this method to set the actual TermEnum (eg. in ctor), it will be automatically positioned on the first matching term.
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Protected Attributes

CollatorPtr collator
 
bool _endEnum
 
String field
 
StringValue upperTermText
 
StringValue lowerTermText
 
bool includeLower
 
bool includeUpper
 
- Protected Attributes inherited from Lucene::FilteredTermEnum
TermPtr currentTerm
 The current term.
 
TermEnumPtr actualEnum
 The delegate enum - to set this member use setEnum.
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters.

Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.

Constructor & Destructor Documentation

◆ TermRangeTermEnum()

Lucene::TermRangeTermEnum::TermRangeTermEnum ( const IndexReaderPtr reader,
const String &  field,
StringValue  lowerTermText,
StringValue  upperTermText,
bool  includeLower,
bool  includeUpper,
const CollatorPtr collator 
)

Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm.

If an endpoint is null, it is said to be "open". Either or both endpoints may be open. Open endpoints may not be exclusive (you can't select all but the first or last term without explicitly specifying the term to exclude.)

Parameters
reader
fieldAn interned field that holds both lower and upper terms.
lowerTermTextThe term text at the lower end of the range
upperTermTextThe term text at the upper end of the range
includeLowerIf true, the lowerTerm is included in the range.
includeUpperIf true, the upperTerm is included in the range.
collatorThe collator to use to collate index Terms, to determine their membership in the range bounded by lowerTerm and upperTerm.

◆ ~TermRangeTermEnum()

virtual Lucene::TermRangeTermEnum::~TermRangeTermEnum ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::TermRangeTermEnum::_getClassName ( )
inlinestatic

◆ difference()

virtual double Lucene::TermRangeTermEnum::difference ( )
virtual

Equality measure on the term.

Implements Lucene::FilteredTermEnum.

◆ endEnum()

virtual bool Lucene::TermRangeTermEnum::endEnum ( )
protectedvirtual

Indicates the end of the enumeration has been reached.

Implements Lucene::FilteredTermEnum.

◆ getClassName()

virtual String Lucene::TermRangeTermEnum::getClassName ( )
inlinevirtual

Reimplemented from Lucene::FilteredTermEnum.

◆ shared_from_this()

boost::shared_ptr< TermRangeTermEnum > Lucene::TermRangeTermEnum::shared_from_this ( )
inline

◆ termCompare()

virtual bool Lucene::TermRangeTermEnum::termCompare ( const TermPtr term)
protectedvirtual

Equality compare on the term.

Implements Lucene::FilteredTermEnum.

Field Documentation

◆ _endEnum

bool Lucene::TermRangeTermEnum::_endEnum
protected

◆ collator

CollatorPtr Lucene::TermRangeTermEnum::collator
protected

◆ field

String Lucene::TermRangeTermEnum::field
protected

◆ includeLower

bool Lucene::TermRangeTermEnum::includeLower
protected

◆ includeUpper

bool Lucene::TermRangeTermEnum::includeUpper
protected

◆ lowerTermText

StringValue Lucene::TermRangeTermEnum::lowerTermText
protected

◆ upperTermText

StringValue Lucene::TermRangeTermEnum::upperTermText
protected

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

clucene.sourceforge.net