Subclass of FilteredTermEnum for enumerating a single term. This can be used by MultiTermQuerys that need only visit one term, but want to preserve MultiTermQuery semantics such as RewriteMethod. More...

Public Member Functions
	SingleTermEnum (IndexReader reader, Term singleTerm)
	Creates a new `SingleTermEnum`. After calling the constructor the enumeration is already pointing to the term, if it exists.

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 a single term.

This can be used by MultiTermQuerys that need only visit one term, but want to preserve MultiTermQuery semantics such as RewriteMethod.

Definition at line 30 of file SingleTermEnum.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.SingleTermEnum.SingleTermEnum	(	IndexReader	reader,
		Term	singleTerm
	)

Creates a new SingleTermEnum. After calling the constructor the enumeration is already pointing to the term, if it exists.

Definition at line 41 of file SingleTermEnum.cs.

override float Lucene.Net.Search.SingleTermEnum.Difference ( )

virtual

Equality measure on the term

Definition at line 47 of file SingleTermEnum.cs.

override bool Lucene.Net.Search.SingleTermEnum.EndEnum ( )

virtual

Indicates the end of the enumeration has been reached

Definition at line 52 of file SingleTermEnum.cs.

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