|
9150
|
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde |
|
|
2 * Software engineering by |
|
|
3 * Björnsen Beratende Ingenieure GmbH |
|
|
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt |
|
|
5 * |
|
|
6 * This file is Free Software under the GNU AGPL (>=v3) |
|
|
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the |
|
|
8 * documentation coming with Dive4Elements River for details. |
|
|
9 */ |
|
|
10 package org.dive4elements.river.artifacts.common; |
|
|
11 |
|
|
12 import java.text.DateFormat; |
|
|
13 import java.text.NumberFormat; |
|
|
14 import java.util.Date; |
|
|
15 import java.util.Locale; |
|
|
16 |
|
|
17 import org.apache.commons.lang.math.DoubleRange; |
|
|
18 import org.dive4elements.artifacts.CallContext; |
|
|
19 import org.dive4elements.artifacts.CallMeta; |
|
|
20 import org.dive4elements.river.FLYS; |
|
|
21 import org.dive4elements.river.artifacts.resources.Resources; |
|
|
22 import org.dive4elements.river.artifacts.sinfo.common.SInfoI18NStrings; |
|
|
23 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; |
|
|
24 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo; |
|
|
25 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; |
|
|
26 import org.dive4elements.river.artifacts.sinfo.util.WstInfo; |
|
|
27 import org.dive4elements.river.utils.Formatter; |
|
|
28 |
|
|
29 import au.com.bytecode.opencsv.CSVWriter; |
|
|
30 |
|
|
31 /** |
|
|
32 * @author Domenico Nardi Tironi |
|
|
33 * |
|
|
34 */ |
|
|
35 public final class ExportContextCSV { |
|
|
36 |
|
|
37 private static final String CSV_META_HEADER_EVALUATOR = "sinfo.export.flow_depth.csv.meta.header.sounding.evaluator"; |
|
|
38 |
|
|
39 private static final String CSV_META_HEADER_SOUNDING = "sinfo.export.flow_depth.csv.meta.header.sounding"; |
|
|
40 |
|
|
41 private static final String CSV_META_HEADER_SOUNDING_YEAR = "sinfo.export.flow_depth.csv.meta.header.sounding.year"; |
|
|
42 |
|
|
43 private static final String CSV_META_HEADER_SOUNDING_TYPE = "sinfo.export.flow_depth.csv.meta.header.sounding.type"; |
|
|
44 |
|
|
45 private static final String CSV_META_HEADER_SOUNDING_PRJ = "sinfo.export.flow_depth.csv.meta.header.sounding.prj"; |
|
|
46 |
|
|
47 private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel"; |
|
|
48 |
|
|
49 private static final String CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL = "sinfo.export.flow_depth.csv.meta.header.sounding.elevationmodel.original"; |
|
|
50 |
|
|
51 private static NumberFormat qFormat = null; |
|
|
52 |
|
|
53 private static NumberFormat flowDepthFormat = null; |
|
|
54 |
|
|
55 private NumberFormat kmFormat; |
|
|
56 |
|
|
57 /** The CallContext object. */ |
|
|
58 private final CallContext context; |
|
|
59 |
|
|
60 private final CSVWriter writer; |
|
|
61 |
|
|
62 public ExportContextCSV(final CallContext context, final CSVWriter writer) { |
|
|
63 this.context = context; |
|
|
64 this.writer = writer; |
|
|
65 } |
|
|
66 |
|
|
67 private String msg(final String key) { |
|
|
68 return Resources.getMsg(this.context.getMeta(), key, key); |
|
|
69 } |
|
|
70 |
|
|
71 public String msg(final String key, final Object... args) { |
|
|
72 return Resources.getMsg(this.context.getMeta(), key, key, args); |
|
|
73 } |
|
|
74 |
|
|
75 public final void writeCSVMetaEntry(final String message, final Object... messageArgs) { |
|
|
76 |
|
|
77 final CallMeta meta = this.context.getMeta(); |
|
|
78 |
|
|
79 this.writer.writeNext(new String[] { Resources.getMsg(meta, message, message, messageArgs) }); |
|
|
80 } |
|
|
81 |
|
|
82 public void writeBlankLine() { |
|
|
83 writeCSVLine(new String[] { "" }); |
|
|
84 |
|
|
85 } |
|
|
86 |
|
|
87 // *** CUSTOM STUFF that is used multiple times ***/// |
|
|
88 |
|
|
89 public final void writeCSVSoundingMetadata(final BedHeightInfo sounding) { |
|
|
90 // "##METADATEN PEILUNG" |
|
9154
|
91 writeCSVSoundingMetadata(sounding, CSV_META_HEADER_SOUNDING); |
|
9150
|
92 |
|
|
93 } |
|
|
94 |
|
|
95 public void writeCSVLine(final String[] line) { |
|
|
96 this.writer.writeNext(line); |
|
|
97 } |
|
|
98 |
|
|
99 public String formatCsvHeader(final IResultType type) { |
|
|
100 return msg(type.getCsvHeader()); |
|
|
101 } |
|
|
102 |
|
|
103 public String formatRowValue(final ResultRow row, final IResultType type) { |
|
|
104 return row.exportValue(this.context, type); |
|
|
105 } |
|
|
106 |
|
|
107 public void addJRMetadata(final MetaAndTableJRDataSource source, final String key, final IResultType type) { |
|
|
108 source.addMetaData(key, type.getPdfHeader(this.context.getMeta())); |
|
|
109 } |
|
|
110 |
|
|
111 public final void writeCSVGlobalMetadataDefaults(final AbstractCalculationResults results) { |
|
|
112 // TODO: results as member |
|
|
113 final String calcModeLabel = results.getCalcModeLabel(); |
|
|
114 final RiverInfo river = results.getRiver(); |
|
|
115 final DoubleRange calcRange = results.getCalcRange(); |
|
|
116 |
|
|
117 writeCSVMetaEntry(I18NStrings.CSV_META_HEADER_RESULT, msg(I18NStrings.CSV_META_HEADER_RESULT_LABEL), river.getName(), calcModeLabel); |
|
|
118 |
|
|
119 // "# FLYS-Version: " |
|
|
120 writeCSVMetaEntry(I18NStrings.CSV_META_VERSION, msg(I18NStrings.CSV_META_VERSION_LABEL), FLYS.VERSION); |
|
|
121 |
|
|
122 // "# Bearbeiter: " |
|
|
123 writeCSVMetaEntry(I18NStrings.CSV_META_USER, msg(I18NStrings.CSV_META_USER_LABEL), results.getUser()); |
|
|
124 |
|
|
125 // "# Datum der Erstellung: " |
|
|
126 final Locale locale = Resources.getLocale(this.context.getMeta()); |
|
|
127 final DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale); |
|
|
128 writeCSVMetaEntry(I18NStrings.CSV_META_CREATION, msg(I18NStrings.CSV_META_CREATION_LABEL), df.format(new Date())); |
|
|
129 |
|
|
130 // "# Gewässer: " |
|
|
131 writeCSVMetaEntry(I18NStrings.CSV_META_RIVER, msg(I18NStrings.CSV_META_RIVER_LABEL), river.getName()); |
|
|
132 |
|
|
133 // "# Höhensystem des Flusses: " |
|
|
134 writeCSVMetaEntry(I18NStrings.CSV_META_HEIGHT_UNIT_RIVER, river.getWstUnit()); |
|
|
135 |
|
|
136 if (calcRange != null) { |
|
|
137 // "# Ort/Bereich (km): " |
|
|
138 writeCSVMetaEntry(I18NStrings.CSV_META_RANGE, msg(I18NStrings.CSV_META_RANGE_LABEL), getKmFormatter().format(calcRange.getMinimumDouble()), |
|
|
139 getKmFormatter().format(calcRange.getMaximumDouble())); |
|
|
140 } |
|
|
141 } |
|
|
142 |
|
|
143 public final void writeCSVWaterlevelMetadata(final WstInfo wst) { |
|
|
144 writeCSVWaterlevelMetadata(wst, SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL); // default Label; used in 99% |
|
|
145 } |
|
|
146 |
|
|
147 public final void writeCSVWaterlevelMetadata(final WstInfo wst, final String mainLabel) { |
|
|
148 // "##METADATEN WASSERSPIEGELLAGE" |
|
|
149 writeCSVMetaEntry(mainLabel); |
|
|
150 |
|
|
151 // "# Bezeichnung der Wasserspiegellage: " |
|
|
152 writeCSVMetaEntry(SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_NAME, wst.getLabel()); |
|
|
153 |
|
|
154 // "# Bezugspegel: " |
|
|
155 writeCSVMetaEntry(SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_GAUGE, wst.getGauge()); |
|
|
156 |
|
|
157 // "# Jahr/Zeitraum der Wasserspiegellage: " |
|
|
158 final int year = wst.getYear(); |
|
|
159 if (year > 0) |
|
|
160 writeCSVMetaEntry(SInfoI18NStrings.CSV_META_HEADER_WATERLEVEL_YEAR, Integer.toString(year)); |
|
|
161 } |
|
|
162 |
|
|
163 // copy from AbstractExporter TODO merge with ExportContextPDF |
|
|
164 protected NumberFormat getKmFormatter() { |
|
|
165 |
|
|
166 if (this.kmFormat == null) { |
|
|
167 this.kmFormat = Formatter.getWaterlevelKM(this.context); |
|
|
168 } |
|
|
169 return this.kmFormat; |
|
|
170 } |
|
|
171 |
|
|
172 public void addJRMetadata(final MetaAndTableJRDataSource source, final String key, final String msg) { |
|
|
173 source.addMetaData(key, msg); |
|
|
174 |
|
|
175 } |
|
|
176 |
|
|
177 public NumberFormat getQFormatter() { |
|
|
178 if (this.qFormat == null) { |
|
|
179 this.qFormat = Formatter.getWaterlevelQ(this.context); |
|
|
180 } |
|
|
181 return this.qFormat; |
|
|
182 } |
|
|
183 |
|
|
184 public final NumberFormat getFlowDepthFormatter() { |
|
|
185 if (this.flowDepthFormat == null) |
|
|
186 this.flowDepthFormat = Formatter.getFlowDepth(this.context); |
|
|
187 return this.flowDepthFormat; |
|
|
188 } |
|
|
189 |
|
|
190 /** |
|
|
191 * Formats header with unit: msg [unit] |
|
|
192 */ |
|
|
193 |
|
|
194 public String msgUnitCSV(final IResultType typeWithUnit) { // TODO: use generic Type! |
|
|
195 final String unit = msg(typeWithUnit.getUnit()); |
|
|
196 return msgUnitCSV(typeWithUnit, unit); |
|
|
197 } |
|
|
198 |
|
|
199 public String msgUnitCSV(final IResultType type, final String unit) { |
|
|
200 final String msg = msg(type.getCsvHeader()); |
|
|
201 return String.format("%s [%s]", msg, unit); |
|
|
202 } |
|
|
203 |
|
9154
|
204 public void writeCSVSoundingMetadata(final BedHeightInfo sounding, final String label) { |
|
|
205 |
|
|
206 // "##METADATEN PEILUNG" |
|
|
207 writeCSVMetaEntry(label); |
|
|
208 |
|
|
209 // "# Jahr der Peilung: " |
|
|
210 writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_YEAR, Integer.toString(sounding.getYear())); |
|
|
211 // "# Aufnahmeart: " |
|
|
212 writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_TYPE, sounding.getType()); |
|
|
213 // "# Auswerter: " |
|
|
214 writeCSVMetaEntry(CSV_META_HEADER_EVALUATOR, sounding.getEvaluationBy()); |
|
|
215 // "# Lagesystem: " |
|
|
216 writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_PRJ, sounding.getLocationSystem()); |
|
|
217 // "# Höhensystem: " |
|
|
218 writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL, sounding.getCurElevationModelUnit()); |
|
|
219 // "# ursprüngliches Höhensystem: " |
|
|
220 writeCSVMetaEntry(CSV_META_HEADER_SOUNDING_ELEVATIOIN_MODEL_ORIGINAL, sounding.getOldElevationModelUnit()); |
|
9150
|
221 |
|
|
222 } |
|
|
223 |
|
|
224 public final String msgUnitLabel(final IResultType typeWithUnit, final String label) { |
|
|
225 final String msg = msg(typeWithUnit.getCsvHeader()); |
|
|
226 final String unit = msg(typeWithUnit.getUnit()); |
|
|
227 return String.format("%s [%s] (%s)", msg, unit, label); |
|
|
228 } |
|
|
229 |
|
|
230 public String msgPdf(final SInfoResultType type) { |
|
|
231 return type.getPdfHeader(this.context.getMeta()); |
|
|
232 |
|
|
233 } |
|
|
234 } |
