annotate artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/salix/SalixLineExporter.java @ 9006:7134a4c7d1b6

U-Info S-Info general work
author gernotbelger
date Tue, 17 Apr 2018 13:20:25 +0200
parents fb9430250899
children 41f4bc83aa7a
rev   line source
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
2 * Software engineering by
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
5 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
9 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.uinfo.salix;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
11
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
12 import java.io.OutputStream;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
13 import java.util.ArrayList;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
14 import java.util.Collection;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
15
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
16 import org.apache.log4j.Logger;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.artifacts.common.GeneralResultType;
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
18 import org.dive4elements.river.artifacts.common.JasperReporter;
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
19 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.common.ResultRow;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.uinfo.commons.AbstractUInfoExporter;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.uinfo.commons.UInfoResultType;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
24
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
25 import au.com.bytecode.opencsv.CSVWriter;
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
26 import net.sf.jasperreports.engine.JRException;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
27
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
28 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
29 * @author Domenico Nardi Tironi
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
30 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
31 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
32 public class SalixLineExporter extends AbstractUInfoExporter<SalixLineCalculationResult, SalixLineCalculationResults> {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
33
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
34 /** The log used in this exporter. */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
35 private static Logger log = Logger.getLogger(SalixLineExporter.class);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
36
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
37 private static final String JASPER_FILE = "/jasper/templates/uinfo.salixline.jrxml";
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
38
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
39 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
40 protected Logger getLog() {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
41 return log;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
42 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
43
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
44 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
45 protected void writeCSVGlobalMetadata(final CSVWriter writer, final SalixLineCalculationResults results) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
46 log.info("SalixLineExporter.writeCSVMeta");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
47
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
48 super.writeCSVGlobalMetadataDefaults(writer, results);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
49
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
50 // Add Auswerter, Bezugspegel, Jahr/Zeitraum der Wasserspiegellage
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
51
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
52 // "# Auswerter: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
53 writeCSVMetaEntry(writer, "uinfo.export.salix_line.csv.meta.header.evaluator", "sounding.getEvaluationBy()");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
54 // "# Bezugspegel: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
55 writeCSVMetaEntry(writer, "uinfo.export.salix_line.csv.meta.header.waterlevel.gauge", "wst.getGauge()");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
56
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
57 // "# Jahr/Zeitraum der Wasserspiegellage: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
58 // final int year = wst.getYear();
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
59 // if (year > 0)
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
60 writeCSVMetaEntry(writer, "uinfo.export.salix_line.csv.meta.header.waterlevel.year", "Integer.toString(year)");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
61
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
62 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
63
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
64 private void writeRegionalEffectsCSVMetadata(final CSVWriter writer) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
65 final String main = "uinfo.export.csv.meta.header.salix.regional";
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
66 // "##Regional wirkende Eingriffe"
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
67 writeCSVMetaEntry(writer, main);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
68 writeRegionalCommonCSVMeta(writer);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
69 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
70
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
71 private void writeRegionalCommonCSVMeta(final CSVWriter writer) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
72 final String main = "uinfo.export.csv.meta.header.salix";
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
73 // "# Szenariotyp: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
74 writeCSVMetaEntry(writer, main + ".szenariotyp");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
75 // "# Teilabschnitt: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
76 writeCSVMetaEntry(writer, main + ".teilabschnitt");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
77 // "# Mittelwasserspiegellagenänderung: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
78 writeCSVMetaEntry(writer, main + ".mwspiegellaenderung");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
79 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
80
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
81 private void writeExtendedRegionalEffectsCSVMetadata(final CSVWriter writer) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
82 final String main = "uinfo.export.csv.meta.header.salix.regionalextended";
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
83 // "##Überregional wirkende Eingriffe"
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
84 writeCSVMetaEntry(writer, main);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
85
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
86 writeRegionalCommonCSVMeta(writer);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
87 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
88
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
89 private void writeHistoricalViewCSVMetadata(final CSVWriter writer) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
90 final String main = "uinfo.export.csv.meta.header.salix.historical";
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
91 // "##Historische Betrachtung"
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
92 writeCSVMetaEntry(writer, main);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
93
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
94 final String mainSub = "uinfo.export.csv.meta.header.salix";
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
95 // "# Szenariotyp: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
96 writeCSVMetaEntry(writer, mainSub + ".szenariotyp");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
97 // "# Teilabschnitt: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
98 writeCSVMetaEntry(writer, mainSub + ".teilabschnitt");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
99
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
100 // "# Art des Zeitraums: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
101 writeCSVMetaEntry(writer, main + ".zeitart");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
102 // "# Historischer Zeitpunkt: "
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
103 writeCSVMetaEntry(writer, main + ".zeitpunkt");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
104 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
105
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
106 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
107 protected void writeCSVResultMetadata(final CSVWriter writer, final SalixLineCalculationResults results, final SalixLineCalculationResult result) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
108 writeRegionalEffectsCSVMetadata(writer);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
109 writer.writeNext(new String[] { "" }); // break line
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
110 writeExtendedRegionalEffectsCSVMetadata(writer);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
111 writer.writeNext(new String[] { "" }); // break line
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
112 writeHistoricalViewCSVMetadata(writer);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
113 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
114
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
115 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
116 * Write the header, with different headings depending on whether at a
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
117 * gauge or at a location.
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
118 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
119 * @param river
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
120 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
121 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
122 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
123 protected void writeCSVHeader(final CSVWriter writer, final SalixLineCalculationResults results, final RiverInfo river) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
124 log.info("FlowDepthExporter.writeCSVHeader");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
125
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
126 final Collection<String> header = new ArrayList<>(4);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
127
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
128 header.add(msg(GeneralResultType.station.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
129 // header.add(msgUnit(SInfoResultType.flowdepth.getCsvHeader(), SInfoResultType.flowdepth.getUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
130
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
131 header.add(msg(UInfoResultType.salixline.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
132 // wenn "historisch" gewählt wurde, nur "historisch" anzeigen; sonst für jeden scen-wert ne neue Spalte und "hist"
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
133 // ausblenden!...!..!!
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
134 header.add(msg(UInfoResultType.salixlinehist.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
135 header.add(msg(UInfoResultType.salixlinescen.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
136 writer.writeNext(header.toArray(new String[header.size()]));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
137 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
138
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
139 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
140 * Format a row of a flow depth result into an array of string, both used by csv and pdf
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
141 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
142 * @param pdf
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
143 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
144 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
145 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
146 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
147 protected String[] formatRow(final SalixLineCalculationResults results, final ResultRow row, final ExportMode mode) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
148
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
149 final Collection<String> lines = new ArrayList<>(3);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
150
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
151 lines.add(row.exportValue(this.context, GeneralResultType.station));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
152 lines.add(row.exportValue(this.context, UInfoResultType.salixline));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
153
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
154 // wenn "historisch" gewählt wurde, nur "historisch" anzeigen; sonst für jeden scen-wert ne neue Spalte und "hist"
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
155 // ausblenden!...!..!!
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
156 lines.add(row.exportValue(this.context, UInfoResultType.salixlinehist));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
157 lines.add(row.exportValue(this.context, UInfoResultType.salixlinescen));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
158 return lines.toArray(new String[lines.size()]);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
159 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
160
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
161 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
162 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final SalixLineCalculationResults results) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
163
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
164 super.addJRMetaData(source, results);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
165
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
166 /* additional column headings */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
167 source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta()));
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
168
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
169 source.addMetaData("salix_line", UInfoResultType.salixline.getPdfHeader(this.context.getMeta()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
170 // wenn "historisch" gewählt wurde, nur "historisch" anzeigen; sonst für jeden scen-wert ne neue Spalte und "hist"
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
171 // ausblenden!...!..!!
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
172 source.addMetaData("salix_line_hist", UInfoResultType.salixlinehist.getPdfHeader(this.context.getMeta()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
173 source.addMetaData("salix_line_scen", UInfoResultType.salixlinescen.getPdfHeader(this.context.getMeta()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
174 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
175
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
176 @Override
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
177 protected void writePDF(final OutputStream out) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
178 try {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
179 final MetaAndTableJRDataSource source = createJRData(this.data);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
180
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
181 final JasperReporter reporter = new JasperReporter();
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
182 reporter.addReport(JASPER_FILE, source);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
183 reporter.exportPDF(out);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
184 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
185 catch (final JRException je) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
186 getLog().warn("Error generating PDF Report!", je);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
187 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
188
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
189 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
190
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
191 }

http://dive4elements.wald.intevation.org