com.screenscraper.util.fuzzy

Class FuzzyMatcher<T>

java.lang.Object

com.screenscraper.util.fuzzy.FuzzyMatcher<T>

Direct Known Subclasses:

FuzzyStringMatcher

public class FuzzyMatcher<T>
extends java.lang.Object

Basic fuzzy matcher used to compare to possibly dissimilar lists. So long as the cost analyzing method is thread safe, this matcher will also be thread safe

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
FuzzyMatcher(double matchCost, double insertionCost, double deletionCost, double substitutionCost) Create a fuzzy matcher with the given costs
FuzzyMatcher(FuzzyCost<T> costAnalyzer) Create a fuzzy matcher using a FuzzyCost matcher

Method Summary

Modifier and Type	Method and Description
FuzzyMatcherAlignmentResult<T>	getAlignment(java.util.List<T> mainList, java.util.List<T> secondaryList) Returns the resulting alignment for matching the to lists
FuzzyMatcherAlignmentResult<T>	getAlignment(T[] mainArray, T[] secondaryArray) Returns the resulting alignment for matching the to arrays
double	getPercentMatch(java.util.List<T> mainList, java.util.List<T> secondaryList) Gets the percent match of the two lists.
double	getPercentMatch(T[] mainArray, T[] secondaryArray) Gets the percent match of the two arrays.
double	getScore(java.util.List<T> mainList, java.util.List<T> secondaryList) Gets the best possible score for fuzzy matching the two lists
double	getScore(T[] mainArray, T[] secondaryArray) Gets the best possible score for fuzzy matching the two arrays
double	getScoreByResult(FuzzyMatcherAlignmentResult<T> alignmentResult) Recalculates the cost of the given match.
double	getWeightedPercentMatch(java.util.List<T> mainList, java.util.List<T> secondaryList) Gets the percent match of the two lists.
double	getWeightedPercentMatch(T[] mainArray, T[] secondaryArray) Gets the percent match of the two arrays.

Methods inherited from class java.lang.Object

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

Constructor Detail

FuzzyMatcher

public FuzzyMatcher(double matchCost,
                    double insertionCost,
                    double deletionCost,
                    double substitutionCost)

Create a fuzzy matcher with the given costs

Parameters:

matchCost - The cost of making a direct match

insertionCost - The cost of inserting into the main value

deletionCost - The cost of removing from the main value

substitutionCost - The cost of substituting one value for another

FuzzyMatcher

public FuzzyMatcher(FuzzyCost<T> costAnalyzer)

Create a fuzzy matcher using a FuzzyCost matcher

Parameters:

costAnalyzer - The cost calculating object.

Method Detail

getScore

public double getScore(@NotNull
                       java.util.List<T> mainList,
                       @NotNull
                       java.util.List<T> secondaryList)

Gets the best possible score for fuzzy matching the two lists

Parameters:

mainList - The main list of objects to match

secondaryList - The secondary list of objects to match

Returns:

The best cost for matching these lists

getScore

public double getScore(T[] mainArray,
                       T[] secondaryArray)

Gets the best possible score for fuzzy matching the two arrays

Parameters:

mainArray - The main array of objects to match

secondaryArray - The secondary array of objects to match

Returns:

The best cost for matching these arrays

getAlignment

@NotNull
public FuzzyMatcherAlignmentResult<T> getAlignment(@NotNull
                                                             java.util.List<T> mainList,
                                                             @NotNull
                                                             java.util.List<T> secondaryList)

Returns the resulting alignment for matching the to lists

Parameters:

mainList - The main list of objects to match

secondaryList - The secondary list of objects to match

Returns:

The FuzzyMatcherAlignmentResult object that represents the best alignment

getAlignment

@NotNull
public FuzzyMatcherAlignmentResult<T> getAlignment(T[] mainArray,
                                                             T[] secondaryArray)

Returns the resulting alignment for matching the to arrays

Parameters:

mainArray - The main array of objects to match

secondaryArray - The secondary array of objects to match

Returns:

The FuzzyMatcherAlignmentResult object that represents the best alignment

getScoreByResult

public double getScoreByResult(@NotNull
                               FuzzyMatcherAlignmentResult<T> alignmentResult)

Recalculates the cost of the given match. This can't correctly calculate the cost if it is dependent of the specific elements (ie is costs more to substitute a and b than a and c)

Parameters:

alignmentResult - The alignment match

Returns:

The cost of the match

getPercentMatch

public double getPercentMatch(@NotNull
                              java.util.List<T> mainList,
                              @NotNull
                              java.util.List<T> secondaryList)

Gets the percent match of the two lists. This doesn't exactly take into account the specific costs for each match type, but simply the number of steps required to make a fuzzy match, with substitutions being weighted equally with insertions and deletions for the number (not for the match)

Parameters:

mainList - The main list of objects to match

secondaryList - The secondary list of objects to match

Returns:

The percent match of the two lists, from 0 to 1

getPercentMatch

public double getPercentMatch(T[] mainArray,
                              T[] secondaryArray)

Gets the percent match of the two arrays. This doesn't exactly take into account the specific costs for each match type, but simply the number of steps required to make a fuzzy match, with substitutions being weighted equally with insertions and deletions for the number (not for the match)

Parameters:

mainArray - The main array of objects to match

secondaryArray - The secondary array of objects to match

Returns:

The percent match of the two arrays, from 0 to 1

getWeightedPercentMatch

public double getWeightedPercentMatch(@NotNull
                                      java.util.List<T> mainList,
                                      @NotNull
                                      java.util.List<T> secondaryList)

Gets the percent match of the two lists. This bases the resulting percent on the worst possible match cost compared to what the actual cost was

Parameters:

mainList - The main list of objects to match

secondaryList - The secondary list of objects to match

Returns:

The percent match of the two lists, from 0 to 1

getWeightedPercentMatch

public double getWeightedPercentMatch(T[] mainArray,
                                      T[] secondaryArray)

Gets the percent match of the two arrays. This bases the resulting percent on the worst possible match cost compared to what the actual cost was

Parameters:

mainArray - The main array of objects to match

secondaryArray - The secondary array of objects to match

Returns:

The percent match of the two arrays, from 0 to 1