net.ricecode.similarity

Interface StringSimilarityService

All Known Implementing Classes:

StringSimilarityServiceImpl

public interface StringSimilarityService

A service that performs string similarity calculations.

Author:

Ralph Allan Rice

Method Summary

Methods

Modifier and Type	Method and Description
SimilarityScore	findTop(List<String> features, String target) Finds the feature within a set of given features that best match the target string.
SimilarityScore	findTop(List<String> features, String target, Comparator<SimilarityScore> comparator) Finds the feature within a set of given features that best match the target string.
double	score(String feature, String target) Calculates the similarity score of a single feature.
List<SimilarityScore>	scoreAll(List<String> features, String target) Calculates all similarity scores for a given set of features.

Method Detail

scoreAll

List<SimilarityScore> scoreAll(List<String> features,
                             String target)

Calculates all similarity scores for a given set of features.

Parameters:

features - The list of features.

target - The target string to compare against the features.

Returns:

A list of similarity scores.

score

double score(String feature,
           String target)

Calculates the similarity score of a single feature.

Parameters:

feature - The feature string to compare.

target - The target string to compare against the feature.

Returns:

The similarity score between the feature and target.

findTop

SimilarityScore findTop(List<String> features,
                      String target)

Finds the feature within a set of given features that best match the target string.

Parameters:

features - A list of strings containing the features to compare.

target - The target string to compare against the features.

Returns:

A SimilarityScore that has the highest score value amongst the features.

findTop

SimilarityScore findTop(List<String> features,
                      String target,
                      Comparator<SimilarityScore> comparator)

Finds the feature within a set of given features that best match the target string.

Parameters:

features - A list of strings containing the features to compare.

target - The target string to compare against the features.

comparator - A comparator that is used sort the scores.

Returns:

A SimilarityScore that has the top value amongst the features, according to the comparator.