de.hpi.fgis.dude.similarityfunction
Interface SimilarityFunction

All Superinterfaces:

AutoJsonable

All Known Implementing Classes:

AbsoluteNumberDiffFunction, AbstractSimilarityFunction, Aggregator, Average, BlockDistanceFunction, CitySimilarityFunction, ConstantSimilarityFunction, ContentBasedSimilarityFunction, CosineSimilarityFunction, DateSimilarityFunction, DiceCoefficientFunction, EquationSimilarityFunction, EuclideanDistanceFunction, FamilyNameSimilarityFunction, GivenNameSimilarityFunction, HarmonicMean, HonorificSimilarityFunction, HouseNumberSimilarityFunction, JaccardSimilarityFunction, JaroDistanceFunction, JaroWinklerFunction, LevenshteinDistanceFunction, MatchingCoefficientFunction, Maximum, Minimum, MongeElkanFunction, NeedlemanWunschFunction, OverlapCoefficientFunction, PhoneNumberSimilarityFunction, RelativeNumberDiffFunction, SimmetricsFunction, SmithWatermanFunction, SmithWatermanGotohFunction, SoundExFunction, StreetSimilarityFunction, TFIDFSimilarityFunction, TitleSimilarityFunction, ZIPSimilarityFunction

public interface SimilarityFunction
extends AutoJsonable

SimilarityFunction is used to determine the similarity of two DuDeObject's. The similarity is described by a floating-point number within the range of 0 and 1.

Author:

Matthias Pohl, Arvid Heise

See Also:

AbstractSimilarityFunction

Nested Class Summary

static class

SimilarityFunction.SimilarityValidationState SimilarityValidationState is a descriptor whether two values could be used for similarity calculation or not.

Method Summary

SimilarityFunction.SimilarityValidationState	getLastValidationState() Returns the validation state of the last getSimilarity(DuDeObjectPair) call.
double	getSimilarity(DuDeObjectPair pair) Calculates the similarity of passed DuDeObjectPair's members.

Method Detail

getSimilarity

double getSimilarity(DuDeObjectPair pair)

Calculates the similarity of passed DuDeObjectPair's members. Besides returning the similarity of the pair, this method stores the calculated similarity also in the pair using DuDeObjectPair.setSimilarity(double). Any already calculated similarity will be overwritten.

Parameters:

pair - A pair of DuDeObjects that shall be compared.

Returns:

A value between 0.0 (not equal) and 1.0 (the same object).

getLastValidationState

SimilarityFunction.SimilarityValidationState getLastValidationState()

Returns the validation state of the last getSimilarity(DuDeObjectPair) call. If it was not called, yet, SimilarityFunction.SimilarityValidationState.BothInvalid is returned.

Returns:

The validation state of the last similarity calculation or SimilarityFunction.SimilarityValidationState.BothInvalid, if getSimilarity(DuDeObjectPair) was not called, yet.