com.screenscraper.util.fuzzy

Class FuzzyStringMatcher

java.lang.Object

com.screenscraper.util.fuzzy.FuzzyMatcher<java.lang.Character>

com.screenscraper.util.fuzzy.FuzzyStringMatcher

public final class FuzzyStringMatcher
extends FuzzyMatcher<java.lang.Character>

Fuzzy matcher used to compare strings

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
FuzzyStringMatcher(double matchCost, double insertionCost, double deletionCost, double substitutionCost) Used to create a fuzzy string matcher with the given costs for insertion and deletions
FuzzyStringMatcher(FuzzyCost<java.lang.Character> costAnalyzer) Creates a fuzzy string matcher with the given costs

Method Summary

Modifier and Type	Method and Description
FuzzyMatcherAlignmentResult<java.lang.Character>	getAlignment(java.lang.CharSequence mainString, java.lang.CharSequence secondaryString) Returns the alignment found as the best fuzzy match for the two strings
double	getPercentMatch(java.lang.CharSequence mainString, java.lang.CharSequence secondaryString) Returns a percent value indicating how well the two strings matched
double	getScore(java.lang.CharSequence mainString, java.lang.CharSequence secondaryString) Gets the match score for the two strings

Methods inherited from class com.screenscraper.util.fuzzy.FuzzyMatcher

getAlignment, getAlignment, getPercentMatch, getPercentMatch, getScore, getScore, getScoreByResult, getWeightedPercentMatch, getWeightedPercentMatch

Methods inherited from class java.lang.Object

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

Constructor Detail

FuzzyStringMatcher

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

Used to create a fuzzy string matcher with the given costs for insertion and deletions

Parameters:

matchCost - The cost for matching characters

insertionCost - The cost of inserting a value into the main set

deletionCost - The cost of deleting values from the main set

substitutionCost - The cost of substituting one value for another

FuzzyStringMatcher

public FuzzyStringMatcher(FuzzyCost<java.lang.Character> costAnalyzer)

Creates a fuzzy string matcher with the given costs

Parameters:

costAnalyzer - The analyzer used to get costs dynamically based on the values

Method Detail

getScore

public double getScore(@NotNull
                       java.lang.CharSequence mainString,
                       @NotNull
                       java.lang.CharSequence secondaryString)

Gets the match score for the two strings

Parameters:

mainString - The main string

secondaryString - The secondary string

Returns:

Returns the best cost match value

getAlignment

@NotNull
public FuzzyMatcherAlignmentResult<java.lang.Character> getAlignment(@NotNull
                                                                               java.lang.CharSequence mainString,
                                                                               @NotNull
                                                                               java.lang.CharSequence secondaryString)

Returns the alignment found as the best fuzzy match for the two strings

Parameters:

mainString - The main string to match

secondaryString - The secondary string to match

Returns:

Returns the alignment that was found as the best match for the two given strings

getPercentMatch

public double getPercentMatch(@NotNull
                              java.lang.CharSequence mainString,
                              @NotNull
                              java.lang.CharSequence secondaryString)

Returns a percent value indicating how well the two strings matched

Parameters:

mainString - The main string to test

secondaryString - The secondary string to test

Returns:

The percent value indicating how well these two strings matched