Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhstate/TkhCalculationResult.java @ 9195:a4121ec450d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
'ca.'-issue ExportContextCSV+PDF separated uinfo.inundationduration url export
author gernotbelger
date Fri, 29 Jun 2018 14:52:54 +0200
parents 9b2e46090099
children 740d65e4aa14
rev   line source
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
2 * Software engineering by
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
5 *
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
9 */
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.sinfo.tkhstate;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
11
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
12 import java.util.ArrayList;
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
13 import java.util.Collection;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
14
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
15 import org.dive4elements.river.artifacts.common.ExportContextCSV;
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
16 import org.dive4elements.river.artifacts.common.ExportContextPDF;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
17 import org.dive4elements.river.artifacts.common.GeneralResultType;
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
18 import org.dive4elements.river.artifacts.common.IExportContext;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
19 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
8996
fb9430250899 Work on uinfo
gernotbelger
parents: 8948
diff changeset
20 import org.dive4elements.river.artifacts.common.ResultRow;
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
21 import org.dive4elements.river.artifacts.sinfo.common.AbstractTkhCalculationResult;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
22 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
23 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
24 import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
25
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
26 /**
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents: 8996
diff changeset
27 * Contains the results of a {@link FloodDurationCalculation}.
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
28 *
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
29 * @author Gernot Belger
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
30 */
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
31 final class TkhCalculationResult extends AbstractTkhCalculationResult {
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
32
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
33 private static final long serialVersionUID = 1L;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
34 private static final String JASPER_FILE = "/jasper/templates/sinfo.tkh.jrxml";
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
35
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
36 private enum ExportMode {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
37 pdf, csv
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
38 }
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
39
8996
fb9430250899 Work on uinfo
gernotbelger
parents: 8948
diff changeset
40 public TkhCalculationResult(final String label, final WstInfo wst, final boolean hasTkh, final Collection<ResultRow> rows) {
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
41 super(label, wst, hasTkh, rows);
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
42
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
43 }
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
44
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
45 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
46 public void writeCSVHeader(final ExportContextCSV exportContext, final RiverInfo river) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
47
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
48 final Collection<String> header = new ArrayList<>(11);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
49
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
50 header.add(exportContext.formatCsvHeader(GeneralResultType.station));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
51 header.add(exportContext.msgUnitCSV(SInfoResultType.tkh));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
52 header.add(exportContext.formatCsvHeader(SInfoResultType.soilkind));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
53 header.add(exportContext.msgUnitCSV(SInfoResultType.meanBedHeight, river.getWstUnit()));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
54 header.add(exportContext.msgUnitCSV(SInfoResultType.waterlevel, river.getWstUnit()));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
55 header.add(exportContext.msgUnitCSV(SInfoResultType.discharge));
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
56
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
57 final TkhCalculationResults results = exportContext.getResults();
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
58 final String descriptionHeader = results.getDescriptionHeader();
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
59 if (descriptionHeader != null)
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
60 header.add(descriptionHeader);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
61
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
62 header.add(exportContext.formatCsvHeader(SInfoResultType.gaugeLabel));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
63 header.add(exportContext.formatCsvHeader(SInfoResultType.location));
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
64
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
65 exportContext.writeCSVLine(header.toArray(new String[header.size()]));
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
66
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
67 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
68
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
69 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
70 protected void writeCSVResultMetadata(final ExportContextCSV exportContextCSV) {
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
71 exportContextCSV.writeCSVWaterlevelMetadata(super.getWst());// TODO: move to super
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
72 exportContextCSV.writeBlankLine();
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
73 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
74
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
75 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
76 protected String[] formatCSVRow(final ExportContextCSV exportContextCSV, final ResultRow row) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
77
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
78 return this.formatRow(exportContextCSV, row, ExportMode.csv);
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
79 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
80
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
81 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
82 protected String[] formatPDFRow(final ExportContextPDF exportContext, final ResultRow row) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
83
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
84 return this.formatRow(exportContext, row, ExportMode.pdf);
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
85 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
86
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
87 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
88 protected String getJasperFile() {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
89 return JASPER_FILE;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
90 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
91
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
92 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
93 protected void addJRTableHeader(final ExportContextPDF exportContext, final MetaAndTableJRDataSource source) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
94 /* column headings */
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
95 exportContext.addJRMetadata(source, "station_header", GeneralResultType.station);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
96 exportContext.addJRMetadata(source, "tkh_header", SInfoResultType.tkh);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
97 exportContext.addJRMetadata(source, "tkhkind_header", SInfoResultType.soilkind);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
98 exportContext.addJRMetadata(source, "bedheight_header", SInfoResultType.meanBedHeight);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
99 exportContext.addJRMetadata(source, "waterlevel_header", SInfoResultType.waterlevel);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
100 exportContext.addJRMetadata(source, "discharge_header", SInfoResultType.discharge);
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
101
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
102 // REMARK: actually the column makes no sense if description header is null. But (software symmetry...) WINFO also
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
103 // writes an empty column into the pdf in that case (most probably to avoid the need for two jasper templates).
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
104
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
105 final TkhCalculationResults results = exportContext.getResults();
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
106 final String descriptionHeader = results.getDescriptionHeader();
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
107
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
108 final String waterlevelNameHeader = descriptionHeader == null ? exportContext.msgPdf(SInfoResultType.waterlevelLabel) : descriptionHeader;
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
109 exportContext.addJRMetadata(source, "waterlevel_name_header", waterlevelNameHeader);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
110
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
111 exportContext.addJRMetadata(source, "gauge_header", SInfoResultType.gaugeLabel);
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
112 exportContext.addJRMetadata(source, "location_header", SInfoResultType.location);
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
113
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
114 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
115
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
116 private String[] formatRow(final IExportContext exportContext, final ResultRow row, final ExportMode mode) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
117
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
118 final Collection<String> lines = new ArrayList<>(11);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
119
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
120 lines.add(exportContext.formatRowValue(row, GeneralResultType.station));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
121 lines.add(exportContext.formatRowValue(row, SInfoResultType.tkh));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
122 lines.add(exportContext.formatRowValue(row, SInfoResultType.soilkind));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
123 lines.add(exportContext.formatRowValue(row, SInfoResultType.meanBedHeight));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
124 lines.add(exportContext.formatRowValue(row, SInfoResultType.waterlevel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
125 lines.add(exportContext.formatRowValue(row, SInfoResultType.discharge));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
126
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
127 // REMARK: always export this column in pdf-mode, because WInfo also does it (no need for two jasper-templates).
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
128 final TkhCalculationResults results = exportContext.getResults();
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
129 final String descriptionHeader = results.getDescriptionHeader();
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
130 if (descriptionHeader != null || mode == ExportMode.pdf)
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
131 lines.add(exportContext.formatRowValue(row, SInfoResultType.waterlevelLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
132
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
133 lines.add(exportContext.formatRowValue(row, SInfoResultType.gaugeLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
134 lines.add(exportContext.formatRowValue(row, SInfoResultType.location));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
135
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
136 return lines.toArray(new String[lines.size()]);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
137 }
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
138 }
http://dive4elements.wald.intevation.org