gernotbelger@8946: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8946:  * Software engineering by Intevation GmbH
gernotbelger@8946:  *
gernotbelger@8946:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8946:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8946:  * documentation coming with Dive4Elements River for details.
gernotbelger@8946:  */
gernotbelger@8946: 
gernotbelger@8946: package org.dive4elements.river.artifacts.sinfo.flowdepthminmax;
gernotbelger@8946: 
gernotbelger@8946: import java.util.ArrayList;
gernotbelger@8946: import java.util.Collection;
gernotbelger@8946: 
gernotbelger@8946: import org.apache.commons.lang.StringUtils;
gernotbelger@8946: import org.apache.log4j.Logger;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.SInfoI18NStrings;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8946: import org.dive4elements.river.utils.RiverUtils;
gernotbelger@8946: 
gernotbelger@8946: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@8946: 
gernotbelger@8946: /**
gernotbelger@8946:  * Generates different output formats (csv, pdf) of data that resulted from a flow depths computation.
gernotbelger@8946:  *
gernotbelger@8946:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
gernotbelger@8946:  * @author Gernot Belger
gernotbelger@8946:  */
gernotbelger@8946: // REMARK: must be public because its registered in generators.xml
gernotbelger@8946: public class FlowDepthMinMaxExporter extends AbstractSInfoExporter<FlowDepthMinMaxRow, FlowDepthMinMaxCalculationResult, FlowDepthMinMaxCalculationResults> {
gernotbelger@8946: 
gernotbelger@8946:     /** The log used in this exporter. */
gernotbelger@8946:     private static Logger log = Logger.getLogger(FlowDepthMinMaxExporter.class);
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_FLOWDEPTH_MIN_HEADER = "sinfo.export.flow_depth_minmax.csv.header.min";
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_FLOWDEPTH_MAX_HEADER = "sinfo.export.flow_depth_minmax.csv.header.max";
gernotbelger@8946: 
gernotbelger@8946:     private static final String JASPER_FILE = "/jasper/sinfo.flowdepth.jasper";
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected Logger getLog() {
gernotbelger@8946:         return log;
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthMinMaxCalculationResults results,
gernotbelger@8946:             final FlowDepthMinMaxCalculationResult result) {
gernotbelger@8946: 
gernotbelger@8946:         final BedHeightInfo sounding = result.getAnySounding();
gernotbelger@8946:         super.writeCSVSoundingMetadata(writer, sounding);
gernotbelger@8946: 
gernotbelger@8946:         final WstInfo wst = result.getWst();
gernotbelger@8946:         writeCSVWaterlevelMetadata(writer, wst);
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthMinMaxCalculationResults results) {
gernotbelger@8946: 
gernotbelger@8946:         super.writeCSVGlobalMetadataDefaults(writer, results);
gernotbelger@8946: 
gernotbelger@8946:         writer.writeNext(new String[] { "" });
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     /**
gernotbelger@8946:      * Write the header, with different headings depending on whether at a
gernotbelger@8946:      * gauge or at a location.
gernotbelger@8946:      *
gernotbelger@8946:      * @param river
gernotbelger@8946:      * @param useTkh
gernotbelger@8946:      */
gernotbelger@8946:     @Override
gernotbelger@8946:     protected void writeCSVHeader(final CSVWriter writer, final FlowDepthMinMaxCalculationResults results, final RiverInfo river) {
gernotbelger@8946:         log.info("FlowDepthExporter.writeCSVHeader");
gernotbelger@8946: 
gernotbelger@8946:         final Collection<String> header = new ArrayList<>(11);
gernotbelger@8946: 
gernotbelger@8946:         header.add(msg(SInfoI18NStrings.CSV_KM_HEADER));
gernotbelger@8946: 
gernotbelger@8946:         header.add(msgUnit(CSV_FLOWDEPTH_MIN_HEADER, SInfoI18NStrings.UNIT_M));
gernotbelger@8946:         header.add(msgUnit(CSV_FLOWDEPTH_MAX_HEADER, SInfoI18NStrings.UNIT_M));
gernotbelger@8946: 
gernotbelger@8946:         header.add(msgUnit(SInfoI18NStrings.CSV_WATERLEVEL_HEADER, river.getWstUnit()));
gernotbelger@8946:         header.add(msgUnit(SInfoI18NStrings.CSV_DISCHARGE_HEADER, SInfoI18NStrings.UNIT_CUBIC_M));
gernotbelger@8946:         header.add(msg(SInfoI18NStrings.CSV_LABEL_HEADER));
gernotbelger@8946:         header.add(msg(SInfoI18NStrings.CSV_GAUGE_HEADER));
gernotbelger@8946:         header.add(msgUnit(SInfoI18NStrings.CSV_MEAN_BED_HEIGHT_HEADER, river.getWstUnit()));
gernotbelger@8946:         header.add(msg(SInfoI18NStrings.CSV_SOUNDING_HEADER));
gernotbelger@8946:         header.add(msg(SInfoI18NStrings.CSV_LOCATION_HEADER));
gernotbelger@8946: 
gernotbelger@8946:         writer.writeNext(header.toArray(new String[header.size()]));
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected String[] formatCSVRow(final FlowDepthMinMaxCalculationResults results, final FlowDepthMinMaxRow row) {
gernotbelger@8946:         return formatFlowDepthRow(row);
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     /**
gernotbelger@8946:      * Format a row of a flow depth result into an array of string, both used by csv and pdf
gernotbelger@8946:      *
gernotbelger@8946:      * @param useTkh
gernotbelger@8946:      */
gernotbelger@8946:     private String[] formatFlowDepthRow(final FlowDepthMinMaxRow row) {
gernotbelger@8946: 
gernotbelger@8946:         final Collection<String> lines = new ArrayList<>(11);
gernotbelger@8946: 
gernotbelger@8946:         // Fluss-km
gernotbelger@8946:         lines.add(getKmFormatter().format(row.getStation()));
gernotbelger@8946: 
gernotbelger@8946:         // FIXME: spalten weglassen, wenn min oder max fehlt
gernotbelger@8946: 
gernotbelger@8946:         // Minimale Fließtiefe [m]
gernotbelger@8946:         lines.add(getFlowDepthFormatter().format(row.getMinFlowDepth()));
gernotbelger@8946:         // Maximale Fließtiefe [m]
gernotbelger@8946:         lines.add(getFlowDepthFormatter().format(row.getMaxFlowDepth()));
gernotbelger@8946: 
gernotbelger@8946:         // Wasserstand [NN + m]
gernotbelger@8946:         lines.add(getW2Formatter().format(row.getWaterlevel()));
gernotbelger@8946: 
gernotbelger@8946:         // Q [m³/s]
gernotbelger@8946:         final double discharge = row.getDischarge();
gernotbelger@8946:         if (Double.isNaN(discharge))
gernotbelger@8946:             lines.add(StringUtils.EMPTY);
gernotbelger@8946:         else {
gernotbelger@8946:             final double roundedDischarge = RiverUtils.roundQ(discharge);
gernotbelger@8946:             lines.add(getQFormatter().format(roundedDischarge));
gernotbelger@8946:         }
gernotbelger@8946: 
gernotbelger@8946:         // Bezeichnung
gernotbelger@8946:         lines.add(row.getWaterlevelLabel());
gernotbelger@8946: 
gernotbelger@8946:         // Bezugspegel
gernotbelger@8946:         lines.add(row.getGauge());
gernotbelger@8946: 
gernotbelger@8946:         // Mittlere Sohlhöhe [NN + m]
gernotbelger@8946:         lines.add(getMeanBedHeighFormatter().format(row.getMeanBedHeight()));
gernotbelger@8946: 
gernotbelger@8946:         // Peilung/Epoche
gernotbelger@8946:         lines.add(row.getSoundageLabel());
gernotbelger@8946: 
gernotbelger@8946:         // Lage
gernotbelger@8946:         lines.add(row.getLocation());
gernotbelger@8946: 
gernotbelger@8946:         return lines.toArray(new String[lines.size()]);
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected final String getJasperFile() {
gernotbelger@8946:         return JASPER_FILE;
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthMinMaxCalculationResults results) {
gernotbelger@8946: 
gernotbelger@8946:         /* general metadata */
gernotbelger@8946:         super.addJRMetaDataDefaults(source, results);
gernotbelger@8946: 
gernotbelger@8946:         /* column headings */
gernotbelger@8946:         source.addMetaData("station_header", msg(SInfoI18NStrings.CSV_KM_HEADER));
gernotbelger@8946:         source.addMetaData("flowdepthmin_header", msg(CSV_FLOWDEPTH_MIN_HEADER));
gernotbelger@8946:         source.addMetaData("flowdepthmax_header", msg(CSV_FLOWDEPTH_MAX_HEADER));
gernotbelger@8946:         source.addMetaData("waterlevel_header", msg(SInfoI18NStrings.CSV_WATERLEVEL_HEADER));
gernotbelger@8946:         source.addMetaData("discharge_header", msg(SInfoI18NStrings.CSV_DISCHARGE_HEADER));
gernotbelger@8946:         source.addMetaData("waterlevel_name_header", msg(SInfoI18NStrings.CSV_LABEL_HEADER));
gernotbelger@8946:         source.addMetaData("gauge_header", msg(SInfoI18NStrings.CSV_GAUGE_HEADER));
gernotbelger@8946:         source.addMetaData("bedheight_header", msg(SInfoI18NStrings.CSV_MEAN_BED_HEIGHT_HEADER_SHORT));
gernotbelger@8946:         source.addMetaData("sounding_name_header", msg(SInfoI18NStrings.CSV_SOUNDING_HEADER));
gernotbelger@8946:         source.addMetaData("location_header", msg(SInfoI18NStrings.CSV_LOCATION_HEADER));
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     @Override
gernotbelger@8946:     protected String[] formatPDFRow(final FlowDepthMinMaxCalculationResults results, final FlowDepthMinMaxRow row) {
gernotbelger@8946:         return formatFlowDepthRow(row);
gernotbelger@8946:     }
gernotbelger@8946: }