org.apache.lucene.search

Class FuzzyTermEnum

public final class FuzzyTermEnum extends FilteredTermEnum

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.

Constructor Summary
	FuzzyTermEnum(IndexReader reader, Term term) Empty prefix and minSimilarity of 0.5f are used.
	FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity) This is the standard FuzzyTermEnum with an empty prefix.
	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`.

Method Summary
void	close()
protected float	difference()
boolean	endEnum()
protected boolean	termCompare(Term term) The termCompare method in FuzzyTermEnum uses Levenshtein distance to calculate the distance between the given term and the comparing term.

Constructor Detail

FuzzyTermEnum

public FuzzyTermEnum(IndexReader reader, Term term)

Empty prefix and minSimilarity of 0.5f are used.

Parameters: reader term

Throws: IOException

FuzzyTermEnum

public FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity)

This is the standard FuzzyTermEnum with an empty prefix.

Parameters: reader term minSimilarity

Throws: IOException

FuzzyTermEnum

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

Parameters: reader Delivers terms. term Pattern term. minSimilarity Minimum required similarity for terms from the reader. Default value is 0.5f. prefixLength Length of required common prefix. Default value is 0.

Throws: IOException