info.debatty.java.stringsimilarity

Class JaroWinkler

java.lang.Object

info.debatty.java.stringsimilarity.JaroWinkler

All Implemented Interfaces:

NormalizedStringDistance, NormalizedStringSimilarity, StringDistance, StringSimilarity, Serializable

public class JaroWinkler
extends Object
implements NormalizedStringSimilarity, NormalizedStringDistance

The Jaro–Winkler distance metric is designed and best suited for short strings such as person names, and to detect typos; it is (roughly) a variation of Damerau-Levenshtein, where the substitution of 2 close characters is considered less important then the substitution of 2 characters that a far from each other. Jaro-Winkler was developed in the area of record linkage (duplicate detection) (Winkler, 1990). It returns a value in the interval [0.0, 1.0]. The distance is computed as 1 - Jaro-Winkler similarity.

Author:

Thibault Debatty

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JaroWinkler()
JaroWinkler(double threshold)

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(String s1, String s2)
double	getThreshold() Returns the current value of the threshold used for adding the Winkler bonus.
void	setThreshold(double threshold) Sets the threshold used to determine when Winkler bonus should be used.
double	similarity(String s1, String s2) Compute and return a measure of similarity between 2 strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JaroWinkler

public JaroWinkler()

JaroWinkler

public JaroWinkler(double threshold)

Method Detail

setThreshold

public final void setThreshold(double threshold)

Sets the threshold used to determine when Winkler bonus should be used. Set to a negative value to get the Jaro distance. Default value is 0.7

Parameters:

threshold - the new value of the threshold

getThreshold

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

similarity

public double similarity(String s1,
                String s2)

Description copied from interface: StringSimilarity

Compute and return a measure of similarity between 2 strings.

Specified by:

similarity in interface StringSimilarity

Returns:

similarity (0 means both strings are completely different)

distance

public double distance(String s1,
              String s2)

Specified by:

distance in interface StringDistance