org.terrier.evaluation

Class TrecEvalEvaluation

java.lang.Object

org.terrier.evaluation.TrecEvalEvaluation

All Implemented Interfaces:

Evaluation

public class TrecEvalEvaluation
extends Object
implements Evaluation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrecEvalEvaluation.Command

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected String[][]	output

Constructor Summary

Constructors

Constructor and Description
TrecEvalEvaluation(String qrels)
TrecEvalEvaluation(String[] qrels)

Method Summary

Modifier and Type	Method and Description
void	evaluate(String resultFilename) Evaluates the given result file for the given qrels file.
static boolean	isPlatformSupported()
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.

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

output

protected String[][] output

Constructor Detail

TrecEvalEvaluation

public TrecEvalEvaluation(String[] qrels)

TrecEvalEvaluation

public TrecEvalEvaluation(String qrels)

Method Detail

evaluate

public 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 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 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.

isPlatformSupported

public static boolean isPlatformSupported()