org.openimaj.experiment.evaluation.retrieval.analysers

Class TRECResult

java.lang.Object

org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult

All Implemented Interfaces:

AnalysisResult

public class TRECResult
extends Object
implements AnalysisResult

An AnalysisResult wrapping the output of the trec_eval tool.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
TRECResult(String trecOutput) Construct with the given output from trec_eval

Method Summary

Modifier and Type	Method and Description
String	getDetailReport() Get a String detailing the result.
net.sf.jasperreports.engine.JasperPrint	getDetailReport(String title, String info) Get a JasperPrint detailing the result.
String	getSummaryReport() Get a String summarising the result.
net.sf.jasperreports.engine.JasperPrint	getSummaryReport(String title, String info) Get a JasperPrint summarising the result.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TRECResult

public TRECResult(String trecOutput)

Construct with the given output from trec_eval

Parameters:

trecOutput - the output

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getSummaryReport

public net.sf.jasperreports.engine.JasperPrint getSummaryReport(String title,
                                                                String info)
                                                         throws net.sf.jasperreports.engine.JRException

Description copied from interface: AnalysisResult

Get a JasperPrint summarising the result.

Specified by:

getSummaryReport in interface AnalysisResult

Parameters:

title - a title to add to the report

info - information to print at the beginning of the report

Returns:

a String summarising the result

Throws:

net.sf.jasperreports.engine.JRException

getDetailReport

public net.sf.jasperreports.engine.JasperPrint getDetailReport(String title,
                                                               String info)
                                                        throws net.sf.jasperreports.engine.JRException

Description copied from interface: AnalysisResult

Get a JasperPrint detailing the result.

Specified by:

getDetailReport in interface AnalysisResult

Parameters:

title - a title to add to the report

info - information to print at the beginning of the report

Returns:

a JasperPrint detailing the result.

Throws:

net.sf.jasperreports.engine.JRException

getSummaryReport

public String getSummaryReport()

Description copied from interface: AnalysisResult

Get a String summarising the result.

Specified by:

getSummaryReport in interface AnalysisResult

Returns:

a String summarising the result

getDetailReport

public String getDetailReport()

Description copied from interface: AnalysisResult

Get a String detailing the result.

Specified by:

getDetailReport in interface AnalysisResult

Returns:

a String detailing the result