annotate artifacts/src/main/java/org/dive4elements/river/artifacts/bundu/bezugswst/BezugswstCalculationResult.java @ 9323:86d2cbfe7f7f

bundu bezugswst excel metadaten
author gernotbelger
date Fri, 27 Jul 2018 13:29:34 +0200
parents 7b2b086e45f0
children
rev   line source
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
2 * Software engineering by
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
5 *
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
9 */
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.bundu.bezugswst;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
11
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
12 import java.util.ArrayList;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
13 import java.util.Collection;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
14
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
15 import org.dive4elements.river.artifacts.bundu.BunduResultType;
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
16 import org.dive4elements.river.artifacts.common.AbstractCalculationExportableResult;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.artifacts.common.ExportContextCSV;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
18 import org.dive4elements.river.artifacts.common.ExportContextPDF;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
19 import org.dive4elements.river.artifacts.common.GeneralResultType;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.common.IExportContext;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.common.ResultRow;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
24 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
25 import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
26
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
27 /**
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
28 * Contains the results of a //TODO LINK{@link BezugswstCalculation}.
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
29 *
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
30 * @author Gernot Belger
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
31 */
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
32 final class BezugswstCalculationResult extends AbstractCalculationExportableResult {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
33
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
34 private static final long serialVersionUID = 1L;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
35
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
36 private static final String JASPER_FILE = "/jasper/templates/bundu.bezugswst.jrxml";
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
37
9323
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
38 private final WstInfo wst;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
39 private final BedHeightInfo sounding;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
40 private final String function;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
41 private final boolean preprocessing;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
42 private final int startYear;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
43 private final int endYear;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
44 private final Double missingVolumeFrom;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
45 private final Double missingVolumeTo;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
46 private final Integer ud;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
47 private final double[] qOfGauges;
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
48
9323
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
49 public BezugswstCalculationResult(final String label, final Collection<ResultRow> rows, final BedHeightInfo sounding, final WstInfo wst,
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
50 final String function, final boolean preprocessing, final int startYear, final int endYear, final Integer ud, final double[] qOfGauges,
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
51 final Double missingVolumeFrom, final Double missingVolumeTo) {
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
52 super(label, rows);
9323
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
53 this.wst = wst;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
54 this.sounding = sounding;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
55 this.function = function;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
56 this.preprocessing = preprocessing;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
57 this.startYear = startYear;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
58 this.endYear = endYear;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
59 this.missingVolumeTo = missingVolumeTo;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
60 this.missingVolumeFrom = missingVolumeFrom;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
61 this.ud = ud;
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
62 this.qOfGauges = qOfGauges;
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
63 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
64
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
65 @Override
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
66 protected void writeCSVResultMetadata(final ExportContextCSV exportContextCSV) {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
67
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
68 // TODO: wenn wst und peilung vorhanden sind, sollte dieser Teil wieder einkommentiert werden
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
69 // exportContextCSV.writeCSVWaterlevelMetadata(wst);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
70 // exportContextCSV.writeBlankLine();
9323
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
71 // exportContextCSV.writeCSVSoundingMetadata(this.sounding, " ");
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
72
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
73 // Reihenfolge in der LV anders; ich finde sie aber so sinnvoller
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
74 exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.function", this.function);
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
75 exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.preprocessing", String.valueOf(this.preprocessing));
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
76 exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.q_period", String.valueOf(this.startYear), String.valueOf(this.endYear));
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
77 if (this.ud != null)
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
78 exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.ud", this.ud);
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
79 else if (this.qOfGauges != null)
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
80 exportContextCSV.writeCSVMetaEntry("common.export.waterlevel.csv.meta.q", this.qOfGauges); // was auch immer dieser String beinhalten mag
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
81
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
82 exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.function", this.function);
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
83 exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.missing_volume_range", this.missingVolumeFrom, this.missingVolumeTo);
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
84
86d2cbfe7f7f bundu bezugswst excel metadaten
gernotbelger
parents: 9318
diff changeset
85 exportContextCSV.writeBlankLine();
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
86 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
87
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
88 @Override
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
89 protected String getJasperFile() {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
90 return JASPER_FILE;
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
91 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
92
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
93 protected String[] formatRow(final IExportContext exportContext, final ResultRow row) {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
94
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
95 final Collection<String> lines = new ArrayList<>(10);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
96
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
97 lines.add(exportContext.formatRowValue(row, GeneralResultType.station));
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
98 lines.add(exportContext.formatRowValue(row, BunduResultType.bezugswst));
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
99 lines.add(exportContext.formatRowValue(row, GeneralResultType.dischargeQwithUnit));
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
100
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
101 lines.add(exportContext.formatRowValue(row, GeneralResultType.waterlevelLabel));
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
102 lines.add(exportContext.formatRowValue(row, GeneralResultType.gaugeLabel));
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
103 lines.add(exportContext.formatRowValue(row, GeneralResultType.location));
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
104
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
105 return lines.toArray(new String[lines.size()]);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
106 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
107
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
108 @Override
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
109 public void writeCSVHeader(final ExportContextCSV exportContextCSV, final RiverInfo river) {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
110
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
111 final Collection<String> header = new ArrayList<>(11);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
112
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
113 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.station));
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
114 header.add(exportContextCSV.formatCsvHeader(BunduResultType.bezugswst));
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
115 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.dischargeQwithUnit));
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
116 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.waterlevelLabel));
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
117 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.gaugeLabel));
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
118 header.add(exportContextCSV.formatCsvHeader(GeneralResultType.location));
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
119
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
120 exportContextCSV.writeCSVLine(header.toArray(new String[header.size()]));
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
121
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
122 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
123
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
124 @Override
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
125 protected String[] formatCSVRow(final ExportContextCSV exportContextCSV, final ResultRow row) {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
126
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
127 return this.formatRow(exportContextCSV, row);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
128 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
129
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
130 @Override
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
131 protected String[] formatPDFRow(final ExportContextPDF exportContextPDF, final ResultRow row) {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
132
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
133 return this.formatRow(exportContextPDF, row);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
134 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
135
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
136 @Override
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
137 protected void addJRTableHeader(final ExportContextPDF exportContextPDF, final MetaAndTableJRDataSource source) {
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
138 /* column headings */
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
139 exportContextPDF.addJRMetadata(source, "station_header", GeneralResultType.station);
9318
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
140 exportContextPDF.addJRMetadata(source, "bezugswst_header", BunduResultType.bezugswst);
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
141 exportContextPDF.addJRMetadata(source, "discharge_header", GeneralResultType.dischargeQwithUnit);
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
142 exportContextPDF.addJRMetadata(source, "waterlevel_name_header", GeneralResultType.waterlevelLabel);
7b2b086e45f0 collision pdf details, ResultType refactoring, bezugswst result
gernotbelger
parents: 9313
diff changeset
143 exportContextPDF.addJRMetadata(source, "gauge_header", GeneralResultType.gaugeLabel);
9313
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
144 exportContextPDF.addJRMetadata(source, "location_header", GeneralResultType.location);
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
145
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
146 }
6ffcbb4f35d5 bundu.bezugswst first result stump
gernotbelger
parents:
diff changeset
147 }

http://dive4elements.wald.intevation.org