Package org.apache.lucene.search.spell
Class JaroWinklerDistance
java.lang.Object
org.apache.lucene.search.spell.JaroWinklerDistance
- All Implemented Interfaces:
StringDistance
Similarity measure for short strings such as person names.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new distance metric with the default threshold for the Jaro Winkler bonus (0.7) -
Method Summary
Modifier and TypeMethodDescriptionboolean
float
getDistance
(String s1, String s2) Returns a float between 0 and 1 based on how similar the specified strings are to one another.float
Returns the current value of the threshold used for adding the Winkler bonus.int
hashCode()
private int[]
void
setThreshold
(float threshold) Sets the threshold used to determine when Winkler bonus should be used.toString()
-
Field Details
-
threshold
private float threshold
-
-
Constructor Details
-
JaroWinklerDistance
public JaroWinklerDistance()Creates a new distance metric with the default threshold for the Jaro Winkler bonus (0.7)- See Also:
-
-
Method Details
-
matches
-
getDistance
Description copied from interface:StringDistance
Returns a float between 0 and 1 based on how similar the specified strings are to one another. Returning a value of 1 means the specified strings are identical and 0 means the string are maximally different.- Specified by:
getDistance
in interfaceStringDistance
- Parameters:
s1
- The first string.s2
- The second string.- Returns:
- a float between 0 and 1 based on how similar the specified strings are to one another.
-
setThreshold
public void setThreshold(float threshold) Sets the threshold used to determine when Winkler bonus should be used. Set to a negative value to get the Jaro distance.- Parameters:
threshold
- the new value of the threshold
-
getThreshold
public float getThreshold()Returns the current value of the threshold used for adding the Winkler bonus. The default value is 0.7.- Returns:
- the current value of the threshold
-
hashCode
public int hashCode() -
equals
-
toString
-