Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Search.TermRangeTermEnum Class Reference

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

Inherits Lucene.Net.Search.FilteredTermEnum.

Public Member Functions

 TermRangeTermEnum (IndexReader reader, System.String field, System.String lowerTermText, System.String upperTermText, bool includeLower, bool includeUpper, System.Globalization.CompareInfo collator)
 Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm.
 
override float Difference ()
 Equality measure on the term
 
override bool EndEnum ()
 Indicates the end of the enumeration has been reached
 
- Public Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
override int DocFreq ()
 Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.
 
override bool Next ()
 Increments the enumeration to the next element. True if one exists.
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
 FilteredTermEnum ()
 
override void Dispose (bool disposing)
 
- Properties inherited from Lucene.Net.Search.FilteredTermEnum
override Term Term [get]
 Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.
 

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.

<since> 2.9 </since>

Definition at line 35 of file TermRangeTermEnum.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.TermRangeTermEnum.TermRangeTermEnum ( IndexReader  reader,
System.String  field,
System.String  lowerTermText,
System.String  upperTermText,
bool  includeLower,
bool  includeUpper,
System.Globalization.CompareInfo  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.

<throws> IOException </throws>

Definition at line 73 of file TermRangeTermEnum.cs.

Member Function Documentation

override float Lucene.Net.Search.TermRangeTermEnum.Difference ( )
virtual

Equality measure on the term

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 99 of file TermRangeTermEnum.cs.

override bool Lucene.Net.Search.TermRangeTermEnum.EndEnum ( )
virtual

Indicates the end of the enumeration has been reached

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 104 of file TermRangeTermEnum.cs.


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