Class TrecJudge
- java.lang.Object
-
- org.apache.lucene.benchmark.quality.trec.TrecJudge
-
-
Constructor Summary
Constructors Constructor Description TrecJudge(BufferedReader reader)Constructor from a reader.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanisRelevant(String docName, QualityQuery query)Judge if documentdocNameis relevant for the given quality query.intmaxRecall(QualityQuery query)Return the maximal recall for the input quality query.booleanvalidateData(QualityQuery[] qq, PrintWriter logger)Validate that queries and this Judge match each other.
-
-
-
Constructor Detail
-
TrecJudge
public TrecJudge(BufferedReader reader) throws IOException
Constructor from a reader.Expected input format:
qnum 0 doc-name is-relevantTwo sample lines:19 0 doc303 1 19 0 doc7295 0- Parameters:
reader- where judgements are read from.- Throws:
IOException- If there is a low-level I/O error.
-
-
Method Detail
-
isRelevant
public boolean isRelevant(String docName, QualityQuery query)
Description copied from interface:JudgeJudge if documentdocNameis relevant for the given quality query.- Specified by:
isRelevantin interfaceJudge- Parameters:
docName- name of doc tested for relevancy.query- tested quality query.- Returns:
- true if relevant, false if not.
-
validateData
public boolean validateData(QualityQuery[] qq, PrintWriter logger)
Description copied from interface:JudgeValidate that queries and this Judge match each other. To be perfectly valid, this Judge must have some data for each and every input quality query, and must not have any data on any other quality query. Note: the quality benchmark run would not fail in case of imperfect validity, just a warning message would be logged.- Specified by:
validateDatain interfaceJudge- Parameters:
qq- quality queries to be validated.logger- if not null, validation issues are logged.- Returns:
- true if perfectly valid, false if not.
-
maxRecall
public int maxRecall(QualityQuery query)
Description copied from interface:JudgeReturn the maximal recall for the input quality query. It is the number of relevant docs this Judge "knows" for the query.
-
-