Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhstate/TkhExporter.java @ 8938:9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
| author | gernotbelger |
|---|---|
| date | Tue, 06 Mar 2018 17:09:39 +0100 |
| parents | 791714b92b5c |
| children | 5d5d482da3e9 |
| rev | line source |
|---|---|
| 8928 | 1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde |
| 2 * Software engineering by Intevation GmbH | |
| 3 * | |
| 4 * This file is Free Software under the GNU AGPL (>=v3) | |
| 5 * and comes with ABSOLUTELY NO WARRANTY! Check out the | |
| 6 * documentation coming with Dive4Elements River for details. | |
| 7 */ | |
| 8 | |
| 9 package org.dive4elements.river.artifacts.sinfo.tkhstate; | |
| 10 | |
| 11 import java.text.DateFormat; | |
| 12 import java.text.NumberFormat; | |
| 13 import java.util.ArrayList; | |
| 14 import java.util.Collection; | |
| 15 import java.util.Date; | |
| 16 import java.util.Locale; | |
| 17 | |
| 18 import org.apache.commons.lang.math.DoubleRange; | |
| 19 import org.apache.log4j.Logger; | |
| 20 import org.dive4elements.river.FLYS; | |
| 21 import org.dive4elements.river.artifacts.resources.Resources; | |
| 22 import org.dive4elements.river.artifacts.sinfo.SInfoI18NStrings; | |
| 23 import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter; | |
| 24 import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource; | |
| 25 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; | |
| 26 import org.dive4elements.river.artifacts.sinfo.util.WstInfo; | |
| 27 import org.dive4elements.river.utils.RiverUtils; | |
| 28 | |
| 29 import au.com.bytecode.opencsv.CSVWriter; | |
| 30 | |
| 31 /** | |
| 32 * Generates different output formats (csv, pdf) of data that resulted from a tkh computation. | |
| 33 * | |
| 34 * @author Gernot Belger | |
| 35 */ | |
| 36 // REMARK: must be public because its registered in generators.xml | |
| 37 public class TkhExporter extends AbstractSInfoExporter<TkhResultRow, TkhCalculationResult, TkhCalculationResults> { | |
| 38 | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
39 private static enum ExportMode { |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
40 pdf, csv |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
41 } |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
42 |
| 8928 | 43 /** The log used in this exporter. */ |
| 44 private static Logger log = Logger.getLogger(TkhExporter.class); | |
| 45 | |
| 46 private static final String CSV_META_CALCULATION_FORMULA = "sinfo.export.tkh.calculation.formula"; | |
| 47 | |
| 48 private static final String CSV_TKH_HEADER = "sinfo.export.tkh.csv.header.tkh"; | |
| 49 | |
| 50 private static final String CSV_TKHKIND_HEADER = "sinfo.export.tkh.csv.header.tkhkind"; | |
| 51 | |
| 52 private static final String PREFIX_TKH_KIND = "sinfo.export.tkh.soilkind."; | |
| 53 | |
| 54 private static final String CSV_MEAN_BED_HEIGHT_HEADER_SHORT = "sinfo.export.flow_depth.csv.header.mean_bed_height.short"; | |
| 55 | |
| 56 private static final String JASPER_FILE = "/jasper/sinfo.flowdepth.jasper"; | |
| 57 | |
| 58 @Override | |
| 59 protected Logger getLog() { | |
| 60 return log; | |
| 61 } | |
| 62 | |
| 63 @Override | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
64 protected void writeCSVGlobalMetadata(final CSVWriter writer, final TkhCalculationResults results) { |
| 8928 | 65 log.info("TkhExporter.writeCSVMeta"); |
| 66 | |
| 67 final String calcModeLabel = results.getCalcModeLabel(); | |
| 68 final RiverInfo river = results.getRiver(); | |
| 69 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_RESULT, msg(SInfoI18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel); | |
| 70 | |
| 71 // "# FLYS-Version: " | |
| 72 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_VERSION, msg(SInfoI18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION); | |
| 73 | |
| 74 // "# Bearbeiter: " | |
| 75 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_USER, msg(SInfoI18NStrings.CSV_META_USER_LABEL), results.getUser()); | |
| 76 | |
| 77 // "# Datum der Erstellung: " | |
| 78 final Locale locale = Resources.getLocale(this.context.getMeta()); | |
| 79 final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale); | |
| 80 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_CREATION, msg(SInfoI18NStrings.CSV_META_CREATION_LABEL), df.format(new Date())); | |
| 81 | |
| 82 // "# Gewässer: " | |
| 83 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_RIVER, msg(SInfoI18NStrings.CSV_META_RIVER_LABEL), river.getName()); | |
| 84 | |
| 85 // "# Höhensystem des Flusses: " | |
| 86 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit()); | |
| 87 | |
| 88 // "# Ort/Bereich (km): " | |
| 89 final DoubleRange calcRange = results.getCalcRange(); | |
| 90 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_RANGE, msg(SInfoI18NStrings.CSV_META_RANGE_LABEL), | |
| 91 getKmFormatter().format(calcRange.getMinimumDouble()), getKmFormatter().format(calcRange.getMaximumDouble())); | |
| 92 | |
| 93 // "# Berechnungsgrundlage: Gleichung nach GILL (1971)" | |
| 94 writeCSVMetaEntry(writer, CSV_META_CALCULATION_FORMULA); | |
| 95 | |
| 96 writer.writeNext(new String[] { "" }); | |
| 97 } | |
| 98 | |
| 99 /** | |
| 100 * Write the header, with different headings depending on whether at a gauge or at a location. | |
| 101 */ | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
102 |
| 8928 | 103 @Override |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
104 protected void writeCSVHeader(final CSVWriter writer, final TkhCalculationResults results, final RiverInfo river) { |
| 8928 | 105 log.info("TkhExporter.writeCSVHeader"); |
| 106 | |
| 107 final Collection<String> header = new ArrayList<>(11); | |
| 108 | |
| 109 header.add(msg(SInfoI18NStrings.CSV_KM_HEADER)); | |
| 110 header.add(msgUnit(CSV_TKH_HEADER, SInfoI18NStrings.UNIT_CM)); | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
111 header.add(msg(CSV_TKHKIND_HEADER)); |
| 8928 | 112 header.add(msgUnit(SInfoI18NStrings.CSV_MEAN_BED_HEIGHT_HEADER, river.getWstUnit())); |
| 113 | |
| 114 header.add(msgUnit(SInfoI18NStrings.CSV_WATERLEVEL_HEADER, river.getWstUnit())); | |
| 115 header.add(msgUnit(SInfoI18NStrings.CSV_DISCHARGE_HEADER, SInfoI18NStrings.UNIT_CUBIC_M)); | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
116 |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
117 final String descriptionHeader = results.getDescriptionHeader(); |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
118 if (descriptionHeader != null) |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
119 header.add(msg(descriptionHeader)); |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
120 |
| 8928 | 121 header.add(msg(SInfoI18NStrings.CSV_GAUGE_HEADER)); |
| 122 header.add(msg(SInfoI18NStrings.CSV_LOCATION_HEADER)); | |
| 123 | |
| 124 writer.writeNext(header.toArray(new String[header.size()])); | |
| 125 } | |
| 126 | |
| 127 @Override | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
128 // FIXME: rename |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
129 protected void writeCSVResultMetadata(final CSVWriter writer, final TkhCalculationResults results, final TkhCalculationResult result) { |
| 8928 | 130 |
| 131 /* first some specific metadata */ | |
| 132 final WstInfo wst = result.getWst(); | |
| 133 | |
| 134 // "##METADATEN WASSERSPIEGELLAGE" | |
| 135 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL); | |
| 136 // "# Bezeichnung der Wasserspiegellage: " | |
| 137 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_NAME, wst.getLabel()); | |
| 138 // "# Bezugspegel: " | |
| 139 writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_GAUGE, wst.getGauge()); | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
140 // // "# Jahr/Zeitraum der Wasserspiegellage: " |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
141 // writeCSVMetaEntry(writer, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_YEAR, Integer.toString(wst.getYear())); |
| 8928 | 142 } |
| 143 | |
| 144 @Override | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
145 protected String[] formatCSVRow(final TkhCalculationResults results, final TkhResultRow row) { |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
146 return formatRow(results, row, ExportMode.csv); |
| 8928 | 147 } |
| 148 | |
| 149 /** | |
| 150 * Format a row of a flow depth result into an array of string, both used by csv and pdf | |
| 151 * | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
152 * @param results |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
153 * |
| 8928 | 154 * @param useTkh |
| 155 */ | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
156 private String[] formatRow(final TkhCalculationResults results, final TkhResultRow row, final ExportMode mode) { |
| 8928 | 157 |
| 158 final Collection<String> lines = new ArrayList<>(11); | |
| 159 | |
| 160 // Fluss-km | |
| 161 lines.add(getKmFormatter().format(row.getStation())); | |
| 162 | |
| 163 // TKH [cm] | |
| 164 lines.add(getTkhFormatter().format(row.getTkh())); | |
| 165 | |
| 166 // Einteilung der Gewässersohle (starr/mobil) | |
| 167 lines.add(msg(PREFIX_TKH_KIND + row.getTkhKind().name())); | |
| 168 | |
| 169 // Mittlere Sohlhöhe [NN + m] | |
| 170 lines.add(getMeanBedHeighFormatter().format(row.getMeanBedHeight())); | |
| 171 | |
| 172 // Wasserstand [NN + m] | |
| 173 lines.add(getW2Formatter().format(row.getWaterlevel())); | |
| 174 | |
| 175 // Q [m³/s] | |
| 176 final double discharge = row.getDischarge(); | |
| 177 final double roundedDischarge = RiverUtils.roundQ(discharge); | |
| 178 lines.add(getQFormatter().format(roundedDischarge)); | |
| 179 | |
| 180 // Bezeichnung | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
181 // REMARK: always export this column in pdf-mode, because WInfo also does it (no need for two jasper-templates). |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
182 if (results.getDescriptionHeader() != null || mode == ExportMode.pdf) |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
183 lines.add(row.getWaterlevelLabel()); |
| 8928 | 184 |
| 185 // Bezugspegel | |
| 186 lines.add(row.getGauge()); | |
| 187 | |
| 188 // Lage | |
| 189 lines.add(row.getLocation()); | |
| 190 | |
| 191 return lines.toArray(new String[lines.size()]); | |
| 192 } | |
| 193 | |
| 194 @Override | |
| 195 protected final String getJasperFile() { | |
| 196 return JASPER_FILE; | |
| 197 } | |
| 198 | |
| 199 @Override | |
| 200 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final TkhCalculationResults results) { | |
| 201 | |
| 202 final RiverInfo river = results.getRiver(); | |
| 203 final String wstUnitName = river.getWstUnit(); | |
| 204 | |
| 205 /* general metadata */ | |
| 206 source.addMetaData("header", msg(SInfoI18NStrings.CSV_META_HEADER_RESULT_LABEL)); | |
| 207 source.addMetaData("calcMode", results.getCalcModeLabel()); | |
| 208 | |
| 209 source.addMetaData("version_label", msg(SInfoI18NStrings.CSV_META_VERSION_LABEL)); | |
| 210 source.addMetaData("version", FLYS.VERSION); | |
| 211 | |
| 212 source.addMetaData("user_label", msg(SInfoI18NStrings.CSV_META_USER_LABEL)); | |
| 213 source.addMetaData("user", results.getUser()); | |
| 214 | |
| 215 final Locale locale = Resources.getLocale(this.context.getMeta()); | |
| 216 final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale); | |
| 217 source.addMetaData("date_label", msg(SInfoI18NStrings.CSV_META_CREATION_LABEL)); | |
| 218 source.addMetaData("date", df.format(new Date())); | |
| 219 | |
| 220 source.addMetaData("river_label", msg(SInfoI18NStrings.CSV_META_RIVER_LABEL)); | |
| 221 source.addMetaData("river", river.getName()); | |
| 222 source.addMetaData("river_unit", wstUnitName); | |
| 223 | |
| 224 final DoubleRange calcRange = results.getCalcRange(); | |
| 225 final NumberFormat kmFormatter = getKmFormatter(); | |
| 226 final String rangeValue = String.format("%s - %s", kmFormatter.format(calcRange.getMinimumDouble()), kmFormatter.format(calcRange.getMaximumDouble())); | |
| 227 source.addMetaData("range_label", msg(SInfoI18NStrings.CSV_META_RANGE_LABEL)); | |
| 228 source.addMetaData("range", rangeValue); | |
| 229 | |
| 230 /* column headings */ | |
| 231 source.addMetaData("station_header", msg(SInfoI18NStrings.CSV_KM_HEADER)); | |
| 232 source.addMetaData("tkh_header", msg(CSV_TKH_HEADER)); | |
| 233 source.addMetaData("bedheight_header", msg(CSV_MEAN_BED_HEIGHT_HEADER_SHORT)); | |
| 234 source.addMetaData("waterlevel_header", msg(SInfoI18NStrings.CSV_WATERLEVEL_HEADER)); | |
| 235 source.addMetaData("discharge_header", msg(SInfoI18NStrings.CSV_DISCHARGE_HEADER)); | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
236 |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
237 // REMARK: actually the column makes no sense if description header is null. But (software symmetry...) WINFO also |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
238 // writes an empty column into the pdf in that case (most probably to avoid the need for two jasper templates). |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
239 final String descriptionHeader = results.getDescriptionHeader(); |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
240 final String waterlevelNameHeader = descriptionHeader == null ? msg(SInfoI18NStrings.CSV_LABEL_HEADER) : descriptionHeader; |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
241 source.addMetaData("waterlevel_name_header", waterlevelNameHeader); |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
242 |
| 8928 | 243 source.addMetaData("gauge_header", msg(SInfoI18NStrings.CSV_GAUGE_HEADER)); |
| 244 source.addMetaData("location_header", msg(SInfoI18NStrings.CSV_LOCATION_HEADER)); | |
| 245 } | |
| 246 | |
| 247 @Override | |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
248 protected String[] formatPDFRow(final TkhCalculationResults results, final TkhResultRow row) { |
|
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
249 return formatRow(results, row, ExportMode.pdf); |
| 8928 | 250 } |
| 251 } |