de.hpi.fgis.dude.similarityfunction.structurebased
Class ConstantSimilarityFunction

java.lang.Object
  extended by de.hpi.fgis.dude.similarityfunction.structurebased.ConstantSimilarityFunction
All Implemented Interfaces:
SimilarityFunction, AutoJsonable

public class ConstantSimilarityFunction
extends Object
implements SimilarityFunction

ConstantSimilarityFunction returns a similarity that is independent from the passed DuDeObjectPair and can be specified by the user.

Author:
Matthias Pohl

Nested Class Summary
 
Nested classes/interfaces inherited from interface de.hpi.fgis.dude.similarityfunction.SimilarityFunction
SimilarityFunction.SimilarityValidationState
 
Constructor Summary
protected ConstantSimilarityFunction()
          Internal constructor for Jsonable deserialization.
  ConstantSimilarityFunction(double simValue)
          Initializes the ConstantSimilarityFunction with the passed similarity.
 
Method Summary
 SimilarityFunction.SimilarityValidationState getLastValidationState()
          Since ConstantSimilarityFunction is not based on actual values, it returns SimilarityValidationState.BothValid for each calculated pair.
 double getSimilarity(DuDeObjectPair pair)
          Calculates the similarity of passed DuDeObjectPair's members.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConstantSimilarityFunction

protected ConstantSimilarityFunction()
Internal constructor for Jsonable deserialization.


ConstantSimilarityFunction

public ConstantSimilarityFunction(double simValue)
Initializes the ConstantSimilarityFunction with the passed similarity. Any call of getSimilarity(DuDeObjectPair) will set this similarity for the pair.

Parameters:
simValue - The similarity that will be returned by getSimilarity(DuDeObjectPair).
Method Detail

getSimilarity

public double getSimilarity(DuDeObjectPair pair)
Description copied from interface: SimilarityFunction
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.

Specified by:
getSimilarity in interface SimilarityFunction
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

public SimilarityFunction.SimilarityValidationState getLastValidationState()
Since ConstantSimilarityFunction is not based on actual values, it returns SimilarityValidationState.BothValid for each calculated pair.

Specified by:
getLastValidationState in interface SimilarityFunction
Returns:
The validation state of the last similarity calculation or SimilarityFunction.SimilarityValidationState.BothInvalid, if SimilarityFunction.getSimilarity(DuDeObjectPair) was not called, yet.


Copyright © 2011 Hasso Plattner Institute - Chair of Information Systems. All Rights Reserved.