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