Interface SimilarityValuator
-
- All Known Implementing Classes:
SimilarityValuatorImpl
public interface SimilarityValuator
The similarity valuator computes the similarity between two objects.A new similarity valuator can be created using
SimilarityModelFactory.newSimilarityValuator()
orSimilarityModelFactory.newSimilarityValuator(SimilarityModel)
. The similarity can be computed using the methodcomputeSimilarity(DataObject, DataObject)
.The valuator is thread safe why it is no problem to reuse the valuator in parallel.
- Author:
- Rainer Maximini
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Similarity
computeSimilarity(DataObject query, DataObject object)
Computes the similarity between a query and a case.Similarity
computeSimilarity(DataObject queryObject, DataObject caseObject, DataClass commonClass)
Computes the similarity between a query and a case for the given common data class.Similarity
computeSimilarity(DataObject queryObject, DataObject caseObject, String similarityMeasure)
Computes the similarity between a queryObject and a caseObject based on the similarityMeasureSimilarityMeasure
getSimilarityMeasure(DataObject query, DataObject object)
Returns the appropriate similarity measure for the common parent class of both given data objects.SimilarityModel
getSimilarityModel()
TheSimilarityModel
that is used for the computation.
-
-
-
Method Detail
-
computeSimilarity
Similarity computeSimilarity(DataObject query, DataObject object)
Computes the similarity between a query and a case.- Parameters:
query
- The queryDataObject
.object
- The caseDataObject
.- Returns:
- the similarity value, if no applicable similarity measure exists, an invalid Similarity will be returned.
-
computeSimilarity
Similarity computeSimilarity(DataObject queryObject, DataObject caseObject, DataClass commonClass)
Computes the similarity between a query and a case for the given common data class.- Parameters:
queryObject
- The queryDataObject
.caseObject
- The caseDataObject
.commonClass
- The common parentDataClass
that should be used.- Returns:
- the similarity value, if no applicable similarity measure exists, an invalid Similarity will be returned.
-
computeSimilarity
Similarity computeSimilarity(DataObject queryObject, DataObject caseObject, String similarityMeasure)
Computes the similarity between a queryObject and a caseObject based on the similarityMeasure- Parameters:
queryObject
-caseObject
-similarityMeasure
- ifnull
,computeSimilarity(DataObject, DataObject)
is used, else the similarity with the given name is used.- Returns:
- the similarity value, if no similarity measure with that name exists, an invalid Similarity will be returned.
-
getSimilarityModel
SimilarityModel getSimilarityModel()
TheSimilarityModel
that is used for the computation.- Returns:
- the used
SimilarityModel
-
getSimilarityMeasure
SimilarityMeasure getSimilarityMeasure(DataObject query, DataObject object)
Returns the appropriate similarity measure for the common parent class of both given data objects.- Parameters:
query
- the query objectobject
- the case object- Returns:
- the similarity measure for the common data class
-
-