com.screenscraper.util

Class FuzzyMatcher

java.lang.Object

com.screenscraper.util.FuzzyMatcher

public class FuzzyMatcher
extends java.lang.Object

Created by: David Andersen Date: Jul 12, 2010

Constructor Summary

Constructors

Constructor and Description
FuzzyMatcher()

Method Summary

Modifier and Type	Method and Description
static java.util.HashMap<java.lang.String,java.lang.Object>	getMatch(java.lang.String str, java.util.ArrayList<java.lang.String> list) Overloaded method of getMatch(String str, String[] StringsToBematched),that allows passing in an ArrayList instead of String[].
static java.util.HashMap<java.lang.String,java.lang.Object>	getMatch(java.lang.String str, java.lang.String[] stringsToBeMatched) Pass in a String to be matched to, along with an Array of Strings that are to be examined for the closest match.
static java.util.ArrayList<java.util.HashMap>	matchLists(java.util.ArrayList<java.lang.String> a, java.util.ArrayList<java.lang.String> b) Returns an ArrayList<HashMap> for the closest match for each element in ArrayList a to ArrayList b.
static float	score(java.lang.String a, java.lang.String b) Returns a percentage of characters that match between strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

FuzzyMatcher

public FuzzyMatcher()

Method Detail

matchLists

@NotNull
public static java.util.ArrayList<java.util.HashMap> matchLists(@NotNull
                                                                          java.util.ArrayList<java.lang.String> a,
                                                                          @NotNull
                                                                          java.util.ArrayList<java.lang.String> b)

Returns an ArrayList<HashMap> for the closest match for each element in ArrayList a to ArrayList b. ArrayList b must be equal or larger in elements to ArrayList a.

Parameters:

a - ArrayList<String> of items to be matched

b - ArrayList<String> of items of possible matches

Returns:

Returns an ArrayList<HashMap>. Each HashMap<String, Object> contains fields "BASE", "MATCH", and "SCORE"

getMatch

@NotNull
public static java.util.HashMap<java.lang.String,java.lang.Object> getMatch(@Nullable
                                                                                      java.lang.String str,
                                                                                      @Nullable
                                                                                      java.lang.String[] stringsToBeMatched)

Pass in a String to be matched to, along with an Array of Strings that are to be examined for the closest match. Will return a HashMap with String fields "MATCH" and "SCORE" of the String in the array with the closest match.

Parameters:

str - String base to find closest match for

stringsToBeMatched - String[] of strings to test against str

Returns:

returns a HashMap<String, Object> with elements "MATCH" and "SCORE"

getMatch

@NotNull
public static java.util.HashMap<java.lang.String,java.lang.Object> getMatch(java.lang.String str,
                                                                                      @NotNull
                                                                                      java.util.ArrayList<java.lang.String> list)

Overloaded method of getMatch(String str, String[] StringsToBematched),that allows passing in an ArrayList instead of String[].

Parameters:

str - Base String to be matched to

list - ArrayList<String> of strings to be tested for the closest match to str

Returns:

returns a HashMap<String, Object> with elements "MATCH" and "SCORE"

score

public static float score(@Nullable
                          java.lang.String a,
                          @Nullable
                          java.lang.String b)

Returns a percentage of characters that match between strings. The higher the percentage, the closer the match.

Parameters:

a - String

b - String

Returns:

Returns a float with a percentage of characters that match.