teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5994:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5994:  * 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;
gernotbelger@9312: import java.text.DateFormat;
ingo@418: import java.text.NumberFormat;
ingo@391: import java.util.ArrayList;
gernotbelger@9312: import java.util.Date;
raimund@2178: import java.util.HashMap;
gernotbelger@9312: import java.util.List;
raimund@2178: import java.util.Locale;
gernotbelger@9312: import java.util.Map;
ingo@391: 
ingo@391: import org.apache.log4j.Logger;
gernotbelger@9312: import org.dive4elements.artifacts.CallMeta;
gernotbelger@9312: import org.dive4elements.artifacts.common.utils.Config;
gernotbelger@9312: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@9312: import org.dive4elements.river.artifacts.access.RangeAccess;
gernotbelger@9312: import org.dive4elements.river.artifacts.access.RiverAccess;
gernotbelger@9312: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@9312: import org.dive4elements.river.artifacts.model.WKmsJRDataSource;
gernotbelger@9312: import org.dive4elements.river.artifacts.model.WQDay;
gernotbelger@9312: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@9312: import org.dive4elements.river.utils.Formatter;
gernotbelger@9312: import org.dive4elements.river.utils.RiverUtils;
ingo@391: 
ingo@391: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@9312: import net.sf.jasperreports.engine.JRException;
raimund@2178: import net.sf.jasperreports.engine.JasperExportManager;
raimund@2178: import net.sf.jasperreports.engine.JasperFillManager;
raimund@2178: import net.sf.jasperreports.engine.JasperPrint;
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: 
teichmann@8202:     /** The log used in this exporter. */
teichmann@8202:     private static Logger log = Logger.getLogger(DurationCurveExporter.class);
ingo@391: 
gernotbelger@9312:     public static final String CSV_DURATION_HEADER = "export.duration.curve.csv.header.duration";
ingo@416: 
gernotbelger@9312:     public static final String CSV_W_HEADER = "export.duration.curve.csv.header.w";
ingo@416: 
gernotbelger@9312:     public static final String CSV_Q_HEADER = "common.export.csv.header.q";
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: 
teichmann@7077:     public DurationCurveExporter() {
gernotbelger@9312:         this.data = new ArrayList<>();
ingo@391:     }
ingo@391: 
sascha@701:     @Override
sascha@701:     protected void addData(Object d) {
sascha@709:         if (d instanceof CalculationResult) {
gernotbelger@9312:             d = ((CalculationResult) d).getData();
sascha@709:             if (d instanceof WQDay) {
gernotbelger@9312:                 this.data.add((WQDay) d);
sascha@709:             }
sascha@701:         }
ingo@391:     }
ingo@391: 
gernotbelger@9312:     @Override
gernotbelger@9312:     protected void writeCSVData(final CSVWriter writer) {
teichmann@8202:         log.info("DurationCurveExporter.writeData");
ingo@391: 
ingo@416:         writeCSVHeader(writer);
ingo@416: 
gernotbelger@9312:         for (final WQDay wqday : this.data) {
ingo@391:             wQDay2CSV(writer, wqday);
ingo@391:         }
ingo@391:     }
ingo@391: 
gernotbelger@9312:     protected void writeCSVHeader(final CSVWriter writer) {
teichmann@8202:         log.info("DurationCurveExporter.writeCSVHeader");
ingo@416: 
gernotbelger@9312:         final String unit = new RiverAccess((D4EArtifact) this.master).getRiver().getWstUnit().getName();
tom@8248: 
gernotbelger@9312:         writer.writeNext(new String[] { msg(CSV_W_HEADER, new Object[] { unit }), msg(CSV_Q_HEADER), msg(CSV_DURATION_HEADER) });
ingo@416:     }
ingo@416: 
gernotbelger@9312:     protected void wQDay2CSV(final CSVWriter writer, final WQDay wqday) {
teichmann@8202:         log.debug("DurationCurveExporter.wQDay2CSV");
ingo@391: 
gernotbelger@9312:         final int size = wqday.size();
ingo@391: 
gernotbelger@9312:         final NumberFormat wf = getWFormatter();
gernotbelger@9312:         final NumberFormat qf = getQFormatter();
gernotbelger@9312:         final NumberFormat df = getDFormatter();
ingo@418: 
ingo@1689:         if (wqday.isIncreasing()) {
gernotbelger@9312:             for (int i = size - 1; i >= 0; i--) {
gernotbelger@9312:                 writer.writeNext(new String[] { wf.format(wqday.getW(i)), qf.format(wqday.getQ(i)), df.format(wqday.getDay(i)) });
ingo@1689:             }
gernotbelger@9312:         } else {
gernotbelger@9312:             for (int i = 0; i < size; i++) {
gernotbelger@9312:                 writer.writeNext(new String[] { wf.format(wqday.getW(i)), qf.format(wqday.getQ(i)), df.format(wqday.getDay(i)) });
ingo@1689:             }
ingo@391:         }
ingo@391:     }
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() {
gernotbelger@9312:         return Formatter.getDurationW(this.context);
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() {
gernotbelger@9312:         return Formatter.getDurationQ(this.context);
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() {
gernotbelger@9312:         return Formatter.getDurationD(this.context);
ingo@418:     }
raimund@2176: 
raimund@2176:     @Override
gernotbelger@9312:     protected void writePDF(final OutputStream out) {
gernotbelger@9312:         final WKmsJRDataSource source = createJRData();
raimund@2185: 
gernotbelger@9312:         final String jasperFile = Resources.getMsg(this.context.getMeta(), JASPER_FILE, "/jasper/duration_en.jasper");
gernotbelger@9312:         final String confPath = Config.getConfigDirectory().toString();
raimund@2185: 
gernotbelger@9312:         final Map parameters = new HashMap();
raimund@2178:         parameters.put("ReportTitle", "Exported Data");
raimund@2178:         try {
gernotbelger@9312:             final JasperPrint print = JasperFillManager.fillReport(confPath + jasperFile, parameters, source);
raimund@2178:             JasperExportManager.exportReportToPdfStream(print, out);
raimund@2178:         }
gernotbelger@9312:         catch (final JRException je) {
teichmann@8202:             log.warn("Error generating PDF Report!");
raimund@2178:             je.printStackTrace();
raimund@2178:         }
raimund@2178:     }
raimund@2176: 
raimund@2178:     protected WKmsJRDataSource createJRData() {
gernotbelger@9312:         final WKmsJRDataSource source = new WKmsJRDataSource();
raimund@2178: 
raimund@2178:         addMetaData(source);
gernotbelger@9312:         for (final WQDay wqday : this.data) {
raimund@2178:             addWQDayData(source, wqday);
raimund@2178:         }
raimund@2178: 
raimund@2178:         return source;
raimund@2178:     }
raimund@2178: 
gernotbelger@9312:     protected void addMetaData(final WKmsJRDataSource source) {
gernotbelger@9312:         final CallMeta meta = this.context.getMeta();
raimund@2178: 
gernotbelger@9312:         final D4EArtifact flys = (D4EArtifact) this.master;
raimund@2178: 
gernotbelger@9312:         source.addMetaData("river", RiverUtils.getRivername(flys));
raimund@2178: 
gernotbelger@9312:         final Locale locale = Resources.getLocale(meta);
gernotbelger@9312:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
raimund@2178: 
raimund@2178:         source.addMetaData("date", df.format(new Date()));
raimund@2178: 
gernotbelger@9312:         final RangeAccess rangeAccess = new RangeAccess(flys);
gernotbelger@9312:         final double[] kms = rangeAccess.getKmRange();
raimund@2178:         source.addMetaData("range", String.valueOf(kms[0]));
raimund@2178: 
gernotbelger@9312:         source.addMetaData("calculation", Resources.getMsg(locale, PDF_HEADER_MODE, "Duration"));
raimund@2178:     }
raimund@2178: 
gernotbelger@9312:     protected void addWQDayData(final WKmsJRDataSource source, final WQDay wqday) {
gernotbelger@9312:         final int size = wqday.size();
raimund@2178: 
gernotbelger@9312:         final NumberFormat wf = getWFormatter();
gernotbelger@9312:         final NumberFormat qf = getQFormatter();
gernotbelger@9312:         final NumberFormat df = getDFormatter();
raimund@2178: 
raimund@2178:         if (wqday.isIncreasing()) {
gernotbelger@9312:             for (int i = size - 1; i >= 0; i--) {
gernotbelger@9312:                 source.addData(new String[] { "", wf.format(wqday.getW(i)), qf.format(wqday.getQ(i)), "", "", "", df.format(wqday.getDay(i)) });
raimund@2178:             }
gernotbelger@9312:         } else {
gernotbelger@9312:             for (int i = 0; i < size; i++) {
gernotbelger@9312:                 source.addData(new String[] { "", wf.format(wqday.getW(i)), qf.format(wqday.getQ(i)), "", "", "", df.format(wqday.getDay(i)) });
raimund@2178:             }
raimund@2178:         }
raimund@2178:     }
ingo@391: }
sascha@3083: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :