jcolibri.extensions.maintenance_evaluation
Class DetailedEvaluationReport

java.lang.Object
  extended by jcolibri.evaluation.EvaluationReport
      extended by jcolibri.extensions.maintenance_evaluation.DetailedEvaluationReport

public class DetailedEvaluationReport
extends EvaluationReport

This class stores the result of each query in an evaluation. It is configured and filled by an Evaluator.

Author:
Lisa Cummins.

Field Summary
protected  java.util.HashMap<java.lang.String,java.util.List<QueryResult>> queryData
          Stores the query series info
 
Fields inherited from class jcolibri.evaluation.EvaluationReport
data, other
 
Constructor Summary
DetailedEvaluationReport()
          Creates a new report.
 
Method Summary
 void addDataToSeries(java.lang.String label, CBRQuery query, java.lang.Double value)
          Adds the given query and value to the series labelled by the given label.
 java.lang.Double getAverageOfDataSeries(java.lang.String label)
          Returns the average of the data series with the given label.
 java.lang.Double getAverageOfQueryDataSeries(java.lang.String label)
          Returns the average of the query data series with the given label.
 java.util.List<QueryResult> getQuerySeries(java.lang.String label)
          Returns the evaluation info identified by the given label.
 java.lang.String[] getQuerySeriesLabels()
          Returns the names of the contained evaluation series.
 void printDetailedEvaluationReport(java.lang.String filename)
          Prints the report to the given file.
 void removeDataSeries(java.lang.String label)
          Removes a data serie.
 void removeOtherData(java.lang.String label)
          Removes some data.
 void setSeries(java.lang.String label, java.util.List<QueryResult> queryEvaluations)
          Sets the given evaluation series to be the series identified by the given label.
 java.lang.String toString()
          Returns the String representation of this report.
 
Methods inherited from class jcolibri.evaluation.EvaluationReport
addDataToSeries, checkData, getNumberOfCycles, getOtherData, getOtherLabels, getSeries, getSeriesLabels, getTimePerCycle, getTotalTime, putOtherData, setNumberOfCycles, setSeries, setTotalTime
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

queryData

protected java.util.HashMap<java.lang.String,java.util.List<QueryResult>> queryData
Stores the query series info

Constructor Detail

DetailedEvaluationReport

public DetailedEvaluationReport()
Creates a new report.

Method Detail

getQuerySeries

public java.util.List<QueryResult> getQuerySeries(java.lang.String label)
Returns the evaluation info identified by the given label.

Parameters:
label - identifies the evaluation series.
Returns:
the evaluation info identified by the given label.

setSeries

public void setSeries(java.lang.String label,
                      java.util.List<QueryResult> queryEvaluations)
Sets the given evaluation series to be the series identified by the given label.

Parameters:
label - identifier of the evaluation series.
queryEvaluations - the evaluation series.

addDataToSeries

public void addDataToSeries(java.lang.String label,
                            CBRQuery query,
                            java.lang.Double value)
Adds the given query and value to the series labelled by the given label.

Parameters:
label - the label whose series the query and value are being added to.
query - the query.
value - the query's value.

getQuerySeriesLabels

public java.lang.String[] getQuerySeriesLabels()
Returns the names of the contained evaluation series.

Returns:
the names of the contained evaluation series.

printDetailedEvaluationReport

public void printDetailedEvaluationReport(java.lang.String filename)
Prints the report to the given file.

Parameters:
filename - the file to print the report to.

removeDataSeries

public void removeDataSeries(java.lang.String label)
Removes a data serie.

Parameters:
label - the label of the data series to remove.

removeOtherData

public void removeOtherData(java.lang.String label)
Removes some data.

Parameters:
label - the label of the data to remove.

getAverageOfDataSeries

public java.lang.Double getAverageOfDataSeries(java.lang.String label)
Returns the average of the data series with the given label. If the label given is not the label of any data series, null will be returned and an error message will be printed.

Parameters:
label - the label of the data series.
Returns:
the average of the given data series.

getAverageOfQueryDataSeries

public java.lang.Double getAverageOfQueryDataSeries(java.lang.String label)
Returns the average of the query data series with the given label. If the label given is not the label of any data series, null will be returned and an error message will be printed.

Parameters:
label - the label of the query data series.
Returns:
the average of the given query data series.

toString

public java.lang.String toString()
Returns the String representation of this report.

Overrides:
toString in class EvaluationReport
Returns:
the String representation of this report.

GAIA - Group for Artificial Intelligence Applications
http://gaia.fdi.ucm.es