Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhstate/TkhCalculationResult.java @ 9170:9b2e46090099

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
tkh cast exception fix gigantic refactoring 2
author gernotbelger
date Thu, 21 Jun 2018 14:32:11 +0200
parents 23945061daec
children a4121ec450d6
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;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
16 import org.dive4elements.river.artifacts.common.GeneralResultType;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
17 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
8996
fb9430250899 Work on uinfo
gernotbelger
parents: 8948
diff changeset
18 import org.dive4elements.river.artifacts.common.ResultRow;
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
19 import org.dive4elements.river.artifacts.sinfo.common.AbstractTkhCalculationResult;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
20 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
21 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
22 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
23
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
24 /**
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents: 8996
diff changeset
25 * 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
26 *
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
27 * @author Gernot Belger
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
28 */
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
29 final class TkhCalculationResult extends AbstractTkhCalculationResult<TkhCalculationResults> {
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
30
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
31 private static final long serialVersionUID = 1L;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
32 private static final String JASPER_FILE = "/jasper/templates/sinfo.tkh.jrxml";
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
33
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
34 private enum ExportMode {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
35 pdf, csv
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
36 }
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
37
8996
fb9430250899 Work on uinfo
gernotbelger
parents: 8948
diff changeset
38 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
39 super(label, wst, hasTkh, rows);
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
40
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
41 }
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
42
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
43 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
44 public void writeCSVHeader(final ExportContextCSV exportContextCSV, final TkhCalculationResults results, final RiverInfo river) {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
45
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
46 final Collection<String> header = new ArrayList<>(11);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
47
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
48 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.station));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
49 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.tkh));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
50 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.soilkind));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
51 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.meanBedHeight, river.getWstUnit()));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
52 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.waterlevel, river.getWstUnit()));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
53 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.discharge));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
54
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
55 final String descriptionHeader = results.getDescriptionHeader();
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
56 if (descriptionHeader != null)
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
57 header.add(descriptionHeader);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
58
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
59 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.gaugeLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
60 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.location));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
61
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
62 exportContextCSV.writeCSVLine(header.toArray(new String[header.size()]));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
63
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
64 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
65
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
66 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
67 protected void writeCSVResultMetadata(final ExportContextCSV exportContextCSV, final TkhCalculationResults results) {
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
68 exportContextCSV.writeCSVWaterlevelMetadata(super.getWst());// TODO: move to super
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
69 exportContextCSV.writeBlankLine();
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
70 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
71
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
72 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
73 protected String[] formatCSVRow(final ExportContextCSV exportContextCSV, final TkhCalculationResults results, final ResultRow row) {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
74
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
75 return this.formatRow(exportContextCSV, results, row, ExportMode.csv);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
76 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
77
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
78 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
79 protected String[] formatPDFRow(final ExportContextCSV exportContextPDF, final TkhCalculationResults results, final ResultRow row) {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
80
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
81 return this.formatRow(exportContextPDF, results, row, ExportMode.pdf);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
82 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
83
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
84 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
85 protected String getJasperFile() {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
86 return JASPER_FILE;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
87 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
88
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
89 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
90 protected void addJRTableHeader(final ExportContextCSV exportContextPDF, final MetaAndTableJRDataSource source, final TkhCalculationResults results) {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
91 /* column headings */
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
92 exportContextPDF.addJRMetadata(source, "station_header", GeneralResultType.station);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
93 exportContextPDF.addJRMetadata(source, "tkh_header", SInfoResultType.tkh);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
94 exportContextPDF.addJRMetadata(source, "tkhkind_header", SInfoResultType.soilkind);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
95 exportContextPDF.addJRMetadata(source, "bedheight_header", SInfoResultType.meanBedHeight);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
96 exportContextPDF.addJRMetadata(source, "waterlevel_header", SInfoResultType.waterlevel);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
97 exportContextPDF.addJRMetadata(source, "discharge_header", SInfoResultType.discharge);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
98
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
99 // 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
100 // writes an empty column into the pdf in that case (most probably to avoid the need for two jasper templates).
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
101 final String descriptionHeader = results.getDescriptionHeader();
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
102 final String waterlevelNameHeader = descriptionHeader == null ? exportContextPDF.msgPdf(SInfoResultType.waterlevelLabel) : descriptionHeader;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
103 exportContextPDF.addJRMetadata(source, "waterlevel_name_header", waterlevelNameHeader);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
104
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
105 exportContextPDF.addJRMetadata(source, "gauge_header", SInfoResultType.gaugeLabel);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
106 exportContextPDF.addJRMetadata(source, "location_header", SInfoResultType.location);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
107
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
108 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
109
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
110 private String[] formatRow(final ExportContextCSV exportContext, final TkhCalculationResults results, final ResultRow row, final ExportMode mode) {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
111
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
112 final Collection<String> lines = new ArrayList<>(11);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
113
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
114 lines.add(exportContext.formatRowValue(row, GeneralResultType.station));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
115 lines.add(exportContext.formatRowValue(row, SInfoResultType.tkh));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
116 lines.add(exportContext.formatRowValue(row, SInfoResultType.soilkind));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
117 lines.add(exportContext.formatRowValue(row, SInfoResultType.meanBedHeight));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
118 lines.add(exportContext.formatRowValue(row, SInfoResultType.waterlevel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
119 lines.add(exportContext.formatRowValue(row, SInfoResultType.discharge));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
120
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
121 // REMARK: always export this column in pdf-mode, because WInfo also does it (no need for two jasper-templates).
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
122 if (results.getDescriptionHeader() != null || mode == ExportMode.pdf)
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
123 lines.add(exportContext.formatRowValue(row, SInfoResultType.waterlevelLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
124
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
125 lines.add(exportContext.formatRowValue(row, SInfoResultType.gaugeLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
126 lines.add(exportContext.formatRowValue(row, SInfoResultType.location));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
127
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
128 return lines.toArray(new String[lines.size()]);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
129 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
130
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents:
diff changeset
131 }
http://dive4elements.wald.intevation.org