annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepth/FlowDepthCalculationResult.java @ 9195:a4121ec450d6

'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
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
8877
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
2 * Software engineering by
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
5 *
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
9 */
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.sinfo.flowdepth;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
11
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
12 import java.util.ArrayList;
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
13 import java.util.Collection;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
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;
8997
d5802f22e4f5 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;
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8886
diff changeset
23 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
24 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8886
diff changeset
25 import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8886
diff changeset
26
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
27 /**
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents: 8997
diff changeset
28 * Contains the results of a {@link FloodDurationCalculation}.
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
29 *
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
30 * @author Gernot Belger
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
31 */
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
32
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
33 final class FlowDepthCalculationResult extends AbstractTkhCalculationResult {
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
34
8877
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
35 private static final long serialVersionUID = 1L;
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
36
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
37 private enum ExportMode { // TODO; nicht ständig kopieren
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
38 pdf, csv
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
39 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
40
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
41 private static final String JASPER_FILE = "/jasper/templates/sinfo.flowdepth.jrxml"; // TODO use jrxml-path all over the project
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
42
8877
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
43 private final BedHeightInfo sounding;
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
44
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents: 8894
diff changeset
45 public FlowDepthCalculationResult(final String label, final WstInfo wst, final BedHeightInfo sounding, final boolean hasTkh,
8997
d5802f22e4f5 Work on uinfo
gernotbelger
parents: 8948
diff changeset
46 final Collection<ResultRow> rows) {
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
47 super(label, wst, hasTkh, rows);
8877
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
48
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents: 8894
diff changeset
49 this.sounding = sounding;
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
50
8877
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
51 }
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
52
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
53 public BedHeightInfo getSounding() {
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
54 return this.sounding;
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
55 }
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
56
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
57 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
58 public void writeCSVHeader(final ExportContextCSV exportContextCSV, final RiverInfo river) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
59 // getLog().info("FlowDepthExporter.writeCSVHeader");
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
60
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
61 final Collection<String> header = new ArrayList<>(11);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
62
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
63 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.station));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
64 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.flowdepth));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
65
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
66 if (this.hasTkh()) {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
67 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.flowdepthtkh));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
68 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.tkh));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
69 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
70
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
71 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.waterlevel, river.getWstUnit()));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
72 header.add(exportContextCSV.msgUnitCSV(SInfoResultType.discharge));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
73 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.waterlevelLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
74 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.gaugeLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
75 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.meanBedHeight));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
76 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.soundingLabel));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
77 header.add(exportContextCSV.formatCsvHeader(SInfoResultType.location));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
78
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
79 exportContextCSV.writeCSVLine(header.toArray(new String[header.size()]));
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
80
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
81 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
82
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
83 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
84 protected void writeCSVResultMetadata(final ExportContextCSV exportContextCSV) {
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 exportContextCSV.writeCSVSoundingMetadata(this.sounding);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
87
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
88 exportContextCSV.writeBlankLine();// .writeNext(new String[] { "" }); // break line
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
89
9170
9b2e46090099 tkh cast exception fix
gernotbelger
parents: 9150
diff changeset
90 exportContextCSV.writeCSVWaterlevelMetadata(super.getWst()); // TODO move to super
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
91
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
92 exportContextCSV.writeBlankLine();// .writeNext(new String[] { "" }); // break line
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
93
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
94 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
95
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
96 @Override
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
97 protected String getJasperFile() {
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
98 return JASPER_FILE;
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
99 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
100
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
101 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
102 protected String[] formatCSVRow(final ExportContextCSV exportContextCSV, final ResultRow row) {
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
103 return formatRow(ExportMode.csv, exportContextCSV, row);
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
104 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
105
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
106 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
107 protected String[] formatPDFRow(final ExportContextPDF exportContextPDF, final ResultRow row) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
108
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
109 return formatRow(ExportMode.pdf, exportContextPDF, row);
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
110 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
111
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
112 @Override
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
113 protected void addJRTableHeader(final ExportContextPDF exportContextPDF, final MetaAndTableJRDataSource source) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
114
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
115 /* column headings */
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
116 exportContextPDF.addJRMetadata(source, "station_header", GeneralResultType.station);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
117 exportContextPDF.addJRMetadata(source, "flowdepth_header", SInfoResultType.flowdepth);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
118 exportContextPDF.addJRMetadata(source, "flowdepth_tkh_header", SInfoResultType.flowdepthtkh);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
119 exportContextPDF.addJRMetadata(source, "tkh_header", SInfoResultType.tkh);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
120 exportContextPDF.addJRMetadata(source, "waterlevel_header", SInfoResultType.waterlevel);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
121 exportContextPDF.addJRMetadata(source, "discharge_header", SInfoResultType.discharge);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
122 exportContextPDF.addJRMetadata(source, "waterlevel_name_header", SInfoResultType.waterlevelLabel);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
123 exportContextPDF.addJRMetadata(source, "gauge_header", SInfoResultType.gaugeLabel);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
124 exportContextPDF.addJRMetadata(source, "bedheight_header", SInfoResultType.meanBedHeight);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
125 exportContextPDF.addJRMetadata(source, "sounding_name_header", SInfoResultType.soundingLabel);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
126 exportContextPDF.addJRMetadata(source, "location_header", 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
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
129 private String[] formatRow(final ExportMode mode, final IExportContext exportContext, final ResultRow row) {
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
130
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
131 final Collection<String> lines = new ArrayList<>(11);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
132
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
133 lines.add(exportContext.formatRowValue(row, GeneralResultType.station));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
134 lines.add(exportContext.formatRowValue(row, SInfoResultType.flowdepth));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
135 final FlowDepthCalculationResults results = exportContext.getResults();
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
136
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
137 if (mode == ExportMode.pdf || results.isUseTkh()) {
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
138 lines.add(exportContext.formatRowValue(row, SInfoResultType.flowdepthtkh));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
139 lines.add(exportContext.formatRowValue(row, SInfoResultType.tkh));
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
140 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
141
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
142 lines.add(exportContext.formatRowValue(row, SInfoResultType.waterlevel));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
143 lines.add(exportContext.formatRowValue(row, SInfoResultType.discharge));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
144 lines.add(exportContext.formatRowValue(row, SInfoResultType.waterlevelLabel));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
145 lines.add(exportContext.formatRowValue(row, SInfoResultType.gaugeLabel));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
146 lines.add(exportContext.formatRowValue(row, SInfoResultType.meanBedHeight));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
147 lines.add(exportContext.formatRowValue(row, SInfoResultType.soundingLabel));
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9170
diff changeset
148 lines.add(exportContext.formatRowValue(row, SInfoResultType.location));
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
149
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
150 return lines.toArray(new String[lines.size()]);
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
151 }
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9067
diff changeset
152
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
153 }

http://dive4elements.wald.intevation.org