net.ricecode.similarity

Class SimilarityScore

java.lang.Object

net.ricecode.similarity.SimilarityScore

public class SimilarityScore
extends Object

A value object contains a similarity score.

Author:

Ralph Allan Rice

Constructor Summary

Constructors

Constructor and Description
SimilarityScore(String key, double score) Constructs a similarity score.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Determines if the supplied object equals this object.
String	getKey() Gets the key for this score.
double	getScore() Gets the value of the score.
int	hashCode() Returns the hash code for this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimilarityScore

public SimilarityScore(String key,
               double score)

Constructs a similarity score.

Parameters:

key - The string key.

score - The score value.

Method Detail

getKey

public String getKey()

Gets the key for this score.

Returns:

A string.

getScore

public double getScore()

Gets the value of the score.

Returns:

A double.

hashCode

public int hashCode()

Returns the hash code for this object.

Overrides:

hashCode in class Object

Returns:

An integer representing the hash code.

equals

public boolean equals(Object o)

Determines if the supplied object equals this object.

Overrides:

equals in class Object

Returns:

True if the keys and scores match between the two objects. Otherwise false.