Lucene.Net.Search.FilteredTermEnum Class Reference

Abstract class for enumerating a subset of all terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. More...

Inherits TermEnum.

Inherited by Contrib.Regex.RegexTermEnum, Lucene.Net.Search.FuzzyTermEnum, Lucene.Net.Search.PrefixTermEnum, Lucene.Net.Search.SingleTermEnum, Lucene.Net.Search.TermRangeTermEnum, and Lucene.Net.Search.WildcardTermEnum.

Public Member Functions
abstract float	Difference ()
	Equality measure on the term
abstract bool	EndEnum ()
	Indicates the end of the enumeration has been reached
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.

Protected Member Functions
	FilteredTermEnum ()
override void	Dispose (bool disposing)

Properties
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

Abstract class for enumerating a subset of all terms.

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

Definition at line 30 of file FilteredTermEnum.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.FilteredTermEnum.FilteredTermEnum ( )

protected

Definition at line 38 of file FilteredTermEnum.cs.

Member Function Documentation

abstract float Lucene.Net.Search.FilteredTermEnum.Difference ( )

pure virtual

Equality measure on the term

Implemented in Lucene.Net.Search.FuzzyTermEnum, Lucene.Net.Search.TermRangeTermEnum, Lucene.Net.Search.WildcardTermEnum, Contrib.Regex.RegexTermEnum, Lucene.Net.Search.SingleTermEnum, and Lucene.Net.Search.PrefixTermEnum.

override void Lucene.Net.Search.FilteredTermEnum.Dispose ( bool  disposing )

protected

Definition at line 112 of file FilteredTermEnum.cs.

override int Lucene.Net.Search.FilteredTermEnum.DocFreq

(

)

Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.

Definition at line 70 of file FilteredTermEnum.cs.

abstract bool Lucene.Net.Search.FilteredTermEnum.EndEnum ( )

pure virtual

Indicates the end of the enumeration has been reached

Implemented in Lucene.Net.Search.FuzzyTermEnum, Lucene.Net.Search.TermRangeTermEnum, Lucene.Net.Search.WildcardTermEnum, Contrib.Regex.RegexTermEnum, Lucene.Net.Search.SingleTermEnum, and Lucene.Net.Search.PrefixTermEnum.

override bool Lucene.Net.Search.FilteredTermEnum.Next

(

)

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

Definition at line 79 of file FilteredTermEnum.cs.

Property Documentation

override Term Lucene.Net.Search.FilteredTermEnum.Term

get

Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.

Definition at line 108 of file FilteredTermEnum.cs.

---

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

• core/Search/FilteredTermEnum.cs