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@392: 
ingo@392: import java.io.OutputStream;
gernotbelger@9312: import java.text.DateFormat;
ingo@418: import java.text.NumberFormat;
ingo@392: import java.util.ArrayList;
sascha@701: import java.util.Arrays;
gernotbelger@9312: import java.util.Date;
raimund@2177: import java.util.HashMap;
gernotbelger@9312: import java.util.List;
raimund@2177: import java.util.Locale;
gernotbelger@9312: import java.util.Map;
ingo@392: 
ingo@392: 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.model.CalculationResult;
gernotbelger@9312: import org.dive4elements.river.artifacts.model.WKmsJRDataSource;
gernotbelger@9312: import org.dive4elements.river.artifacts.model.WQ;
gernotbelger@9312: import org.dive4elements.river.artifacts.model.WQKms;
gernotbelger@9312: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@9312: import org.dive4elements.river.model.Gauge;
gernotbelger@9312: import org.dive4elements.river.model.River;
gernotbelger@9312: import org.dive4elements.river.utils.Formatter;
gernotbelger@9312: import org.dive4elements.river.utils.RiverUtils;
ingo@392: 
ingo@392: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@9312: import net.sf.jasperreports.engine.JRException;
raimund@2177: import net.sf.jasperreports.engine.JasperExportManager;
raimund@2177: import net.sf.jasperreports.engine.JasperFillManager;
raimund@2177: import net.sf.jasperreports.engine.JasperPrint;
ingo@392: 
ingo@392: /**
ingo@392:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@392:  */
ingo@392: public class ComputedDischargeCurveExporter extends AbstractExporter {
ingo@392: 
gernotbelger@9312:     /** The log used in this exporter. */
gernotbelger@9312:     private static Logger log = Logger.getLogger(ComputedDischargeCurveExporter.class);
ingo@416: 
gernotbelger@9312:     public static final String CSV_W_HEADER = "export.computed.discharge.curve.csv.header.w";
ingo@416: 
gernotbelger@9312:     public static final String CSV_Q_HEADER = "common.export.csv.header.q";
gernotbelger@9312: 
gernotbelger@9312:     public static final String DEFAULT_CSV_W_HEADER = "W [NN + m]";
gernotbelger@9312:     public static final String DEFAULT_CSV_Q_HEADER = "Q [m\u00b3/s]";
gernotbelger@9312: 
gernotbelger@9312:     public static final String PDF_HEADER_MODE = "export.computed.discharge.pdf.mode";
gernotbelger@9312:     public static final String PDF_HEADER_CALC_MODE = "export.computed.discharge.pdf.calc.mode";
gernotbelger@9312:     public static final String JASPER_FILE = "export.computed.discharge.pdf.file";
ingo@392: 
ingo@394:     protected List<WQKms> data;
ingo@394: 
aheinecke@6305:     protected String wUnit;
aheinecke@6305:     protected String riverUnit;
aheinecke@6305:     protected String gaugeName;
aheinecke@6305:     protected double gaugeDatum;
aheinecke@6317:     protected Date validSince;
ingo@394: 
teichmann@7077:     public ComputedDischargeCurveExporter() {
gernotbelger@9312:         this.data = new ArrayList<>();
ingo@392:     }
ingo@392: 
sascha@701:     @Override
sascha@701:     protected void addData(Object d) {
sascha@715:         if (d instanceof CalculationResult) {
gernotbelger@9312:             d = ((CalculationResult) d).getData();
sascha@701:         }
aheinecke@6305:         WQKms referenceWQ = null; // used for gauge / unit observations
gernotbelger@9312:         if (d instanceof WQKms[]) {
gernotbelger@9312:             this.data.addAll(Arrays.asList((WQKms[]) d));
aheinecke@6305:             // If there is a unit mix in this list
aheinecke@6305:             // we are screwed anyway.
gernotbelger@9312:             referenceWQ = ((WQKms[]) d)[0];
gernotbelger@9312:         } else if (d instanceof WQKms) {
gernotbelger@9312:             this.data.add((WQKms) d);
gernotbelger@9312:             referenceWQ = (WQKms) d;
aheinecke@6305:         } else {
gernotbelger@9312:             log.warn("Can't add data for export. Unkown data type " + d.getClass().getName());
bjoern@4610:             return;
bjoern@4585:         }
aheinecke@6305:         if (referenceWQ != null) {
gernotbelger@9312:             final D4EArtifact arti = (D4EArtifact) this.master;
gernotbelger@9312:             final River river = RiverUtils.getRiver(arti);
gernotbelger@9312:             this.riverUnit = river.getWstUnit().getName();
gernotbelger@9312:             final RangeAccess rangeAccess = new RangeAccess(arti);
aheinecke@6305: 
gernotbelger@9312:             final double[] kms = rangeAccess.getKmRange();
aheinecke@6305: 
gernotbelger@9312:             final Gauge gauge = river.determineGaugeAtStation(kms[0]);
tom@8724:             if (gauge != null) {
gernotbelger@9312:                 this.wUnit = "cm";
gernotbelger@9312:                 this.gaugeName = gauge.getName();
gernotbelger@9312:                 this.gaugeDatum = gauge.getDatum().doubleValue();
aheinecke@6305: 
aheinecke@6305:                 // Now convert the data to cm because we are at gauge
gernotbelger@9312:                 final List<WQKms> newData = new ArrayList<>();
gernotbelger@9312:                 for (final WQKms d2 : this.data) {
gernotbelger@9312:                     newData.add(new WQKms(d2.getKms(), WQ.getFixedWQforExportAtGauge(d2, gauge.getDatum())));
aheinecke@6305:                 }
gernotbelger@9312:                 this.data = newData; // All hail the garbage collector
aheinecke@6317: 
gernotbelger@9312:                 this.validSince = gauge.fetchMasterDischargeTable().getTimeInterval().getStartTime();
aheinecke@6305:             } else {
gernotbelger@9312:                 this.gaugeName = "";
gernotbelger@9312:                 this.validSince = null;
gernotbelger@9312:                 this.gaugeDatum = Double.NaN;
aheinecke@6305:             }
aheinecke@6305:         }
ingo@392:     }
ingo@392: 
gernotbelger@9312:     @Override
gernotbelger@9312:     protected void writeCSVData(final CSVWriter writer) {
teichmann@8202:         log.info("ComputedDischargeCurveExporter.writeData");
ingo@392: 
ingo@416:         writeCSVHeader(writer);
ingo@416: 
gernotbelger@9312:         final NumberFormat wf = getWFormatter();
gernotbelger@9312:         final NumberFormat qf = getQFormatter();
ingo@418: 
ingo@394:         double[] res = new double[3];
ingo@394: 
gernotbelger@9312:         for (final WQKms wqkms : this.data) {
gernotbelger@9312:             final int size = wqkms.size();
ingo@394: 
ingo@394:             for (int i = 0; i < size; i++) {
ingo@394:                 res = wqkms.get(i, res);
ingo@394: 
gernotbelger@9312:                 writer.writeNext(new String[] { wf.format(res[0]), qf.format(res[1]) });
ingo@394:             }
ingo@394:         }
ingo@392:     }
ingo@416: 
gernotbelger@9312:     protected void writeCSVHeader(final CSVWriter writer) {
teichmann@8202:         log.debug("ComputedDischargeCurveExporter.writeCSVHeader");
ingo@416: 
gernotbelger@9312:         final RangeAccess access = new RangeAccess((D4EArtifact) this.master);
gernotbelger@9312:         final double[] km = access.getLocations();
aheinecke@6308:         // If we are not at gauge (cm) use the river unit
gernotbelger@9312:         final String realUnit = "cm".equals(this.wUnit) ? "cm" : this.riverUnit;
gernotbelger@9312:         final String header = msg(CSV_W_HEADER, DEFAULT_CSV_W_HEADER, new Object[] { realUnit });
teichmann@5985: 
gernotbelger@9312:         writer.writeNext(new String[] { header, msg(CSV_Q_HEADER, DEFAULT_CSV_Q_HEADER) });
ingo@416:     }
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:      */
gernotbelger@9312:     @Override
ingo@418:     protected NumberFormat getWFormatter() {
gernotbelger@9312:         if ("cm".equals(this.wUnit)) {
gernotbelger@9312:             return Formatter.getFormatter(this.context, 0, 0);
aheinecke@6305:         }
gernotbelger@9312:         return Formatter.getComputedDischargeW(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:      */
gernotbelger@9312:     @Override
ingo@418:     protected NumberFormat getQFormatter() {
gernotbelger@9312:         return Formatter.getComputedDischargeQ(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/computed-discharge_en.jasper");
gernotbelger@9312:         final String confPath = Config.getConfigDirectory().toString();
raimund@2185: 
gernotbelger@9312:         final Map parameters = new HashMap();
raimund@2177:         parameters.put("ReportTitle", "Exported Data");
raimund@2177:         try {
gernotbelger@9312:             final JasperPrint print = JasperFillManager.fillReport(confPath + jasperFile, parameters, source);
raimund@2177:             JasperExportManager.exportReportToPdfStream(print, out);
raimund@2177:         }
gernotbelger@9312:         catch (final JRException je) {
teichmann@8202:             log.warn("Error generating PDF Report!");
raimund@2177:             je.printStackTrace();
raimund@2177:         }
raimund@2177:     }
raimund@2177: 
raimund@2177:     protected WKmsJRDataSource createJRData() {
gernotbelger@9312:         final WKmsJRDataSource source = new WKmsJRDataSource();
raimund@2177: 
raimund@2177:         addMetaData(source);
raimund@2177:         addWQData(source);
raimund@2177: 
raimund@2177:         return source;
raimund@2177:     }
raimund@2177: 
gernotbelger@9312:     protected void addMetaData(final WKmsJRDataSource source) {
gernotbelger@9312:         final CallMeta meta = this.context.getMeta();
raimund@2177: 
gernotbelger@9312:         final D4EArtifact flys = (D4EArtifact) this.master;
gernotbelger@9312:         source.addMetaData("gauge", this.gaugeName);
gernotbelger@9312:         if (!Double.isNaN(this.gaugeDatum)) {
gernotbelger@9312:             final NumberFormat mf = Formatter.getMeterFormat(this.context);
gernotbelger@9312:             source.addMetaData("datum", mf.format(this.gaugeDatum) + " " + this.riverUnit);
aheinecke@6305:         } else {
aheinecke@6305:             source.addMetaData("datum", "");
aheinecke@6305:         }
raimund@2177: 
gernotbelger@9312:         source.addMetaData("river", RiverUtils.getRivername(flys));
raimund@2177: 
gernotbelger@9312:         final Locale locale = Resources.getLocale(meta);
gernotbelger@9312:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
raimund@2177: 
raimund@2177:         source.addMetaData("date", df.format(new Date()));
raimund@2177: 
gernotbelger@9312:         source.addMetaData("wUnit", "cm".equals(this.wUnit) ? "cm" : this.riverUnit);
aheinecke@6305: 
gernotbelger@9312:         final RangeAccess rangeAccess = new RangeAccess(flys);
gernotbelger@9312:         final double[] kms = rangeAccess.getKmRange();
gernotbelger@9312:         source.addMetaData("range", Formatter.getCalculationKm(this.context.getMeta()).format(kms[0]));
raimund@2177: 
gernotbelger@9312:         if (!"cm".equals(this.wUnit)) {
aheinecke@6317:             source.addMetaData("valid_since", "");
gernotbelger@9312:             source.addMetaData("calculation", Resources.getMsg(locale, PDF_HEADER_CALC_MODE, "Computed Discharge"));
aheinecke@6305:         } else {
gernotbelger@9312:             source.addMetaData("valid_since", this.validSince == null ? "" : df.format(this.validSince));
gernotbelger@9312:             source.addMetaData("calculation", Resources.getMsg(locale, PDF_HEADER_MODE, "Discharge"));
aheinecke@6305:         }
raimund@2177:     }
raimund@2177: 
gernotbelger@9312:     protected void addWQData(final WKmsJRDataSource source) {
gernotbelger@9312:         final NumberFormat wf = getWFormatter();
gernotbelger@9312:         final NumberFormat qf = getQFormatter();
raimund@2177: 
raimund@2177:         double[] res = new double[3];
raimund@2177: 
gernotbelger@9312:         for (final WQKms wqkms : this.data) {
gernotbelger@9312:             final int size = wqkms.size();
raimund@2177: 
raimund@2177:             for (int i = 0; i < size; i++) {
raimund@2177:                 res = wqkms.get(i, res);
raimund@2177: 
gernotbelger@9312:                 source.addData(new String[] { "", // Empty, the WKmsJRDtasource stores km here.
gernotbelger@9312:                         wf.format(res[0]), qf.format(res[1]) });
raimund@2177:             }
raimund@2177:         }
raimund@2177:     }
ingo@392: }
ingo@392: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :