teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5863:  * This file is Free Software under the GNU AGPL (>=v3) 
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5863:  * documentation coming with Dive4Elements River for details. 
teichmann@5863:  */
teichmann@5863: 
teichmann@5831: package org.dive4elements.river.exports;
ingo@391: 
ingo@391: import java.io.OutputStream;
ingo@418: import java.text.NumberFormat;
ingo@391: import java.util.ArrayList;
ingo@391: import java.util.List;
raimund@2178: import java.util.Map;
raimund@2178: import java.util.HashMap;
raimund@2178: import java.util.Date;
raimund@2178: import java.text.DateFormat;
raimund@2178: import java.util.Locale;
ingo@391: 
ingo@391: import org.w3c.dom.Document;
ingo@391: 
ingo@391: import org.apache.log4j.Logger;
ingo@391: 
ingo@391: import au.com.bytecode.opencsv.CSVWriter;
ingo@391: 
raimund@2178: import net.sf.jasperreports.engine.JasperExportManager;
raimund@2178: import net.sf.jasperreports.engine.JasperFillManager;
raimund@2178: import net.sf.jasperreports.engine.JasperPrint;
raimund@2178: import net.sf.jasperreports.engine.JRException;
raimund@2178: 
teichmann@5831: import org.dive4elements.artifacts.CallContext;
teichmann@5831: import org.dive4elements.artifacts.CallMeta;
teichmann@5831: import org.dive4elements.artifacts.common.utils.Config;
ingo@391: 
teichmann@5831: import org.dive4elements.river.artifacts.FLYSArtifact;
sascha@709: 
teichmann@5831: import org.dive4elements.river.artifacts.access.RangeAccess;
teichmann@5831: import org.dive4elements.river.artifacts.model.WQDay;
teichmann@5831: import org.dive4elements.river.artifacts.model.CalculationResult;
teichmann@5831: import org.dive4elements.river.artifacts.model.WKmsJRDataSource;
teichmann@5831: import org.dive4elements.river.artifacts.resources.Resources;
teichmann@5831: 
teichmann@5865: import org.dive4elements.river.utils.RiverUtils;
teichmann@5831: import org.dive4elements.river.utils.Formatter;
ingo@391: 
ingo@391: 
ingo@391: /**
ingo@391:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@391:  */
ingo@391: public class DurationCurveExporter extends AbstractExporter {
ingo@391: 
felix@1160:     /** The logger used in this exporter. */
sascha@3778:     private static Logger logger = Logger.getLogger(DurationCurveExporter.class);
ingo@391: 
ingo@391: 
ingo@416:     public static final String CSV_DURATION_HEADER =
ingo@416:         "export.duration.curve.csv.header.duration";
ingo@416: 
ingo@416:     public static final String CSV_W_HEADER =
ingo@416:         "export.duration.curve.csv.header.w";
ingo@416: 
ingo@416:     public static final String CSV_Q_HEADER =
ingo@416:         "export.duration.curve.csv.header.q";
ingo@416: 
ingo@416:     public static final String DEFAULT_CSV_DURATION_HEADER = "D [Tagen]";
ingo@416:     public static final String DEFAULT_CSV_W_HEADER  = "W [NN + m]";
sascha@664:     public static final String DEFAULT_CSV_Q_HEADER  = "Q [m\u00b3/s]";
ingo@416: 
raimund@2178:     public static final String PDF_HEADER_MODE = "export.duration.pdf.mode";
raimund@2185:     public static final String JASPER_FILE = "export.duration.pdf.file";
ingo@416: 
felix@1160:     /** The storage that contains all WQKms objects for the different facets. */
ingo@391:     protected List<WQDay> data;
ingo@391: 
ingo@391: 
ingo@391:     public void init(Document request, OutputStream out, CallContext context) {
ingo@391:         logger.debug("DurationCurveExporter.init");
ingo@391: 
ingo@391:         super.init(request, out, context);
ingo@391: 
ingo@391:         this.data = new ArrayList<WQDay>();
ingo@391:     }
ingo@391: 
ingo@391: 
sascha@701:     @Override
sascha@701:     protected void addData(Object d) {
sascha@709:         if (d instanceof CalculationResult) {
sascha@709:             d = ((CalculationResult)d).getData();
sascha@709:             if (d instanceof WQDay) {
sascha@709:                 data.add((WQDay)d);
sascha@709:             }
sascha@701:         }
ingo@391:     }
ingo@391: 
ingo@391: 
ingo@391:     protected void writeCSVData(CSVWriter writer) {
ingo@391:         logger.info("DurationCurveExporter.writeData");
ingo@391: 
ingo@416:         writeCSVHeader(writer);
ingo@416: 
ingo@391:         for (WQDay wqday: data) {
ingo@391:             wQDay2CSV(writer, wqday);
ingo@391:         }
ingo@391:     }
ingo@391: 
ingo@391: 
ingo@416:     protected void writeCSVHeader(CSVWriter writer) {
ingo@416:         logger.info("DurationCurveExporter.writeCSVHeader");
ingo@416: 
ingo@416:         writer.writeNext(new String[] {
ingo@416:             msg(CSV_W_HEADER, DEFAULT_CSV_W_HEADER),
ingo@416:             msg(CSV_Q_HEADER, DEFAULT_CSV_Q_HEADER),
ingo@416:             msg(CSV_DURATION_HEADER, DEFAULT_CSV_DURATION_HEADER)
ingo@416:         });
ingo@416:     }
ingo@416: 
ingo@416: 
ingo@391:     protected void wQDay2CSV(CSVWriter writer, WQDay wqday) {
ingo@391:         logger.debug("DurationCurveExporter.wQDay2CSV");
ingo@391: 
ingo@391:         int size = wqday.size();
ingo@391: 
ingo@418:         NumberFormat wf  = getWFormatter();
ingo@418:         NumberFormat qf  = getQFormatter();
ingo@418:         NumberFormat df  = getDFormatter();
ingo@418: 
ingo@1689:         if (wqday.isIncreasing()) {
ingo@1689:             for (int i = size-1; i >= 0; i --) {
ingo@1689:                 writer.writeNext(new String[] {
ingo@1689:                     wf.format(wqday.getW(i)),
ingo@1689:                     qf.format(wqday.getQ(i)),
ingo@1689:                     df.format(wqday.getDay(i))
ingo@1689:                 });
ingo@1689:             }
ingo@1689:         }
ingo@1689:         else {
ingo@1689:             for (int i = 0; i < size; i ++) {
ingo@1689:                 writer.writeNext(new String[] {
ingo@1689:                     wf.format(wqday.getW(i)),
ingo@1689:                     qf.format(wqday.getQ(i)),
ingo@1689:                     df.format(wqday.getDay(i))
ingo@1689:                 });
ingo@1689:             }
ingo@391:         }
ingo@391:     }
ingo@418: 
ingo@418: 
ingo@418:     /**
ingo@418:      * Returns the number formatter for W values.
ingo@418:      *
ingo@418:      * @return the number formatter for W values.
ingo@418:      */
felix@2284:     @Override
ingo@418:     protected NumberFormat getWFormatter() {
ingo@445:         return Formatter.getDurationW(context);
ingo@418:     }
ingo@418: 
ingo@418: 
ingo@418:     /**
ingo@418:      * Returns the number formatter for Q values.
ingo@418:      *
ingo@418:      * @return the number formatter for Q values.
ingo@418:      */
felix@2284:     @Override
ingo@418:     protected NumberFormat getQFormatter() {
ingo@445:         return Formatter.getDurationQ(context);
ingo@418:     }
ingo@418: 
ingo@418: 
ingo@418:     /**
ingo@418:      * Returns the number formatter for duration values.
ingo@418:      *
ingo@418:      * @return the number formatter for duration values.
ingo@418:      */
ingo@418:     protected NumberFormat getDFormatter() {
ingo@445:         return Formatter.getDurationD(context);
ingo@418:     }
raimund@2176: 
raimund@2176: 
raimund@2176:     @Override
raimund@2178:     protected void writePDF(OutputStream out) {
raimund@2178:         WKmsJRDataSource source = createJRData();
raimund@2185: 
raimund@2185:         String jasperFile = Resources.getMsg(
raimund@2185:                                 context.getMeta(),
raimund@2185:                                 JASPER_FILE,
raimund@2185:                                 "/jasper/duration_en.jasper");
raimund@2185:         String confPath = Config.getConfigDirectory().toString();
raimund@2185: 
raimund@2178:         Map parameters = new HashMap();
raimund@2178:         parameters.put("ReportTitle", "Exported Data");
raimund@2178:         try {
raimund@2178:             JasperPrint print = JasperFillManager.fillReport(
raimund@2185:                 confPath + jasperFile,
raimund@2178:                 parameters,
raimund@2178:                 source);
raimund@2178:             JasperExportManager.exportReportToPdfStream(print, out);
raimund@2178:         }
raimund@2178:         catch(JRException je) {
raimund@2178:             logger.warn("Error generating PDF Report!");
raimund@2178:             je.printStackTrace();
raimund@2178:         }
raimund@2178:     }
raimund@2176: 
raimund@2178:     protected WKmsJRDataSource createJRData() {
raimund@2178:         WKmsJRDataSource source = new WKmsJRDataSource();
raimund@2178: 
raimund@2178:         addMetaData(source);
raimund@2178:         for (WQDay wqday: data) {
raimund@2178:             addWQDayData(source, wqday);
raimund@2178:         }
raimund@2178: 
raimund@2178:         return source;
raimund@2178:     }
raimund@2178: 
raimund@2178: 
raimund@2178:     protected void addMetaData(WKmsJRDataSource source) {
raimund@2178:         CallMeta meta = context.getMeta();
raimund@2178: 
raimund@2178:         FLYSArtifact flys = (FLYSArtifact) master;
raimund@2178: 
teichmann@5865:         source.addMetaData ("river", RiverUtils.getRivername(flys));
raimund@2178: 
raimund@2178:         Locale locale = Resources.getLocale(meta);
raimund@2178:         DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
raimund@2178: 
raimund@2178:         source.addMetaData("date", df.format(new Date()));
raimund@2178: 
felix@4858:         RangeAccess rangeAccess = new RangeAccess(flys, null);
felix@4858:         double[] kms = rangeAccess.getKmRange();
raimund@2178:         source.addMetaData("range", String.valueOf(kms[0]));
raimund@2178: 
raimund@2178:         source.addMetaData("calculation", Resources.getMsg(
raimund@2178:                                             locale,
raimund@2178:                                             PDF_HEADER_MODE,
raimund@2178:                                             "Duration"));
raimund@2178:     }
raimund@2178: 
raimund@2178:     protected void addWQDayData(WKmsJRDataSource source, WQDay wqday) {
raimund@2178:         int size = wqday.size();
raimund@2178: 
raimund@2178:         NumberFormat wf  = getWFormatter();
raimund@2178:         NumberFormat qf  = getQFormatter();
raimund@2178:         NumberFormat df  = getDFormatter();
raimund@2178: 
raimund@2178:         if (wqday.isIncreasing()) {
raimund@2178:             for (int i = size-1; i >= 0; i --) {
raimund@2178:                 source.addData(new String[] {
raimund@2178:                     "",
raimund@2178:                     wf.format(wqday.getW(i)),
raimund@2178:                     qf.format(wqday.getQ(i)),
raimund@2178:                     "", "", "",
raimund@2178:                     df.format(wqday.getDay(i))
raimund@2178:                 });
raimund@2178:             }
raimund@2178:         }
raimund@2178:         else {
raimund@2178:             for (int i = 0; i < size; i ++) {
raimund@2178:                 source.addData(new String[] {
raimund@2178:                     "",
raimund@2178:                     wf.format(wqday.getW(i)),
raimund@2178:                     qf.format(wqday.getQ(i)),
raimund@2178:                     "", "", "",
raimund@2178:                     df.format(wqday.getDay(i))
raimund@2178:                 });
raimund@2178:             }
raimund@2178:         }
raimund@2178:     }
ingo@391: }
sascha@3083: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :