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