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)
Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f.
FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity)
Creates a 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
voidclose()
floatdifference()
booleanendEnum()
protected booleantermCompare(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)
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

See Also: FuzzyTermEnum

FuzzyTermEnum

public 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

See Also: FuzzyTermEnum

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.

After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

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

Method Detail

close

public void close()

difference

public final float difference()

endEnum

public final boolean endEnum()

termCompare

protected final boolean termCompare(Term term)
The termCompare method in FuzzyTermEnum uses Levenshtein distance to calculate the distance between the given term and the comparing term.
Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.