net.ricecode.similarity

Class StringSimilarityServiceImpl

java.lang.Object

net.ricecode.similarity.StringSimilarityServiceImpl

All Implemented Interfaces:

StringSimilarityService

public class StringSimilarityServiceImpl
extends Object
implements StringSimilarityService

An implementation of StringSimilarityService.

Author:

Ralph Allan Rice

See Also:

StringSimilarityService

Constructor Summary

Constructors

Constructor and Description
StringSimilarityServiceImpl(SimilarityStrategy strategy) Creates a similarity calculator instance.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSimilarityServiceImpl

public StringSimilarityServiceImpl(SimilarityStrategy strategy)

Creates a similarity calculator instance.

Parameters:

strategy - The similarity strategy to use when calculating similarity scores.

Method Detail

scoreAll

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

Calculates all similarity scores for a given set of features.

Specified by:

scoreAll in interface StringSimilarityService

Parameters:

features - The list of features.

target - The target string to compare against the features.

Returns:

A list of similarity scores.

score

public double score(String feature,
           String target)

Calculates the similarity score of a single feature.

Specified by:

score in interface StringSimilarityService

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

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

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

Specified by:

findTop in interface StringSimilarityService

Parameters:

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

target - The target string to compare against the features.

Returns:

The similarity score with the highest value.

findTop

public 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.

Specified by:

findTop in interface StringSimilarityService

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.