gernotbelger@8928: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8928:  * Software engineering by
gernotbelger@8928:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8928:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
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: package org.dive4elements.river.artifacts.sinfo.common;
gernotbelger@8928: 
gernotbelger@8946: import java.text.DateFormat;
gernotbelger@8946: import java.text.NumberFormat;
gernotbelger@8946: import java.util.Date;
gernotbelger@8946: import java.util.Locale;
gernotbelger@8928: 
gernotbelger@8946: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@8946: import org.dive4elements.river.FLYS;
gernotbelger@9000: import org.dive4elements.river.artifacts.common.AbstractCommonExporter;
gernotbelger@9000: import org.dive4elements.river.artifacts.common.GeneralResultType;
gernotbelger@9000: import org.dive4elements.river.artifacts.common.I18NStrings;
gernotbelger@8928: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource;
gernotbelger@8928: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8928: 
gernotbelger@8928: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@8928: 
gernotbelger@8928: /**
gernotbelger@8928:  * @author Gernot Belger
gernotbelger@8928:  */
gernotbelger@9000: public abstract class AbstractSInfoExporter<RESULT extends AbstractSInfoCalculationResult, RESULTS extends AbstractSInfoCalculationResults<RESULT>> extends AbstractCommonExporter<RESULT, RESULTS> {
gernotbelger@8928: 
gernotbelger@8946:     private static final String CSV_META_HEADER_SOUNDING = "sinfo.export.flow_depth.csv.meta.header.sounding";
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_META_HEADER_SOUNDING_YEAR = "sinfo.export.flow_depth.csv.meta.header.sounding.year";
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_META_HEADER_SOUNDING_TYPE = "sinfo.export.flow_depth.csv.meta.header.sounding.type";
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_META_HEADER_SOUNDING_PRJ = "sinfo.export.flow_depth.csv.meta.header.sounding.prj";
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel";
gernotbelger@8946: 
gernotbelger@8946:     private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel.original";
gernotbelger@8946: 
gernotbelger@8946:     protected final void writeCSVSoundingMetadata(final CSVWriter writer, final BedHeightInfo sounding) {
gernotbelger@8953:         writeCSVSoundingMetadata(writer, sounding, CSV_META_HEADER_SOUNDING);
gernotbelger@8953:     }
gernotbelger@8953: 
gernotbelger@8953:     protected final void writeCSVSoundingMetadata(final CSVWriter writer, final BedHeightInfo sounding, final String mainLabel) {
gernotbelger@8946:         // "##METADATEN PEILUNG"
gernotbelger@8953:         writeCSVMetaEntry(writer, mainLabel);
gernotbelger@8946: 
gernotbelger@8946:         // "# Jahr der Peilung: "
gernotbelger@8946:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_YEAR, Integer.toString(sounding.getYear()));
gernotbelger@8946:         // "# Aufnahmeart: "
gernotbelger@8946:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_TYPE, sounding.getType());
gernotbelger@8946:         // "# Auswerter: "
gernotbelger@9000:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_EVALUATOR, sounding.getEvaluationBy());
gernotbelger@8946:         // "# Lagesystem: "
gernotbelger@8946:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_PRJ, sounding.getLocationSystem());
gernotbelger@8946:         // "# Höhensystem: "
gernotbelger@8946:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL, sounding.getCurElevationModelUnit());
gernotbelger@8946:         // "# ursprüngliches Höhensystem: "
gernotbelger@8946:         writeCSVMetaEntry(writer, CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL, sounding.getOldElevationModelUnit());
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     protected final void writeCSVWaterlevelMetadata(final CSVWriter writer, final WstInfo wst) {
gernotbelger@8953:         writeCSVWaterlevelMetadata(writer, wst, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL);
gernotbelger@8953:     }
gernotbelger@8953: 
gernotbelger@8953:     protected final void writeCSVWaterlevelMetadata(final CSVWriter writer, final WstInfo wst, final String mainLabel) {
gernotbelger@8946:         // "##METADATEN WASSERSPIEGELLAGE"
gernotbelger@8953:         writeCSVMetaEntry(writer, mainLabel);
gernotbelger@8946: 
gernotbelger@8946:         // "# Bezeichnung der Wasserspiegellage: "
gernotbelger@8946:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_NAME, wst.getLabel());
gernotbelger@8946: 
gernotbelger@8946:         // "# Bezugspegel: "
gernotbelger@8946:         writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_GAUGE, wst.getGauge());
gernotbelger@8946: 
gernotbelger@8946:         // "# Jahr/Zeitraum der Wasserspiegellage: "
gernotbelger@8946:         final int year = wst.getYear();
gernotbelger@8946:         if (year > 0)
gernotbelger@8946:             writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_YEAR, Integer.toString(year));
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@9000:     @Override
gernotbelger@9000:     protected void writeCSVGlobalMetadataDefaults(final CSVWriter writer, final RESULTS results) {
gernotbelger@9000: 
gernotbelger@9000:         final String calcModeLabel = results.getCalcModeLabel();
gernotbelger@9000:         final RiverInfo river = results.getRiver();
gernotbelger@9000:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@9000: 
gernotbelger@9000:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_HEADER_RESULT, msg(I18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel);
gernotbelger@9000: 
gernotbelger@9000:         // "# FLYS-Version: "
gernotbelger@9000:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_VERSION, msg(I18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION);
gernotbelger@9000: 
gernotbelger@9000:         // "# Bearbeiter: "
gernotbelger@9000:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_USER, msg(I18NStrings.CSV_META_USER_LABEL), results.getUser());
gernotbelger@9000: 
gernotbelger@9000:         // "# Datum der Erstellung: "
gernotbelger@9000:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@9000:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@9000:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_CREATION, msg(I18NStrings.CSV_META_CREATION_LABEL), df.format(new Date()));
gernotbelger@9000: 
gernotbelger@9000:         // "# Gewässer: "
gernotbelger@9000:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_RIVER, msg(I18NStrings.CSV_META_RIVER_LABEL), river.getName());
gernotbelger@9000: 
gernotbelger@9000:         // "# Höhensystem des Flusses: "
gernotbelger@9000:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit());
gernotbelger@9000: 
gernotbelger@9000:         if (calcRange != null) {
gernotbelger@9000:             // "# Ort/Bereich (km): "
gernotbelger@9000:             writeCSVMetaEntry(writer, I18NStrings.CSV_META_RANGE, msg(I18NStrings.CSV_META_RANGE_LABEL), getKmFormatter().format(calcRange.getMinimumDouble()),
gernotbelger@9000:                     getKmFormatter().format(calcRange.getMaximumDouble()));
gernotbelger@9000:         }
gernotbelger@9000:     }
gernotbelger@9000: 
gernotbelger@9000:     @Override
gernotbelger@9000:     protected void addJRMetaData(final MetaAndTableJRDataSource source, final RESULTS results) {
gernotbelger@9000: 
gernotbelger@9000:         /* general metadata */
gernotbelger@9000:         this.addJRMetaDataDefaults(source, results);
gernotbelger@8946: 
gernotbelger@8946:         final RiverInfo river = results.getRiver();
gernotbelger@8946:         final String wstUnitName = river.getWstUnit();
gernotbelger@8946: 
gernotbelger@9000:         source.addMetaData("river_label", msg(I18NStrings.CSV_META_RIVER_LABEL));
gernotbelger@8946:         source.addMetaData("river", river.getName());
gernotbelger@8946:         source.addMetaData("river_unit", wstUnitName);
gernotbelger@8946: 
gernotbelger@8946:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@8946:         final NumberFormat kmFormatter = getKmFormatter();
gernotbelger@8946:         final String rangeValue = String.format("%s - %s", kmFormatter.format(calcRange.getMinimumDouble()), kmFormatter.format(calcRange.getMaximumDouble()));
gernotbelger@9000:         source.addMetaData("range_label", msg(I18NStrings.CSV_META_RANGE_LABEL));
gernotbelger@8946:         source.addMetaData("range", rangeValue);
gernotbelger@9000: 
gernotbelger@9000:         /* column headings */
gernotbelger@9000:         // source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta())); // moved to
gernotbelger@9000:         // super
gernotbelger@9000: 
gernotbelger@9000:         // TODO: move to subs
gernotbelger@9000:         /* column headings */
gernotbelger@9000:         source.addMetaData("flowdepth_header", SInfoResultType.flowdepth.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("flowdepth_tkh_header", SInfoResultType.flowdepthtkh.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("tkh_header", SInfoResultType.tkh.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("waterlevel_header", SInfoResultType.waterlevel.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("discharge_header", SInfoResultType.discharge.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("waterlevel_name_header", SInfoResultType.waterlevelLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("gauge_header", SInfoResultType.gaugeLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("bedheight_header", SInfoResultType.meanBedHeight.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("sounding_name_header", SInfoResultType.soundingLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:         source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta()));
gernotbelger@8946:     }
gernotbelger@9000: 
gernotbelger@9000:     @Override
gernotbelger@9000:     protected void addJRMetaDataDefaults(final MetaAndTableJRDataSource source, final RESULTS results) {
gernotbelger@9000: 
gernotbelger@9000:         source.addMetaData("header", msg(I18NStrings.CSV_META_HEADER_RESULT_LABEL));
gernotbelger@9000:         source.addMetaData("calcMode", results.getCalcModeLabel());
gernotbelger@9000: 
gernotbelger@9000:         source.addMetaData("version_label", msg(I18NStrings.CSV_META_VERSION_LABEL));
gernotbelger@9000:         source.addMetaData("version", FLYS.VERSION);
gernotbelger@9000: 
gernotbelger@9000:         source.addMetaData("user_label", msg(I18NStrings.CSV_META_USER_LABEL));
gernotbelger@9000:         source.addMetaData("user", results.getUser());
gernotbelger@9000: 
gernotbelger@9000:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@9000:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@9000:         source.addMetaData("date_label", msg(I18NStrings.CSV_META_CREATION_LABEL));
gernotbelger@9000:         source.addMetaData("date", df.format(new Date()));
gernotbelger@9000: 
gernotbelger@9000:         /* column headings */
gernotbelger@9000:         source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta()));
gernotbelger@9000:     }
gernotbelger@9000: 
gernotbelger@8928: }