gernotbelger@8996: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8996:  * Software engineering by
gernotbelger@8996:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8996:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8996:  *
gernotbelger@8996:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8996:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8996:  * documentation coming with Dive4Elements River for details.
gernotbelger@8996:  */
gernotbelger@8996: package org.dive4elements.river.artifacts.uinfo.commons;
gernotbelger@8996: 
gernotbelger@8996: import java.text.DateFormat;
gernotbelger@8996: import java.text.NumberFormat;
gernotbelger@8996: import java.util.Date;
gernotbelger@8996: import java.util.Locale;
gernotbelger@8996: 
gernotbelger@8996: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@8996: import org.dive4elements.river.FLYS;
gernotbelger@8996: import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
gernotbelger@8996: import org.dive4elements.river.artifacts.common.AbstractCalculationResults;
gernotbelger@8996: import org.dive4elements.river.artifacts.common.AbstractCommonExporter;
gernotbelger@8996: import org.dive4elements.river.artifacts.common.I18NStrings;
gernotbelger@9006: import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
gernotbelger@8996: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8996: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8996: 
gernotbelger@8996: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@8996: 
gernotbelger@8996: /**
gernotbelger@8996:  * @author Gernot Belger
gernotbelger@8996:  */
gernotbelger@8996: public abstract class AbstractUInfoExporter<RESULT extends AbstractCalculationResult, RESULTS extends AbstractCalculationResults<RESULT>> extends AbstractCommonExporter<RESULT, RESULTS> {
gernotbelger@8996: 
gernotbelger@8996:     @Override
gernotbelger@8996:     protected void addJRMetaData(final MetaAndTableJRDataSource source, final RESULTS results) {
gernotbelger@8996: 
gernotbelger@8996:         /* general metadata */
gernotbelger@8996:         this.addJRMetaDataDefaults(source, results);
gernotbelger@8996: 
gernotbelger@8996:         /* general metadata */
gernotbelger@8996:         this.addJRMetaDataDefaults(source, results);
gernotbelger@8996: 
gernotbelger@8996:         final RiverInfo river = results.getRiver();
gernotbelger@8996:         final String wstUnitName = river.getWstUnit();
gernotbelger@8996: 
gernotbelger@8996:         source.addMetaData("river_label", msg(I18NStrings.CSV_META_RIVER_LABEL));
gernotbelger@8996:         source.addMetaData("river", river.getName());
gernotbelger@8996:         source.addMetaData("river_unit", wstUnitName);
gernotbelger@8996: 
gernotbelger@8996:         source.addMetaData("range_label", msg(I18NStrings.CSV_META_RANGE_LABEL));
gernotbelger@8996:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@8996:         final NumberFormat kmFormatter = getKmFormatter();
gernotbelger@8996:         if (calcRange != null) {
gernotbelger@8996:             final String rangeValue = String.format("%s - %s", kmFormatter.format(calcRange.getMinimumDouble()),
gernotbelger@8996:                     kmFormatter.format(calcRange.getMaximumDouble()));
gernotbelger@8996:             source.addMetaData("range", rangeValue);
gernotbelger@8996:         }
gernotbelger@8996: 
gernotbelger@8996:         /* column headings */
gernotbelger@8996:         // source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta())); // moved to
gernotbelger@8996:         // super
gernotbelger@8996: 
gernotbelger@8996:         // TODO: move to subs
gernotbelger@8996:         // source.addMetaData("flowdepth_header", SInfoResultType.flowdepth.getPdfHeader(this.context.getMeta()));
gernotbelger@8996:         // source.addMetaData("flowdepth_tkh_header", SInfoResultType.flowdepthtkh.getPdfHeader(this.context.getMeta()));
gernotbelger@8996:         // source.addMetaData("tkh_header", SInfoResultType.tkh.getPdfHeader(this.context.getMeta()));
gernotbelger@8996:         // source.addMetaData("waterlevel_header", SInfoResultType.waterlevel.getPdfHeader(this.context.getMeta()));
gernotbelger@8996:         // source.addMetaData("discharge_header", SInfoResultType.discharge.getPdfHeader(this.context.getMeta()));
gernotbelger@8996: 
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     @Override
gernotbelger@8996:     protected void writeCSVGlobalMetadataDefaults(final CSVWriter writer, final RESULTS results) {
gernotbelger@8996: 
gernotbelger@8996:         final String calcModeLabel = results.getCalcModeLabel();
gernotbelger@8996:         final RiverInfo river = results.getRiver();
gernotbelger@8996:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@8996: 
gernotbelger@8996:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_HEADER_RESULT, msg(I18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel);
gernotbelger@8996: 
gernotbelger@8996:         // "# FLYS-Version: "
gernotbelger@8996:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_VERSION, msg(I18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION);
gernotbelger@8996: 
gernotbelger@8996:         // "# Bearbeiter: "
gernotbelger@8996:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_USER, msg(I18NStrings.CSV_META_USER_LABEL), results.getUser());
gernotbelger@8996: 
gernotbelger@8996:         // "# Datum der Erstellung: "
gernotbelger@8996:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@8996:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@8996:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_CREATION, msg(I18NStrings.CSV_META_CREATION_LABEL), df.format(new Date()));
gernotbelger@8996: 
gernotbelger@8996:         // "# Gewässer: "
gernotbelger@8996:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_RIVER, msg(I18NStrings.CSV_META_RIVER_LABEL), river.getName());
gernotbelger@8996: 
gernotbelger@8996:         // "# Höhensystem des Flusses: "
gernotbelger@8996:         writeCSVMetaEntry(writer, I18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit()); // move to child?
gernotbelger@8996: 
gernotbelger@8996:         if (calcRange != null) {
gernotbelger@8996:             // "# Ort/Bereich (km): "
gernotbelger@8996:             writeCSVMetaEntry(writer, I18NStrings.CSV_META_RANGE, msg(I18NStrings.CSV_META_RANGE_LABEL), getKmFormatter().format(calcRange.getMinimumDouble()),
gernotbelger@8996:                     getKmFormatter().format(calcRange.getMaximumDouble()));
gernotbelger@8996:         }
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     @Override
gernotbelger@8996:     protected void addJRMetaDataDefaults(final MetaAndTableJRDataSource source, final RESULTS results) {
gernotbelger@8996: 
gernotbelger@8996:         source.addMetaData("header", msg(I18NStrings.CSV_META_HEADER_RESULT_LABEL));
gernotbelger@8996:         source.addMetaData("calcMode", results.getCalcModeLabel());
gernotbelger@8996: 
gernotbelger@8996:         source.addMetaData("version_label", msg(I18NStrings.CSV_META_VERSION_LABEL));
gernotbelger@8996:         source.addMetaData("version", FLYS.VERSION);
gernotbelger@8996: 
gernotbelger@8996:         source.addMetaData("user_label", msg(I18NStrings.CSV_META_USER_LABEL));
gernotbelger@8996:         source.addMetaData("user", results.getUser());
gernotbelger@8996: 
gernotbelger@8996:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@8996:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@8996:         source.addMetaData("date_label", msg(I18NStrings.CSV_META_CREATION_LABEL));
gernotbelger@8996:         source.addMetaData("date", df.format(new Date()));
gernotbelger@8996: 
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996: }