gernotbelger@8928: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8928:  * Software engineering by Intevation GmbH
gernotbelger@8928:  *
gernotbelger@8928:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8928:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8928:  * documentation coming with Dive4Elements River for details.
gernotbelger@8928:  */
gernotbelger@8928: 
gernotbelger@8928: package org.dive4elements.river.artifacts.sinfo.tkhstate;
gernotbelger@8928: 
gernotbelger@8928: import java.util.ArrayList;
gernotbelger@8928: import java.util.Collection;
gernotbelger@8928: 
gernotbelger@8928: import org.apache.log4j.Logger;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.SInfoI18NStrings;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8928: import org.dive4elements.river.utils.RiverUtils;
gernotbelger@8928: 
gernotbelger@8928: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@8928: 
gernotbelger@8928: /**
gernotbelger@8928:  * Generates different output formats (csv, pdf) of data that resulted from a tkh computation.
gernotbelger@8928:  *
gernotbelger@8928:  * @author Gernot Belger
gernotbelger@8928:  */
gernotbelger@8928: // REMARK: must be public because its registered in generators.xml
gernotbelger@8928: public class TkhExporter extends AbstractSInfoExporter<TkhResultRow, TkhCalculationResult, TkhCalculationResults> {
gernotbelger@8928: 
gernotbelger@8938:     private static enum ExportMode {
gernotbelger@8938:         pdf, csv
gernotbelger@8938:     }
gernotbelger@8938: 
gernotbelger@8928:     /** The log used in this exporter. */
gernotbelger@8928:     private static Logger log = Logger.getLogger(TkhExporter.class);
gernotbelger@8928: 
gernotbelger@8928:     private static final String CSV_META_CALCULATION_FORMULA = "sinfo.export.tkh.calculation.formula";
gernotbelger@8928: 
gernotbelger@8928:     private static final String CSV_TKH_HEADER = "sinfo.export.tkh.csv.header.tkh";
gernotbelger@8928: 
gernotbelger@8928:     private static final String CSV_TKHKIND_HEADER = "sinfo.export.tkh.csv.header.tkhkind";
gernotbelger@8928: 
gernotbelger@8928:     private static final String PREFIX_TKH_KIND = "sinfo.export.tkh.soilkind.";
gernotbelger@8928: 
gernotbelger@8928:     private static final String CSV_MEAN_BED_HEIGHT_HEADER_SHORT = "sinfo.export.flow_depth.csv.header.mean_bed_height.short";
gernotbelger@8928: 
gernotbelger@8928:     private static final String JASPER_FILE = "/jasper/sinfo.flowdepth.jasper";
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8928:     protected Logger getLog() {
gernotbelger@8928:         return log;
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected void writeCSVGlobalMetadata(final CSVWriter writer, final TkhCalculationResults results) {
gernotbelger@8928:         log.info("TkhExporter.writeCSVMeta");
gernotbelger@8928: 
gernotbelger@8946:         super.writeCSVGlobalMetadataDefaults(writer, results);
gernotbelger@8928: 
gernotbelger@8928:         // "# Berechnungsgrundlage: Gleichung nach GILL (1971)"
gernotbelger@8928:         writeCSVMetaEntry(writer, CSV_META_CALCULATION_FORMULA);
gernotbelger@8928: 
gernotbelger@8928:         writer.writeNext(new String[] { "" });
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     /**
gernotbelger@8928:      * Write the header, with different headings depending on whether at a gauge or at a location.
gernotbelger@8928:      */
gernotbelger@8938: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected void writeCSVHeader(final CSVWriter writer, final TkhCalculationResults results, final RiverInfo river) {
gernotbelger@8928:         log.info("TkhExporter.writeCSVHeader");
gernotbelger@8928: 
gernotbelger@8928:         final Collection<String> header = new ArrayList<>(11);
gernotbelger@8928: 
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_KM_HEADER));
gernotbelger@8928:         header.add(msgUnit(CSV_TKH_HEADER, SInfoI18NStrings.UNIT_CM));
gernotbelger@8938:         header.add(msg(CSV_TKHKIND_HEADER));
gernotbelger@8928:         header.add(msgUnit(SInfoI18NStrings.CSV_MEAN_BED_HEIGHT_HEADER, river.getWstUnit()));
gernotbelger@8928: 
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@8938: 
gernotbelger@8938:         final String descriptionHeader = results.getDescriptionHeader();
gernotbelger@8938:         if (descriptionHeader != null)
gernotbelger@8938:             header.add(msg(descriptionHeader));
gernotbelger@8938: 
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_GAUGE_HEADER));
gernotbelger@8928:         header.add(msg(SInfoI18NStrings.CSV_LOCATION_HEADER));
gernotbelger@8928: 
gernotbelger@8928:         writer.writeNext(header.toArray(new String[header.size()]));
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8938:     // FIXME: rename
gernotbelger@8938:     protected void writeCSVResultMetadata(final CSVWriter writer, final TkhCalculationResults results, final TkhCalculationResult result) {
gernotbelger@8928: 
gernotbelger@8928:         final WstInfo wst = result.getWst();
gernotbelger@8946:         super.writeCSVWaterlevelMetadata(writer, wst);
gernotbelger@8928: 
gernotbelger@8946:         // TODO:
gernotbelger@8946:         // "# W/Pegel [cm]: " (nur bei Eingabe des Wasserstands am Pegel)
gernotbelger@8946:         // "# Q (m³/s): " (nur bei Eingabe des Durchflusses)
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected String[] formatCSVRow(final TkhCalculationResults results, final TkhResultRow row) {
gernotbelger@8938:         return formatRow(results, row, ExportMode.csv);
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     /**
gernotbelger@8928:      * Format a row of a flow depth result into an array of string, both used by csv and pdf
gernotbelger@8928:      *
gernotbelger@8938:      * @param results
gernotbelger@8938:      *
gernotbelger@8928:      * @param useTkh
gernotbelger@8928:      */
gernotbelger@8938:     private String[] formatRow(final TkhCalculationResults results, final TkhResultRow row, final ExportMode mode) {
gernotbelger@8928: 
gernotbelger@8928:         final Collection<String> lines = new ArrayList<>(11);
gernotbelger@8928: 
gernotbelger@8928:         // Fluss-km
gernotbelger@8928:         lines.add(getKmFormatter().format(row.getStation()));
gernotbelger@8928: 
gernotbelger@8928:         // TKH [cm]
gernotbelger@8928:         lines.add(getTkhFormatter().format(row.getTkh()));
gernotbelger@8928: 
gernotbelger@8928:         // Einteilung der Gewässersohle (starr/mobil)
gernotbelger@8928:         lines.add(msg(PREFIX_TKH_KIND + row.getTkhKind().name()));
gernotbelger@8928: 
gernotbelger@8928:         // Mittlere Sohlhöhe [NN + m]
gernotbelger@8928:         lines.add(getMeanBedHeighFormatter().format(row.getMeanBedHeight()));
gernotbelger@8928: 
gernotbelger@8928:         // Wasserstand [NN + m]
gernotbelger@8928:         lines.add(getW2Formatter().format(row.getWaterlevel()));
gernotbelger@8928: 
gernotbelger@8928:         // Q [m³/s]
gernotbelger@8928:         final double discharge = row.getDischarge();
gernotbelger@8928:         final double roundedDischarge = RiverUtils.roundQ(discharge);
gernotbelger@8928:         lines.add(getQFormatter().format(roundedDischarge));
gernotbelger@8928: 
gernotbelger@8928:         // Bezeichnung
gernotbelger@8938:         // REMARK: always export this column in pdf-mode, because WInfo also does it (no need for two jasper-templates).
gernotbelger@8938:         if (results.getDescriptionHeader() != null || mode == ExportMode.pdf)
gernotbelger@8938:             lines.add(row.getWaterlevelLabel());
gernotbelger@8928: 
gernotbelger@8928:         // Bezugspegel
gernotbelger@8928:         lines.add(row.getGauge());
gernotbelger@8928: 
gernotbelger@8928:         // Lage
gernotbelger@8928:         lines.add(row.getLocation());
gernotbelger@8928: 
gernotbelger@8928:         return lines.toArray(new String[lines.size()]);
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8928:     protected final String getJasperFile() {
gernotbelger@8928:         return JASPER_FILE;
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8928:     protected final void addJRMetaData(final MetaAndTableJRDataSource source, final TkhCalculationResults results) {
gernotbelger@8928: 
gernotbelger@8928:         /* general metadata */
gernotbelger@8946:         super.addJRMetaDataDefaults(source, results);
gernotbelger@8928: 
gernotbelger@8928:         /* column headings */
gernotbelger@8928:         source.addMetaData("station_header", msg(SInfoI18NStrings.CSV_KM_HEADER));
gernotbelger@8928:         source.addMetaData("tkh_header", msg(CSV_TKH_HEADER));
gernotbelger@8928:         source.addMetaData("bedheight_header", msg(CSV_MEAN_BED_HEIGHT_HEADER_SHORT));
gernotbelger@8928:         source.addMetaData("waterlevel_header", msg(SInfoI18NStrings.CSV_WATERLEVEL_HEADER));
gernotbelger@8928:         source.addMetaData("discharge_header", msg(SInfoI18NStrings.CSV_DISCHARGE_HEADER));
gernotbelger@8938: 
gernotbelger@8938:         // REMARK: actually the column makes no sense if description header is null. But (software symmetry...) WINFO also
gernotbelger@8938:         // writes an empty column into the pdf in that case (most probably to avoid the need for two jasper templates).
gernotbelger@8938:         final String descriptionHeader = results.getDescriptionHeader();
gernotbelger@8938:         final String waterlevelNameHeader = descriptionHeader == null ? msg(SInfoI18NStrings.CSV_LABEL_HEADER) : descriptionHeader;
gernotbelger@8938:         source.addMetaData("waterlevel_name_header", waterlevelNameHeader);
gernotbelger@8938: 
gernotbelger@8928:         source.addMetaData("gauge_header", msg(SInfoI18NStrings.CSV_GAUGE_HEADER));
gernotbelger@8928:         source.addMetaData("location_header", msg(SInfoI18NStrings.CSV_LOCATION_HEADER));
gernotbelger@8928:     }
gernotbelger@8928: 
gernotbelger@8928:     @Override
gernotbelger@8938:     protected String[] formatPDFRow(final TkhCalculationResults results, final TkhResultRow row) {
gernotbelger@8938:         return formatRow(results, row, ExportMode.pdf);
gernotbelger@8928:     }
gernotbelger@8928: }