org.terrier.evaluation

Class TerrierEvaluation

java.lang.Object

org.terrier.evaluation.TerrierEvaluation

All Implemented Interfaces:

Evaluation

Direct Known Subclasses:

AdhocEvaluation, NamedPageEvaluation

public abstract class TerrierEvaluation
extends Object
implements Evaluation

An abstract class for evaluating the retrieval results.

Author:

Gianni Amati, Ben He, Vassilis Plachouras

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TerrierEvaluation.Record A structure of a record of retrieved document.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
TRECQrelsInMemory	qrels A structure of all the records in the qrels files.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TerrierEvaluation()
protected	TerrierEvaluation(String qrelsFile)
protected	TerrierEvaluation(String[] qrelsFiles)

Method Summary

Modifier and Type	Method and Description
abstract void	evaluate(String resultFilename) Evaluates the given result file for the given qrels file.
void	writeEvaluationResult() Output the evaluation result to standard output
abstract void	writeEvaluationResult(PrintWriter out) The abstract method that evaluates and prints the results.
void	writeEvaluationResult(String resultEvalFilename) Output the evaluation result to the specific file.
abstract void	writeEvaluationResultOfEachQuery(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.slf4j.Logger logger

qrels

public TRECQrelsInMemory qrels

A structure of all the records in the qrels files.

Constructor Detail

TerrierEvaluation

protected TerrierEvaluation()

TerrierEvaluation

protected TerrierEvaluation(String qrelsFile)

TerrierEvaluation

protected TerrierEvaluation(String[] qrelsFiles)

Method Detail

evaluate

public abstract void evaluate(String resultFilename)

Description copied from interface: Evaluation

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

Specified by:

evaluate in interface Evaluation

Parameters:

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

writeEvaluationResult

public void writeEvaluationResult()

Description copied from interface: Evaluation

Output the evaluation result to standard output

Specified by:

writeEvaluationResult in interface Evaluation

writeEvaluationResult

public abstract void writeEvaluationResult(PrintWriter out)

Description copied from interface: Evaluation

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

Specified by:

writeEvaluationResult in interface Evaluation

Parameters:

out - java.io.PrintWriter

writeEvaluationResultOfEachQuery

public abstract void writeEvaluationResultOfEachQuery(String evaluationResultFilename)

Description copied from interface: Evaluation

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

Specified by:

writeEvaluationResultOfEachQuery in interface Evaluation

Parameters:

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

writeEvaluationResult

public void writeEvaluationResult(String resultEvalFilename)

Description copied from interface: Evaluation

Output the evaluation result to the specific file.

Specified by:

writeEvaluationResult in interface Evaluation

Parameters:

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