org.ov4j.comp
Class ComparisonResult<T>

java.lang.Object
  org.ov4j.comp.ComparisonResult<T>

Direct Known Subclasses:

ClassComparableComparisonResult, DefaultComparisonResult, DummyComparisonResult, NumericComparisonResult, SentenceComparisonResult, StringComparisonResult, URIComparisonResult, VersionComparisonResult

public abstract class ComparisonResult<T>
extends java.lang.Object

Base class for comparing objects.

Author:

smolloy

Constructor Summary

ComparisonResult()
Constructor.

Method Summary

abstract void	compute() Perform metric computation.
abstract void	fastCompute() Perform fast computation, only setting precision to 1.0 to indicate that both items are the same or to anything else otherwise.
static <C,T extends ComparisonResult<C>> java.lang.Class<T>	findComparisonResultClass(C o) Find class to use to compare instances of the given object.
T	getChanged()
java.lang.Object[]	getFalseNegatives()
java.lang.Object[]	getFalsePositives()
ComparisonResult<?>[]	getMatches()
T	getOriginal()
double	getPrecision()
double	getRecall()
int	numFalseNegatives()
int	numFalsePositives()
int	numMatches()
void	setChanged(T changed)
void	setFalseNegatives(java.lang.Object[] falseNegatives)
void	setFalsePositives(java.lang.Object[] falsePositives)
void	setMatches(ComparisonResult<?>[] matches)
void	setOriginal(T original)
void	setPrecision(double precision)
void	setRecall(double recall)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparisonResult

public ComparisonResult()

Constructor.

Method Detail

findComparisonResultClass

public static <C,T extends ComparisonResult<C>> java.lang.Class<T> findComparisonResultClass(C o)
                                                                                throws java.lang.ClassNotFoundException

Find class to use to compare instances of the given object.

Parameters:

o - Object to be compared.

Returns:

Class to use for comparing the object.

Throws:

java.lang.ClassNotFoundException

compute

public abstract void compute()

Perform metric computation.

fastCompute

public abstract void fastCompute()

Perform fast computation, only setting precision to 1.0 to indicate that both items are the same or to anything else otherwise.

getChanged

public T getChanged()

Returns:

Returns the compared object.

getFalseNegatives

public java.lang.Object[] getFalseNegatives()

Returns:

Returns the falseNegatives.

getFalsePositives

public java.lang.Object[] getFalsePositives()

Returns:

Returns the falsePositives.

getMatches

public ComparisonResult<?>[] getMatches()

Returns:

Returns the matches.

getOriginal

public T getOriginal()

Returns:

Returns the original.

getPrecision

public double getPrecision()

Returns:

Returns the precision.

getRecall

public double getRecall()

Returns:

Returns the recall.

numFalseNegatives

public int numFalseNegatives()

Returns:

numFalsePositives

public int numFalsePositives()

Returns:

numMatches

public int numMatches()

Returns:

setChanged

public void setChanged(T changed)

Parameters:

changed - The compared object to set.

setFalseNegatives

public void setFalseNegatives(java.lang.Object[] falseNegatives)

Parameters:

falseNegatives - The falseNegatives to set.

setFalsePositives

public void setFalsePositives(java.lang.Object[] falsePositives)

Parameters:

falsePositives - The falsePositives to set.

setMatches

public void setMatches(ComparisonResult<?>[] matches)

Parameters:

matches - The matches to set.

setOriginal

public void setOriginal(T original)

Parameters:

original - The original to set.

setPrecision

public void setPrecision(double precision)

Parameters:

precision - The precision to set.

setRecall

public void setRecall(double recall)

Parameters:

recall - The recall to set.