gernotbelger@8854: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8854:  * Software engineering by Intevation GmbH
gernotbelger@8854:  *
gernotbelger@8854:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8854:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8854:  * documentation coming with Dive4Elements River for details.
gernotbelger@8854:  */
gernotbelger@8854: 
gernotbelger@8854: package org.dive4elements.river.artifacts.sinfo.flowdepth;
gernotbelger@8854: 
gernotbelger@8854: import java.text.DateFormat;
gernotbelger@8894: import java.text.NumberFormat;
gernotbelger@8854: import java.util.ArrayList;
gernotbelger@8854: import java.util.Collection;
gernotbelger@8854: import java.util.Date;
gernotbelger@8854: import java.util.Locale;
gernotbelger@8854: 
gernotbelger@8877: import org.apache.commons.lang.StringUtils;
gernotbelger@8894: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@8854: import org.apache.log4j.Logger;
gernotbelger@8863: import org.dive4elements.river.FLYS;
gernotbelger@8854: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.SInfoI18NStrings;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter;
gernotbelger@8894: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@8854: import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource;
gernotbelger@8894: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8894: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8882: import org.dive4elements.river.utils.RiverUtils;
gernotbelger@8854: 
gernotbelger@8854: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@8854: 
gernotbelger@8854: /**
gernotbelger@8854:  * Generates different output formats (csv, pdf) of data that resulted from a flow depths computation.
gernotbelger@8854:  *
gernotbelger@8854:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
gernotbelger@8854:  * @author Gernot Belger
gernotbelger@8854:  */
gernotbelger@8854: // REMARK: must be public because its registered in generators.xml
gernotbelger@8928: public class FlowDepthExporter extends AbstractSInfoExporter<FlowDepthRow, FlowDepthCalculationResult, FlowDepthCalculationResults> {
gernotbelger@8854: 
gernotbelger@8877:     /** The log used in this exporter. */
gernotbelger@8854:     private static Logger log = Logger.getLogger(FlowDepthExporter.class);
gernotbelger@8854: 
gernotbelger@8854:     private static final String CSV_FLOWDEPTH_HEADER = "sinfo.export.flow_depth.csv.header.flowdepth";
gernotbelger@8854:     private static final String CSV_FLOWDEPTHTKH_HEADER = "sinfo.export.flow_depth.csv.header.flowdepthTkh";
gernotbelger@8854:     private static final String CSV_TKH_HEADER = "sinfo.export.flow_depth.csv.header.tkh";
gernotbelger@8928: 
gernotbelger@8863:     private static final String CSV_MEAN_BED_HEIGHT_HEADER_SHORT = "sinfo.export.flow_depth.csv.header.mean_bed_height.short";
gernotbelger@8854:     private static final String CSV_SOUNDING_HEADER = "sinfo.export.flow_depth.csv.header.sounding";
gernotbelger@8877: 
gernotbelger@8877:     private static final String CSV_META_HEADER_SOUNDING = "sinfo.export.flow_depth.csv.meta.header.sounding";
gernotbelger@8877: 
gernotbelger@8877:     private static final String CSV_META_HEADER_SOUNDING_YEAR = "sinfo.export.flow_depth.csv.meta.header.sounding.year";
gernotbelger@8877: 
gernotbelger@8877:     private static final String CSV_META_HEADER_SOUNDING_TYPE = "sinfo.export.flow_depth.csv.meta.header.sounding.type";
gernotbelger@8877: 
gernotbelger@8882:     private static final String CSV_META_HEADER_SOUNDING_EVALUATOR = "sinfo.export.flow_depth.csv.meta.header.sounding.evaluator";
gernotbelger@8882: 
gernotbelger@8877:     private static final String CSV_META_HEADER_SOUNDING_PRJ = "sinfo.export.flow_depth.csv.meta.header.sounding.prj";
gernotbelger@8877: 
gernotbelger@8877:     private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel";
gernotbelger@8877: 
gernotbelger@8877:     private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel.original";
gernotbelger@8877: 
gernotbelger@8877:     private static final String JASPER_FILE = "/jasper/sinfo.flowdepth.jasper";
gernotbelger@8863: 
gernotbelger@8928:     @Override
gernotbelger@8928:     protected Logger getLog() {
gernotbelger@8928:         return log;
gernotbelger@8863:     }
gernotbelger@8877: 
gernotbelger@8854:     @Override
gernotbelger@8938:     protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthCalculationResults results, final FlowDepthCalculationResult result) {
gernotbelger@8877: 
gernotbelger@8877:         /* first some specific metadata */
gernotbelger@8877:         final BedHeightInfo sounding = result.getSounding();
gernotbelger@8877:         final WstInfo wst = result.getWst();
gernotbelger@8877: 
gernotbelger@8877:         // "##METADATEN PEILUNG"
gernotbelger@8877:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING);
gernotbelger@8877: 
gernotbelger@8877:         // "# Jahr der Peilung: "
gernotbelger@8877:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_YEAR, Integer.toString(sounding.getYear()));
gernotbelger@8877:         // "# Aufnahmeart: "
gernotbelger@8877:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_TYPE, sounding.getType());
gernotbelger@8882:         // "# Auswerter: "
gernotbelger@8882:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_EVALUATOR, sounding.getEvaluationBy());
gernotbelger@8877:         // "# Lagesystem: "
gernotbelger@8877:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_PRJ, sounding.getLocationSystem());
gernotbelger@8877:         // "# Höhensystem: "
gernotbelger@8879:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL, sounding.getCurElevationModelUnit());
gernotbelger@8877:         // "# ursprüngliches Höhensystem: "
gernotbelger@8884:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL, sounding.getOldElevationModelUnit());
gernotbelger@8877: 
gernotbelger@8877:         // "##METADATEN WASSERSPIEGELLAGE"
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL);
gernotbelger@8877:         // "# Bezeichnung der Wasserspiegellage: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_NAME, wst.getLabel());
gernotbelger@8879:         // "# Bezugspegel: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_GAUGE, wst.getGauge());
gernotbelger@8877:         // "# Jahr/Zeitraum der Wasserspiegellage: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_YEAR, Integer.toString(wst.getYear()));
gernotbelger@8877:     }
gernotbelger@8854: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthCalculationResults results) {
gernotbelger@8854:         log.info("FlowDepthExporter.writeCSVMeta");
gernotbelger@8854: 
gernotbelger@8863:         final String calcModeLabel = results.getCalcModeLabel();
gernotbelger@8894:         final RiverInfo river = results.getRiver();
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_RESULT, msg(SInfoI18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel);
gernotbelger@8854: 
gernotbelger@8877:         // "# FLYS-Version: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_VERSION, msg(SInfoI18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION);
gernotbelger@8854: 
gernotbelger@8877:         // "# Bearbeiter: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_USER, msg(SInfoI18NStrings.CSV_META_USER_LABEL), results.getUser());
gernotbelger@8854: 
gernotbelger@8854:         // "# Datum der Erstellung: "
gernotbelger@8877:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@8854:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_CREATION, msg(SInfoI18NStrings.CSV_META_CREATION_LABEL), df.format(new Date()));
gernotbelger@8854: 
gernotbelger@8854:         // "# Gewässer: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_RIVER, msg(SInfoI18NStrings.CSV_META_RIVER_LABEL), river.getName());
gernotbelger@8854: 
gernotbelger@8854:         // "# Höhensystem des Flusses: "
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit());
gernotbelger@8854: 
gernotbelger@8854:         // "# Ort/Bereich (km): "
gernotbelger@8894:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@8928:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_RANGE, msg(SInfoI18NStrings.CSV_META_RANGE_LABEL),
gernotbelger@8928:                 getKmFormatter().format(calcRange.getMinimumDouble()),
gernotbelger@8894:                 getKmFormatter().format(calcRange.getMaximumDouble()));
gernotbelger@8854: 
gernotbelger@8854:         writer.writeNext(new String[] { "" });
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8877:     /**
gernotbelger@8854:      * Write the header, with different headings depending on whether at a
gernotbelger@8854:      * gauge or at a location.
gernotbelger@8877:      *
gernotbelger@8877:      * @param river
gernotbelger@8877:      * @param useTkh
gernotbelger@8854:      */
gernotbelger@8938: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected void writeCSVHeader(final CSVWriter writer, final FlowDepthCalculationResults results, final RiverInfo river) {
gernotbelger@8854:         log.info("FlowDepthExporter.writeCSVHeader");
gernotbelger@8854: 
gernotbelger@8854:         final Collection<String> header = new ArrayList<>(11);
gernotbelger@8877: 
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_KM_HEADER));
gernotbelger@8928:         header.add(msgUnit(CSV_FLOWDEPTH_HEADER, SInfoI18NStrings.UNIT_M));
gernotbelger@8928:         if (getData().isUseTkh()) {
gernotbelger@8928:             header.add(msgUnit(CSV_FLOWDEPTHTKH_HEADER, SInfoI18NStrings.UNIT_M));
gernotbelger@8928:             header.add(msgUnit(CSV_TKH_HEADER, SInfoI18NStrings.UNIT_CM));
gernotbelger@8854:         }
gernotbelger@8863: 
gernotbelger@8928:         header.add(msgUnit(SInfoI18NStrings.CSV_WATERLEVEL_HEADER, river.getWstUnit()));
gernotbelger@8928:         header.add(msgUnit(SInfoI18NStrings.CSV_DISCHARGE_HEADER, SInfoI18NStrings.UNIT_CUBIC_M));
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_LABEL_HEADER));
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_GAUGE_HEADER));
gernotbelger@8928:         header.add(msgUnit(SInfoI18NStrings.CSV_MEAN_BED_HEIGHT_HEADER, river.getWstUnit()));
gernotbelger@8854:         header.add(msg(CSV_SOUNDING_HEADER));
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_LOCATION_HEADER));
gernotbelger@8854: 
gernotbelger@8877:         writer.writeNext(header.toArray(new String[header.size()]));
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected String[] formatCSVRow(final FlowDepthCalculationResults results, final FlowDepthRow row) {
gernotbelger@8928:         return formatFlowDepthRow(row);
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8854:     /**
gernotbelger@8854:      * Format a row of a flow depth result into an array of string, both used by csv and pdf
gernotbelger@8877:      *
gernotbelger@8877:      * @param useTkh
gernotbelger@8854:      */
gernotbelger@8928:     private String[] formatFlowDepthRow(final FlowDepthRow row) {
gernotbelger@8854: 
gernotbelger@8877:         final Collection<String> lines = new ArrayList<>(11);
gernotbelger@8854: 
gernotbelger@8877:         // Fluss-km
gernotbelger@8877:         lines.add(getKmFormatter().format(row.getStation()));
gernotbelger@8877: 
gernotbelger@8877:         // Fließtiefe [m]
gernotbelger@8877:         lines.add(getFlowDepthFormatter().format(row.getFlowDepth()));
gernotbelger@8877: 
gernotbelger@8928:         if (getData().isUseTkh()) {
gernotbelger@8877:             // Fließtiefe mit TKH [m]
gernotbelger@8877:             lines.add(getFlowDepthFormatter().format(row.getFlowDepthWithTkh()));
gernotbelger@8877: 
gernotbelger@8877:             // TKH [cm]
gernotbelger@8877:             lines.add(getTkhFormatter().format(row.getTkh()));
gernotbelger@8877:         }
gernotbelger@8877: 
gernotbelger@8877:         // Wasserstand [NN + m]
gernotbelger@8877:         lines.add(getW2Formatter().format(row.getWaterlevel()));
gernotbelger@8877: 
gernotbelger@8877:         // Q [m³/s]
gernotbelger@8877:         final double discharge = row.getDischarge();
gernotbelger@8884:         if (Double.isNaN(discharge))
gernotbelger@8877:             lines.add(StringUtils.EMPTY);
gernotbelger@8884:         else {
gernotbelger@8882:             final double roundedDischarge = RiverUtils.roundQ(discharge);
gernotbelger@8882:             lines.add(getQFormatter().format(roundedDischarge));
gernotbelger@8882:         }
gernotbelger@8877: 
gernotbelger@8877:         // Bezeichnung
gernotbelger@8877:         lines.add(row.getWaterlevelLabel());
gernotbelger@8877: 
gernotbelger@8877:         // Bezugspegel
gernotbelger@8877:         lines.add(row.getGauge());
gernotbelger@8877: 
gernotbelger@8877:         // Mittlere Sohlhöhe [NN + m]
gernotbelger@8877:         lines.add(getMeanBedHeighFormatter().format(row.getMeanBedHeight()));
gernotbelger@8877: 
gernotbelger@8877:         // Peilung/Epoche
gernotbelger@8877:         lines.add(row.getSoundageLabel());
gernotbelger@8877: 
gernotbelger@8877:         // Lage
gernotbelger@8877:         lines.add(row.getLocation());
gernotbelger@8877: 
gernotbelger@8877:         return lines.toArray(new String[lines.size()]);
gernotbelger@8854:     }
gernotbelger@8877: 
gernotbelger@8928:     @Override
gernotbelger@8928:     protected final String getJasperFile() {
gernotbelger@8928:         return JASPER_FILE;
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8877:     @Override
gernotbelger@8928:     protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthCalculationResults results) {
gernotbelger@8854: 
gernotbelger@8894:         final RiverInfo river = results.getRiver();
gernotbelger@8894:         final String wstUnitName = river.getWstUnit();
gernotbelger@8863: 
gernotbelger@8877:         /* general metadata */
gernotbelger@8928:         source.addMetaData("header", msg(SInfoI18NStrings.CSV_META_HEADER_RESULT_LABEL));
gernotbelger@8877:         source.addMetaData("calcMode", results.getCalcModeLabel());
gernotbelger@8877: 
gernotbelger@8928:         source.addMetaData("version_label", msg(SInfoI18NStrings.CSV_META_VERSION_LABEL));
gernotbelger@8863:         source.addMetaData("version", FLYS.VERSION);
gernotbelger@8863: 
gernotbelger@8928:         source.addMetaData("user_label", msg(SInfoI18NStrings.CSV_META_USER_LABEL));
gernotbelger@8863:         source.addMetaData("user", results.getUser());
gernotbelger@8877: 
gernotbelger@8877:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@8854:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@8928:         source.addMetaData("date_label", msg(SInfoI18NStrings.CSV_META_CREATION_LABEL));
gernotbelger@8854:         source.addMetaData("date", df.format(new Date()));
gernotbelger@8854: 
gernotbelger@8928:         source.addMetaData("river_label", msg(SInfoI18NStrings.CSV_META_RIVER_LABEL));
gernotbelger@8863:         source.addMetaData("river", river.getName());
gernotbelger@8854: 
gernotbelger@8894:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@8894:         final NumberFormat kmFormatter = getKmFormatter();
gernotbelger@8894:         final String rangeValue = String.format("%s - %s", kmFormatter.format(calcRange.getMinimumDouble()), kmFormatter.format(calcRange.getMaximumDouble()));
gernotbelger@8928:         source.addMetaData("range_label", msg(SInfoI18NStrings.CSV_META_RANGE_LABEL));
gernotbelger@8863:         source.addMetaData("range", rangeValue);
gernotbelger@8854: 
gernotbelger@8863:         /* column headings */
gernotbelger@8928:         source.addMetaData("station_header", msg(SInfoI18NStrings.CSV_KM_HEADER));
gernotbelger@8863:         source.addMetaData("flowdepth_header", msg(CSV_FLOWDEPTH_HEADER));
gernotbelger@8863:         source.addMetaData("flowdepth_tkh_header", msg(CSV_FLOWDEPTHTKH_HEADER));
gernotbelger@8863:         source.addMetaData("tkh_header", msg(CSV_TKH_HEADER));
gernotbelger@8928:         source.addMetaData("waterlevel_header", msg(SInfoI18NStrings.CSV_WATERLEVEL_HEADER));
gernotbelger@8863:         source.addMetaData("river_unit", wstUnitName);
gernotbelger@8928:         source.addMetaData("discharge_header", msg(SInfoI18NStrings.CSV_DISCHARGE_HEADER));
gernotbelger@8928:         source.addMetaData("waterlevel_name_header", msg(SInfoI18NStrings.CSV_LABEL_HEADER));
gernotbelger@8928:         source.addMetaData("gauge_header", msg(SInfoI18NStrings.CSV_GAUGE_HEADER));
gernotbelger@8863:         source.addMetaData("bedheight_header", msg(CSV_MEAN_BED_HEIGHT_HEADER_SHORT));
gernotbelger@8863:         source.addMetaData("sounding_name_header", msg(CSV_SOUNDING_HEADER));
gernotbelger@8928:         source.addMetaData("location_header", msg(SInfoI18NStrings.CSV_LOCATION_HEADER));
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected String[] formatPDFRow(final FlowDepthCalculationResults results, final FlowDepthRow row) {
gernotbelger@8928:         return formatFlowDepthRow(row);
gernotbelger@8877:     }
gernotbelger@8928: }