gernotbelger@9150: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@9150:  * Software engineering by
gernotbelger@9150:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@9150:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@9150:  *
gernotbelger@9150:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@9150:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@9150:  * documentation coming with Dive4Elements River for details.
gernotbelger@9150:  */
gernotbelger@9150: package org.dive4elements.river.artifacts.common;
gernotbelger@9150: 
gernotbelger@9150: import java.text.DateFormat;
gernotbelger@9150: import java.text.NumberFormat;
gernotbelger@9171: import java.util.ArrayList;
gernotbelger@9171: import java.util.Collection;
gernotbelger@9150: import java.util.Date;
gernotbelger@9150: import java.util.Locale;
gernotbelger@9150: 
gernotbelger@9150: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@9150: import org.dive4elements.artifacts.CallContext;
gernotbelger@9150: import org.dive4elements.artifacts.CallMeta;
gernotbelger@9150: import org.dive4elements.river.FLYS;
gernotbelger@9150: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@9150: import org.dive4elements.river.artifacts.sinfo.common.SInfoI18NStrings;
gernotbelger@9150: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
gernotbelger@9150: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@9150: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@9150: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@9150: import org.dive4elements.river.utils.Formatter;
gernotbelger@9150: 
gernotbelger@9150: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@9150: 
gernotbelger@9150: /**
gernotbelger@9150:  * @author Domenico Nardi Tironi
gernotbelger@9150:  *
gernotbelger@9150:  */
gernotbelger@9150: public final class ExportContextCSV {
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_EVALUATOR = "sinfo.export.flow_depth.csv.meta.header.sounding.evaluator";
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_SOUNDING = "sinfo.export.flow_depth.csv.meta.header.sounding";
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_SOUNDING_YEAR = "sinfo.export.flow_depth.csv.meta.header.sounding.year";
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_SOUNDING_TYPE = "sinfo.export.flow_depth.csv.meta.header.sounding.type";
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_SOUNDING_PRJ = "sinfo.export.flow_depth.csv.meta.header.sounding.prj";
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel";
gernotbelger@9150: 
gernotbelger@9150:     private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel.original";
gernotbelger@9150: 
gernotbelger@9188:     private NumberFormat qFormat = null;
gernotbelger@9150: 
gernotbelger@9188:     private NumberFormat flowDepthFormat = null;
gernotbelger@9150: 
gernotbelger@9188:     private NumberFormat kmFormat = null;
gernotbelger@9150: 
gernotbelger@9150:     /** The CallContext object. */
gernotbelger@9150:     private final CallContext context;
gernotbelger@9150: 
gernotbelger@9150:     private final CSVWriter writer;
gernotbelger@9150: 
gernotbelger@9150:     public ExportContextCSV(final CallContext context, final CSVWriter writer) {
gernotbelger@9150:         this.context = context;
gernotbelger@9150:         this.writer = writer;
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     private String msg(final String key) {
gernotbelger@9150:         return Resources.getMsg(this.context.getMeta(), key, key);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public String msg(final String key, final Object... args) {
gernotbelger@9150:         return Resources.getMsg(this.context.getMeta(), key, key, args);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public final void writeCSVMetaEntry(final String message, final Object... messageArgs) {
gernotbelger@9150: 
gernotbelger@9150:         final CallMeta meta = this.context.getMeta();
gernotbelger@9150: 
gernotbelger@9150:         this.writer.writeNext(new String[] { Resources.getMsg(meta, message, message, messageArgs) });
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public void writeBlankLine() {
gernotbelger@9150:         writeCSVLine(new String[] { "" });
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     // *** CUSTOM STUFF that is used multiple times ***///
gernotbelger@9150: 
gernotbelger@9150:     public final void writeCSVSoundingMetadata(final BedHeightInfo sounding) {
gernotbelger@9150:         // "##METADATEN PEILUNG"
gernotbelger@9154:         writeCSVSoundingMetadata(sounding, CSV_META_HEADER_SOUNDING);
gernotbelger@9150: 
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public void writeCSVLine(final String[] line) {
gernotbelger@9150:         this.writer.writeNext(line);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public String formatCsvHeader(final IResultType type) {
gernotbelger@9150:         return msg(type.getCsvHeader());
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public String formatRowValue(final ResultRow row, final IResultType type) {
gernotbelger@9150:         return row.exportValue(this.context, type);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public void addJRMetadata(final MetaAndTableJRDataSource source, final String key, final IResultType type) {
gernotbelger@9150:         source.addMetaData(key, type.getPdfHeader(this.context.getMeta()));
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9188:     public final void writeCSVGlobalMetadataDefaults(final AbstractCalculationResults<?> results) {
gernotbelger@9150:         // TODO: results as member
gernotbelger@9150:         final String calcModeLabel = results.getCalcModeLabel();
gernotbelger@9150:         final RiverInfo river = results.getRiver();
gernotbelger@9150:         final DoubleRange calcRange = results.getCalcRange();
gernotbelger@9150: 
gernotbelger@9150:         writeCSVMetaEntry(I18NStrings.CSV_META_HEADER_RESULT, msg(I18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel);
gernotbelger@9150: 
gernotbelger@9150:         // "# FLYS-Version: "
gernotbelger@9150:         writeCSVMetaEntry(I18NStrings.CSV_META_VERSION, msg(I18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION);
gernotbelger@9150: 
gernotbelger@9150:         // "# Bearbeiter: "
gernotbelger@9150:         writeCSVMetaEntry(I18NStrings.CSV_META_USER, msg(I18NStrings.CSV_META_USER_LABEL), results.getUser());
gernotbelger@9150: 
gernotbelger@9150:         // "# Datum der Erstellung: "
gernotbelger@9150:         final Locale locale = Resources.getLocale(this.context.getMeta());
gernotbelger@9150:         final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
gernotbelger@9150:         writeCSVMetaEntry(I18NStrings.CSV_META_CREATION, msg(I18NStrings.CSV_META_CREATION_LABEL), df.format(new Date()));
gernotbelger@9150: 
gernotbelger@9150:         // "# Gewässer: "
gernotbelger@9150:         writeCSVMetaEntry(I18NStrings.CSV_META_RIVER, msg(I18NStrings.CSV_META_RIVER_LABEL), river.getName());
gernotbelger@9150: 
gernotbelger@9150:         // "# Höhensystem des Flusses: "
gernotbelger@9150:         writeCSVMetaEntry(I18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit());
gernotbelger@9150: 
gernotbelger@9150:         if (calcRange != null) {
gernotbelger@9150:             // "# Ort/Bereich (km): "
gernotbelger@9150:             writeCSVMetaEntry(I18NStrings.CSV_META_RANGE, msg(I18NStrings.CSV_META_RANGE_LABEL), getKmFormatter().format(calcRange.getMinimumDouble()),
gernotbelger@9150:                     getKmFormatter().format(calcRange.getMaximumDouble()));
gernotbelger@9150:         }
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public final void writeCSVWaterlevelMetadata(final WstInfo wst) {
gernotbelger@9150:         writeCSVWaterlevelMetadata(wst, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL); // default Label; used in 99%
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public final void writeCSVWaterlevelMetadata(final WstInfo wst, final String mainLabel) {
gernotbelger@9150:         // "##METADATEN WASSERSPIEGELLAGE"
gernotbelger@9150:         writeCSVMetaEntry(mainLabel);
gernotbelger@9150: 
gernotbelger@9150:         // "# Bezeichnung der Wasserspiegellage: "
gernotbelger@9150:         writeCSVMetaEntry(SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_NAME, wst.getLabel());
gernotbelger@9150: 
gernotbelger@9150:         // "# Bezugspegel: "
gernotbelger@9150:         writeCSVMetaEntry(SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_GAUGE, wst.getGauge());
gernotbelger@9150: 
gernotbelger@9150:         // "# Jahr/Zeitraum der Wasserspiegellage: "
gernotbelger@9150:         final int year = wst.getYear();
gernotbelger@9150:         if (year > 0)
gernotbelger@9150:             writeCSVMetaEntry(SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_YEAR, Integer.toString(year));
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     // copy from AbstractExporter TODO merge with ExportContextPDF
gernotbelger@9150:     protected NumberFormat getKmFormatter() {
gernotbelger@9150: 
gernotbelger@9188:         if (this.kmFormat == null)
gernotbelger@9150:             this.kmFormat = Formatter.getWaterlevelKM(this.context);
gernotbelger@9188: 
gernotbelger@9150:         return this.kmFormat;
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public void addJRMetadata(final MetaAndTableJRDataSource source, final String key, final String msg) {
gernotbelger@9150:         source.addMetaData(key, msg);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public NumberFormat getQFormatter() {
gernotbelger@9188:         if (this.qFormat == null)
gernotbelger@9150:             this.qFormat = Formatter.getWaterlevelQ(this.context);
gernotbelger@9188: 
gernotbelger@9150:         return this.qFormat;
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public final NumberFormat getFlowDepthFormatter() {
gernotbelger@9150:         if (this.flowDepthFormat == null)
gernotbelger@9150:             this.flowDepthFormat = Formatter.getFlowDepth(this.context);
gernotbelger@9188: 
gernotbelger@9150:         return this.flowDepthFormat;
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     /**
gernotbelger@9150:      * Formats header with unit: msg [unit]
gernotbelger@9150:      */
gernotbelger@9150: 
gernotbelger@9150:     public String msgUnitCSV(final IResultType typeWithUnit) { // TODO: use generic Type!
gernotbelger@9150:         final String unit = msg(typeWithUnit.getUnit());
gernotbelger@9150:         return msgUnitCSV(typeWithUnit, unit);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public String msgUnitCSV(final IResultType type, final String unit) {
gernotbelger@9150:         final String msg = msg(type.getCsvHeader());
gernotbelger@9150:         return String.format("%s [%s]", msg, unit);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9154:     public void writeCSVSoundingMetadata(final BedHeightInfo sounding, final String label) {
gernotbelger@9154: 
gernotbelger@9154:         // "##METADATEN PEILUNG"
gernotbelger@9154:         writeCSVMetaEntry(label);
gernotbelger@9154: 
gernotbelger@9154:         // "# Jahr der Peilung: "
gernotbelger@9154:         writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_YEAR, Integer.toString(sounding.getYear()));
gernotbelger@9154:         // "# Aufnahmeart: "
gernotbelger@9154:         writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_TYPE, sounding.getType());
gernotbelger@9154:         // "# Auswerter: "
gernotbelger@9154:         writeCSVMetaEntry(CSV_META_HEADER_EVALUATOR, sounding.getEvaluationBy());
gernotbelger@9154:         // "# Lagesystem: "
gernotbelger@9154:         writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_PRJ, sounding.getLocationSystem());
gernotbelger@9154:         // "# Höhensystem: "
gernotbelger@9154:         writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL, sounding.getCurElevationModelUnit());
gernotbelger@9154:         // "# ursprüngliches Höhensystem: "
gernotbelger@9154:         writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL, sounding.getOldElevationModelUnit());
gernotbelger@9150: 
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public final String msgUnitLabel(final IResultType typeWithUnit, final String label) {
gernotbelger@9150:         final String msg = msg(typeWithUnit.getCsvHeader());
gernotbelger@9150:         final String unit = msg(typeWithUnit.getUnit());
gernotbelger@9150:         return String.format("%s [%s] (%s)", msg, unit, label);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     public String msgPdf(final SInfoResultType type) {
gernotbelger@9150:         return type.getPdfHeader(this.context.getMeta());
gernotbelger@9150:     }
gernotbelger@9171: 
gernotbelger@9171:     public void writeTitleForTabs(final String tabTitleMsg, final int colSize) {
gernotbelger@9171: 
gernotbelger@9171:         final Collection<String> title = new ArrayList<>(colSize);
gernotbelger@9171:         title.add(msg("export_csv_title") + msg(tabTitleMsg));
gernotbelger@9171:         writeCSVLine(title.toArray(new String[colSize]));
gernotbelger@9171:     }
gernotbelger@9150: }