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 | Protected Member Functions | List of all members
Lucene.Net.Search.FuzzyTermEnum Class Reference

Subclass of FilteredTermEnum for enumerating all terms that are similiar to the specified filter term. More...

Inherits Lucene.Net.Search.FilteredTermEnum.

Public Member Functions

 FuzzyTermEnum (IndexReader reader, Term term)
 Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.
 
 FuzzyTermEnum (IndexReader reader, Term term, float minSimilarity)
 Creates a FuzzyTermEnum with an empty prefix. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.
 
 FuzzyTermEnum (IndexReader reader, Term term, float minSimilarity, int prefixLength)
 Constructor for enumeration of all terms from specified reader which share a prefix of length prefixLength with term and which have a fuzzy similarity > minSimilarity. After calling the constructor the enumeration is already pointing to the first valid term if such a term 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.
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
 FilteredTermEnum ()
 
override void Dispose (bool disposing)
 

Additional Inherited Members

- 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 are similiar to the specified filter term.

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

Definition at line 32 of file FuzzyTermEnum.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.FuzzyTermEnum.FuzzyTermEnum ( IndexReader  reader,
Term  term 
)

Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Parameters
reader
term

<throws> IOException </throws>

See Also
FuzzyTermEnum(IndexReader, Term, float, int)

Definition at line 66 of file FuzzyTermEnum.cs.

Lucene.Net.Search.FuzzyTermEnum.FuzzyTermEnum ( IndexReader  reader,
Term  term,
float  minSimilarity 
)

Creates a FuzzyTermEnum with an empty prefix. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Parameters
reader
term
minSimilarity

<throws> IOException </throws>

See Also
FuzzyTermEnum(IndexReader, Term, float, int)

Definition at line 85 of file FuzzyTermEnum.cs.

Lucene.Net.Search.FuzzyTermEnum.FuzzyTermEnum ( IndexReader  reader,
Term  term,
float  minSimilarity,
int  prefixLength 
)

Constructor for enumeration of all terms from specified reader which share a prefix of length prefixLength with term and which have a fuzzy similarity > minSimilarity. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Parameters
readerDelivers terms.
termPattern term.
minSimilarityMinimum required similarity for terms from the reader. Default value is 0.5f.
prefixLengthLength of required common prefix. Default value is 0.

<throws> IOException </throws>

Definition at line 106 of file FuzzyTermEnum.cs.

Member Function Documentation

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

Equality measure on the term

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 150 of file FuzzyTermEnum.cs.

override void Lucene.Net.Search.FuzzyTermEnum.Dispose ( bool  disposing)
protected

Definition at line 303 of file FuzzyTermEnum.cs.

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

Indicates the end of the enumeration has been reached

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 155 of file FuzzyTermEnum.cs.


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