org.terrier.evaluation
Class Evaluation

java.lang.Object
  org.terrier.evaluation.Evaluation

Direct Known Subclasses:

AdhocEvaluation, NamedPageEvaluation

public abstract class Evaluation
extends java.lang.Object

An abstract class for evaluating the retrieval results.

Author:

Gianni Amati, Ben He, Vassilis Plachouras

Nested Class Summary

static class

Evaluation.Record A structure of a record of retrieved document.

Field Summary

protected static org.apache.log4j.Logger	logger
TRECQrelsInMemory	qrels A structure of all the records in the qrels files.

Constructor Summary

protected	Evaluation()
protected	Evaluation(java.lang.String qrelsFile)
protected	Evaluation(java.lang.String[] qrelsFiles)

Method Summary

abstract void	evaluate(java.lang.String resultFilename) Evaluates the given result file for the given qrels file.
void	writeEvaluationResult() Output the evaluation result to standard output
abstract void	writeEvaluationResult(java.io.PrintWriter out) The abstract method that evaluates and prints the results.
void	writeEvaluationResult(java.lang.String resultEvalFilename) Output the evaluation result to the specific file.
abstract void	writeEvaluationResultOfEachQuery(java.lang.String evaluationResultFilename) Output the evaluation result of each query to the specific file.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

qrels

public TRECQrelsInMemory qrels

A structure of all the records in the qrels files.

Constructor Detail

Evaluation

protected Evaluation()

Evaluation

protected Evaluation(java.lang.String qrelsFile)

Evaluation

protected Evaluation(java.lang.String[] qrelsFiles)

Method Detail

evaluate

public abstract void evaluate(java.lang.String resultFilename)

Evaluates the given result file for the given qrels file. All subclasses must implement this method.

Parameters:

resultFilename - java.lang.String the filename of the result file to evaluate.

writeEvaluationResult

public void writeEvaluationResult()

Output the evaluation result to standard output

writeEvaluationResult

public abstract void writeEvaluationResult(java.io.PrintWriter out)

The abstract method that evaluates and prints the results. All the subclasses of Evaluation must implement this method.

Parameters:

out - java.io.PrintWriter

writeEvaluationResultOfEachQuery

public abstract void writeEvaluationResultOfEachQuery(java.lang.String evaluationResultFilename)

Output the evaluation result of each query to the specific file.

Parameters:

evaluationResultFilename - String the name of the file in which to save the evaluation results.

writeEvaluationResult

public void writeEvaluationResult(java.lang.String resultEvalFilename)

Output the evaluation result to the specific file.

Parameters:

resultEvalFilename - java.lang.String the filename of the file to output the result.