Class TermRangeTermsEnum

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

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

Inheritance
object
TermsEnum
FilteredTermsEnum
TermRangeTermsEnum
Implements
Inherited Members
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class TermRangeTermsEnum : FilteredTermsEnum, IBytesRefEnumerator

Constructors

TermRangeTermsEnum(TermsEnum, BytesRef, BytesRef, bool, bool)

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.)

Declaration
public TermRangeTermsEnum(TermsEnum tenum, BytesRef lowerTerm, BytesRef upperTerm, bool includeLower, bool includeUpper)
Parameters
Type Name Description
TermsEnum tenum

TermsEnum to filter
BytesRef lowerTerm

The term text at the lower end of the range
BytesRef upperTerm

The term text at the upper end of the range
bool includeLower

If true, the lowerTerm is included in the range.
bool includeUpper

If true, the upperTerm is included in the range.

Methods

Accept(BytesRef)

Return if term is accepted, not accepted or the iteration should ended (and possibly seek).

Declaration
protected override FilteredTermsEnum.AcceptStatus Accept(BytesRef term)
Parameters
Type Name Description
BytesRef term
Returns
Type Description
FilteredTermsEnum.AcceptStatus
Overrides

Implements