001package es.ucm.fdi.gaia.jcolibri.extensions.maintenance_evaluation;
002
003import org.apache.logging.log4j.LogManager;
004
005import es.ucm.fdi.gaia.jcolibri.cbrcore.CBRQuery;
006import es.ucm.fdi.gaia.jcolibri.evaluation.EvaluationReport;
007import es.ucm.fdi.gaia.jcolibri.method.maintenance.QueryResult;
008
009import java.io.BufferedWriter;
010import java.io.FileWriter;
011import java.io.IOException;
012import java.io.PrintWriter;
013import java.util.HashMap;
014import java.util.LinkedList;
015import java.util.List;
016import java.util.Set;
017import java.util.Vector;
018
019
020/**
021 * This class stores the result of each query in an evaluation. 
022 * It is configured and filled by an Evaluator.
023 * 
024 * @author Lisa Cummins.
025 */
026public class DetailedEvaluationReport extends EvaluationReport
027{
028    /** Stores the query series info */
029    protected HashMap<String, List<QueryResult>> queryData;
030
031    /**
032     * Creates a new report.
033     */
034    public DetailedEvaluationReport()
035    {   super();
036        queryData = new HashMap<String, List<QueryResult>>();
037    }
038        
039    /**
040     * Returns the evaluation info identified by the given label.
041     * @param label identifies the evaluation series.
042     * @return the evaluation info identified by the given label.
043     */
044    public List<QueryResult> getQuerySeries(String label)
045    {   return queryData.get(label);
046    }
047    
048    /**
049     * Sets the given evaluation series to be the series identified by the 
050     * given label.
051     * @param label identifier of the evaluation series.
052     * @param queryEvaluations the evaluation series. 
053     */
054    public void setSeries(String label, List<QueryResult> queryEvaluations)
055    {   queryData.put(label, queryEvaluations);
056    }
057    
058    /**
059     * Adds the given query and value to the series labelled by the given label.
060     * @param label the label whose series the query and value are being added to.
061     * @param query the query.
062     * @param value the query's value.
063     */
064    public void addDataToSeries(String label, CBRQuery query, Double value)
065    {   List<QueryResult> queries = queryData.get(label);
066        if(queries == null)
067        {       queries = new LinkedList<QueryResult>();
068        }
069        queries.add(new QueryResult(query, value));
070        queryData.put(label, queries);
071    }
072    
073    /** 
074     * Returns the names of the contained evaluation series.
075     * @return the names of the contained evaluation series.
076     */
077    public String[] getQuerySeriesLabels()
078    {   Set<String> set = queryData.keySet();
079        String[] res = new String[set.size()];
080        int i=0;
081        for( String e : set)
082            res[i++] = e;
083        return res;
084    }
085
086    /**
087     * Prints the report to the given file.
088     * @param filename the file to print the report to.
089     */
090    public void printDetailedEvaluationReport(String filename)
091    {   PrintWriter pw = null;
092                try
093                {       pw = new PrintWriter(new BufferedWriter(new FileWriter(filename, true)));
094                
095                        pw.println("Results:");
096                        String[] seriesLabels = getSeriesLabels();
097                        String[] querySeriesLabels = getQuerySeriesLabels();
098                        String[] otherLabels = getOtherLabels();
099                        
100                        for(int i=0; i<seriesLabels.length; i++)
101                        {       pw.println(seriesLabels[i]+ ":");
102                                Vector<Double> results = getSeries(seriesLabels[i]);
103                                String series = "";
104                                for(Double result: results)
105                                    series += result + ","; 
106                                pw.println(series.substring(0, series.length()-2));
107                                pw.println("Average: " + getAverageOfDataSeries(seriesLabels[i]));
108                                pw.println();
109                        }
110                        pw.println();
111        
112                        for(int i=0; i<querySeriesLabels.length; i++)
113                        {       pw.println(querySeriesLabels[i]+ ":");
114                                List<QueryResult> results = getQuerySeries(querySeriesLabels[i]);
115                                for(QueryResult qResult: results)
116                                    pw.println(qResult.getCase().getID() + ": " + qResult.getResult()); 
117                                pw.println("Average: " + getAverageOfQueryDataSeries(querySeriesLabels[i]));
118                                pw.println();
119                        }
120                        pw.println();
121                        
122                        for(int i=0; i<otherLabels.length; i++)
123                {       pw.println(otherLabels[i]+ ": " + getOtherData(otherLabels[i]));
124                        pw.println();
125                }
126            } catch(IOException ioe) {
127        }
128        finally 
129        {       if(pw != null)
130                        pw.close();
131        }
132    }
133        
134    /**
135     * Removes a data serie.
136     * @param label the label of the data series to remove.
137     */
138    public void removeDataSeries(String label)
139    {   data.remove(label);
140    }
141        
142    /**
143     * Removes some data.
144     * @param label the label of the data to remove.
145     */
146    public void removeOtherData(String label)
147    {   other.remove(label);
148    }
149
150    /**
151     * Returns the average of the data series with the given label. If
152     * the label given is not the label of any data series, null will
153     * be returned and an error message will be printed.
154     * @param label the label of the data series.
155     * @return the average of the given data series.
156     */
157    public Double getAverageOfDataSeries(String label)
158    {   Vector<Double> v = data.get(label);
159        if(v == null)
160        {       LogManager.getLogger().error("Data series by this label does not exist");
161                return null;
162        }
163        if(v.size() == 0)
164        {       return 0.0;
165        }
166        double total = 0.0;
167        for(Double value: v)
168        {       total += value;             
169        }
170        return total / v.size();
171    }
172        
173    /**
174     * Returns the average of the query data series with the given label. If
175     * the label given is not the label of any data series, null will
176     * be returned and an error message will be printed.
177     * @param label the label of the query data series.
178     * @return the average of the given query data series.
179     */
180    public Double getAverageOfQueryDataSeries(String label)
181    {   List<QueryResult> results = queryData.get(label);
182        if(results == null)
183        {       LogManager.getLogger().error("Data series by this label does not exist");
184                return null;
185        }
186        if(results.size() == 0)
187        {       return 0.0;
188        }
189        double total = 0.0;
190        for(QueryResult result: results)
191        {       total += result.getResult();                
192        }
193        return total / results.size();
194    }
195        
196    /**
197     * Returns the String representation of this report.
198     * @return the String representation of this report. 
199     */
200    public String toString()
201    {
202        StringBuffer s = new StringBuffer();
203        s.append("Series:\n");
204        String[] series = this.getSeriesLabels();
205        for(int i=0; i<series.length; i++)
206        {       s.append("  "+series[i]+": \n    ");
207                Vector<Double> v = this.getSeries(series[i]);
208                for(Double d: v)
209                        s.append(d+",");
210                s.append("\n");
211                s.append("  Average: " + getAverageOfDataSeries(series[i]) + "\n\n");
212        }
213        
214        s.append("\nOther data:\n");
215        String[] other = this.getOtherLabels();
216        for(int i=0; i<other.length; i++)
217        {
218                s.append("  "+other[i]+": "+ this.getOtherData(other[i])+"\n");
219        }
220        
221        s.append("\nNumber of Cycles: "+ this.getNumberOfCycles());
222        s.append("\nTime per Cycle:   "+ this.getTimePerCycle()+" ms");
223        s.append("\nTotal time:       "+ this.getTotalTime()+" ms");
224        
225        return s.toString();
226    }
227}