Package de.uni_trier.wi2.procake.similarity.impl

Class SimilarityValuatorImpl

java.lang.Object

de.uni_trier.wi2.procake.similarity.impl.SimilarityValuatorImpl

All Implemented Interfaces:

SimilarityValuator

public class SimilarityValuatorImpl
extends Object
implements SimilarityValuator

Implementation of SimilarityValuator for computing the similarity between two objects.

Author:

Rainer Maximini, Christian Zeyen

Field Summary

Fields inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityValuator

DEFAULT_COMPUTATION_TIME_THRESHOLD_FOR_CACHING

Constructor Summary

Constructors

Constructor	Description
SimilarityValuatorImpl(SimilarityModel simModel)

Method Summary

Modifier and Type	Method	Description
Similarity	computeSimilarity(DataObject queryObject, DataObject caseObject)	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 similarityMeasureStr)	Computes the similarity between a queryObject and a caseObject based on the similarityMeasure
long	getComputationTimeThresholdForCaching()
SimilarityCache	getSimilarityCache()
SimilarityMeasure	getSimilarityMeasure(DataObject query, DataObject object)	Returns the appropriate similarity measure for the common parent class of both given data objects.
SimilarityModel	getSimilarityModel()	The SimilarityModel that is used for the computation.
void	setComputationTimeThresholdForCaching(long timeNanos)
void	setSimilarityCache(SimilarityCache similarityCache)

Methods inherited from class java.lang.Object

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

Constructor Details

SimilarityValuatorImpl

public SimilarityValuatorImpl(SimilarityModel simModel)

Method Details

getSimilarityCache

public SimilarityCache getSimilarityCache()

Specified by:

getSimilarityCache in interface SimilarityValuator

Returns:

similarity cache used by this valuator or null

setSimilarityCache

public void setSimilarityCache(SimilarityCache similarityCache)

Specified by:

setSimilarityCache in interface SimilarityValuator

Parameters:

similarityCache - similarity cache to be used by this valuator

getComputationTimeThresholdForCaching

public long getComputationTimeThresholdForCaching()

Specified by:

getComputationTimeThresholdForCaching in interface SimilarityValuator

Returns:

computation time in nanoseconds to cache computed similarity values

setComputationTimeThresholdForCaching

public void setComputationTimeThresholdForCaching(long timeNanos)

Specified by:

setComputationTimeThresholdForCaching in interface SimilarityValuator

Parameters:

timeNanos - computation time in nanoseconds to cache computed similarity values

getSimilarityMeasure

public SimilarityMeasure getSimilarityMeasure(DataObject query,
 DataObject object)

Description copied from interface: SimilarityValuator

Returns the appropriate similarity measure for the common parent class of both given data objects.

Specified by:

getSimilarityMeasure in interface SimilarityValuator

Parameters:

query - the query object

object - the case object

Returns:

the similarity measure for the common data class

computeSimilarity

public Similarity computeSimilarity(DataObject queryObject,
 DataObject caseObject)

Description copied from interface: SimilarityValuator

Computes the similarity between a query and a case.

Specified by:

computeSimilarity in interface SimilarityValuator

Parameters:

queryObject - The query DataObject.

caseObject - The case DataObject.

Returns:

the similarity value, if no applicable similarity measure exists, an invalid Similarity will be returned.

computeSimilarity

public Similarity computeSimilarity(DataObject queryObject,
 DataObject caseObject,
 DataClass commonClass)

Description copied from interface: SimilarityValuator

Computes the similarity between a query and a case for the given common data class.

Specified by:

computeSimilarity in interface SimilarityValuator

Parameters:

queryObject - The query DataObject.

caseObject - The case DataObject.

commonClass - The common parent DataClass that should be used.

Returns:

the similarity value, if no applicable similarity measure exists, an invalid Similarity will be returned.

computeSimilarity

public Similarity computeSimilarity(DataObject queryObject,
 DataObject caseObject,
 String similarityMeasureStr)

Description copied from interface: SimilarityValuator

Computes the similarity between a queryObject and a caseObject based on the similarityMeasure

Specified by:

computeSimilarity in interface SimilarityValuator

Parameters:

queryObject - The query DataObject.

caseObject - The case DataObject.

similarityMeasureStr - if null, SimilarityValuator.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

public SimilarityModel getSimilarityModel()

Description copied from interface: SimilarityValuator

The SimilarityModel that is used for the computation.

Specified by:

getSimilarityModel in interface SimilarityValuator

Returns:

the used SimilarityModel