de.tuebingen.uni.sfs.germanet.relatedness
Class RelatednessResult

java.lang.Object
  extended by de.tuebingen.uni.sfs.germanet.relatedness.RelatednessResult

public class RelatednessResult
extends java.lang.Object

Represents the result of a relatedness mesaure (class Relatedness). Contains the name of the measure and the result and can calculate the normalized result (mapping into [0,1]).


Constructor Summary
RelatednessResult(java.lang.String name, double value, java.lang.Object[] arguments)
          Constructor taking name of the relatedness measure used and result value.
 
Method Summary
 double getNormalizedResult()
          Returns a mapping of the result value into [0,1], where 0 is no similarity and 1 is identity.
 double getResult()
          Returns the double value calculated by this relatedness measure.
 java.lang.String toString()
          The return String contains the name of the measure, the result value (not normalized) and the number of arguments.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RelatednessResult

public RelatednessResult(java.lang.String name,
                         double value,
                         java.lang.Object[] arguments)
Constructor taking name of the relatedness measure used and result value.

Parameters:
name - the name of the relatedness measure used
value - the result of this relatedness measure
arguments - additional args for lesk and ics; null for path measures
Method Detail

getResult

public double getResult()
Returns the double value calculated by this relatedness measure.

Returns:
the result value of the relatedness calculation

getNormalizedResult

public double getNormalizedResult()
Returns a mapping of the result value into [0,1], where 0 is no similarity and 1 is identity.
Caution: This is not true for Resnik's measure. Identity may have a value smaller than 1 for Resnik.

Returns:
a normalized representation of the given relatedness value

toString

public java.lang.String toString()
The return String contains the name of the measure, the result value (not normalized) and the number of arguments.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of this RelatednessResult object.