org.simmetrics.metrics

Class Jaro

java.lang.Object

org.simmetrics.metrics.Jaro

All Implemented Interfaces:

Metric<String>, StringMetric

public class Jaro
extends Object
implements StringMetric

Jaro algorithm providing a similarity measure between two strings.

This class is immutable and thread-safe.

See Also:

Wikipedia - Jaro-Winkler distance, JaroWinkler

Constructor Summary

Constructors

Constructor and Description
Jaro()

Method Summary

Modifier and Type	Method and Description
float	compare(String a, String b) Measures the similarity between strings a and b.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Jaro

public Jaro()

Method Detail

compare

public float compare(String a,
                     String b)

Description copied from interface: StringMetric

Measures the similarity between strings a and b. The measurement results in a value between 0 and 1 (inclusive). A value of zero indicates that the strings are dissimilar, a value of 1 indicates they are similar.

Specified by:

compare in interface Metric<String>

Specified by:

compare in interface StringMetric

Parameters:

a - string a to compare

b - string b to compare

Returns:

a value between 0 and 1 inclusive indicating similarity

toString

public String toString()

Overrides:

toString in class Object