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.text.DateFormat; gernotbelger@8928: import java.text.NumberFormat; gernotbelger@8928: import java.util.ArrayList; gernotbelger@8928: import java.util.Collection; gernotbelger@8928: import java.util.Date; gernotbelger@8928: import java.util.Locale; gernotbelger@8928: gernotbelger@8928: import org.apache.commons.lang.math.DoubleRange; gernotbelger@8928: import org.apache.log4j.Logger; gernotbelger@8928: import org.dive4elements.river.FLYS; gernotbelger@8928: import org.dive4elements.river.artifacts.resources.Resources; 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 { gernotbelger@8928: 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@8928: protected final void writeCSVMeta(final CSVWriter writer, final TkhCalculationResults results) { gernotbelger@8928: log.info("TkhExporter.writeCSVMeta"); gernotbelger@8928: gernotbelger@8928: final String calcModeLabel = results.getCalcModeLabel(); gernotbelger@8928: final RiverInfo river = results.getRiver(); gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_RESULT, msg(SInfoI18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel); gernotbelger@8928: gernotbelger@8928: // "# FLYS-Version: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_VERSION, msg(SInfoI18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION); gernotbelger@8928: gernotbelger@8928: // "# Bearbeiter: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_USER, msg(SInfoI18NStrings.CSV_META_USER_LABEL), results.getUser()); gernotbelger@8928: gernotbelger@8928: // "# Datum der Erstellung: " gernotbelger@8928: final Locale locale = Resources.getLocale(this.context.getMeta()); gernotbelger@8928: final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale); gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_CREATION, msg(SInfoI18NStrings.CSV_META_CREATION_LABEL), df.format(new Date())); gernotbelger@8928: gernotbelger@8928: // "# Gewässer: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_RIVER, msg(SInfoI18NStrings.CSV_META_RIVER_LABEL), river.getName()); gernotbelger@8928: gernotbelger@8928: // "# Höhensystem des Flusses: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit()); gernotbelger@8928: gernotbelger@8928: // "# Ort/Bereich (km): " gernotbelger@8928: final DoubleRange calcRange = results.getCalcRange(); gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_RANGE, msg(SInfoI18NStrings.CSV_META_RANGE_LABEL), gernotbelger@8928: getKmFormatter().format(calcRange.getMinimumDouble()), getKmFormatter().format(calcRange.getMaximumDouble())); 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@8928: @Override gernotbelger@8928: protected final void writeCSVHeader(final CSVWriter writer, final RiverInfo river) { gernotbelger@8928: log.info("TkhExporter.writeCSVHeader"); gernotbelger@8928: gernotbelger@8928: final Collection 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@8928: header.add(msgUnit(CSV_TKHKIND_HEADER, SInfoI18NStrings.UNIT_CM)); 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@8928: header.add(msg(SInfoI18NStrings.CSV_LABEL_HEADER)); 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@8928: protected void writeCSVResultHeader(final CSVWriter writer, final TkhCalculationResult result) { gernotbelger@8928: gernotbelger@8928: /* first some specific metadata */ gernotbelger@8928: final WstInfo wst = result.getWst(); gernotbelger@8928: gernotbelger@8928: // "##METADATEN WASSERSPIEGELLAGE" gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL); gernotbelger@8928: // "# Bezeichnung der Wasserspiegellage: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_NAME, wst.getLabel()); gernotbelger@8928: // "# Bezugspegel: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_GAUGE, wst.getGauge()); gernotbelger@8928: // "# Jahr/Zeitraum der Wasserspiegellage: " gernotbelger@8928: writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_YEAR, Integer.toString(wst.getYear())); gernotbelger@8928: } gernotbelger@8928: gernotbelger@8928: @Override gernotbelger@8928: protected final String[] formatCSVRow(final TkhResultRow row) { gernotbelger@8928: return formatRow(row); 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@8928: * @param useTkh gernotbelger@8928: */ gernotbelger@8928: private String[] formatRow(final TkhResultRow row) { gernotbelger@8928: gernotbelger@8928: final Collection 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@8928: 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: final RiverInfo river = results.getRiver(); gernotbelger@8928: final String wstUnitName = river.getWstUnit(); gernotbelger@8928: gernotbelger@8928: /* general metadata */ gernotbelger@8928: source.addMetaData("header", msg(SInfoI18NStrings.CSV_META_HEADER_RESULT_LABEL)); gernotbelger@8928: source.addMetaData("calcMode", results.getCalcModeLabel()); gernotbelger@8928: gernotbelger@8928: source.addMetaData("version_label", msg(SInfoI18NStrings.CSV_META_VERSION_LABEL)); gernotbelger@8928: source.addMetaData("version", FLYS.VERSION); gernotbelger@8928: gernotbelger@8928: source.addMetaData("user_label", msg(SInfoI18NStrings.CSV_META_USER_LABEL)); gernotbelger@8928: source.addMetaData("user", results.getUser()); gernotbelger@8928: gernotbelger@8928: final Locale locale = Resources.getLocale(this.context.getMeta()); gernotbelger@8928: final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale); gernotbelger@8928: source.addMetaData("date_label", msg(SInfoI18NStrings.CSV_META_CREATION_LABEL)); gernotbelger@8928: source.addMetaData("date", df.format(new Date())); gernotbelger@8928: gernotbelger@8928: source.addMetaData("river_label", msg(SInfoI18NStrings.CSV_META_RIVER_LABEL)); gernotbelger@8928: source.addMetaData("river", river.getName()); gernotbelger@8928: source.addMetaData("river_unit", wstUnitName); gernotbelger@8928: gernotbelger@8928: final DoubleRange calcRange = results.getCalcRange(); gernotbelger@8928: final NumberFormat kmFormatter = getKmFormatter(); gernotbelger@8928: final String rangeValue = String.format("%s - %s", kmFormatter.format(calcRange.getMinimumDouble()), kmFormatter.format(calcRange.getMaximumDouble())); gernotbelger@8928: source.addMetaData("range_label", msg(SInfoI18NStrings.CSV_META_RANGE_LABEL)); gernotbelger@8928: source.addMetaData("range", rangeValue); 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@8928: source.addMetaData("waterlevel_name_header", msg(SInfoI18NStrings.CSV_LABEL_HEADER)); 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@8928: protected final String[] formatPDFRow(final TkhResultRow row) { gernotbelger@8928: return formatRow(row); gernotbelger@8928: } gernotbelger@8928: }