org.terrier.evaluation

Interface Evaluation

All Known Implementing Classes:

AdhocEvaluation, AdhocFullQueryEvaluation, NamedPageEvaluation, TerrierEvaluation, TrecEvalEvaluation

public interface Evaluation

Method Summary

Modifier and Type	Method and Description
void	evaluate(String resultFilename) Evaluates the given result file for the given qrels file.
void	writeEvaluationResult() Output the evaluation result to standard output
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.
void	writeEvaluationResultOfEachQuery(String evaluationResultFilename) Output the evaluation result of each query to the specific file.

Method Detail

evaluate

void evaluate(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

void writeEvaluationResult()

Output the evaluation result to standard output

writeEvaluationResult

void writeEvaluationResult(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

void writeEvaluationResultOfEachQuery(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

void writeEvaluationResult(String resultEvalFilename)

Output the evaluation result to the specific file.

Parameters:

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