annotate artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/inundationduration/InundationDurationExporter.java @ 9107:41f4bc83aa7a

vegzones improved
author gernotbelger
date Tue, 29 May 2018 15:19:03 +0200
parents 7134a4c7d1b6
children 23945061daec
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.inundationduration;
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;
9107
41f4bc83aa7a vegzones improved
gernotbelger
parents: 9006
diff changeset
18 import org.dive4elements.river.artifacts.common.I18NStrings;
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
19 import org.dive4elements.river.artifacts.common.JasperReporter;
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
20 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.artifacts.common.ResultRow;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
24 import org.dive4elements.river.artifacts.uinfo.commons.AbstractUInfoExporter;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
25
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
26 import au.com.bytecode.opencsv.CSVWriter;
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
27 import net.sf.jasperreports.engine.JRException;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
28
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
29 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
30 * @author Domenico Nardi Tironi
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
31 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
32 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
33 public class InundationDurationExporter extends AbstractUInfoExporter<InundationDurationCalculationResult, InundationDurationCalculationResults> {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
34
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
35 /** The log used in this exporter. */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
36 private static Logger log = Logger.getLogger(InundationDurationExporter.class);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
37
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
38 private static final String JASPER_FILE = "/jasper/templates/uinfo.inundationduration.jrxml";
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
39
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
40 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
41 protected Logger getLog() {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
42 return log;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
43 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
44
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
45 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
46 protected void writeCSVGlobalMetadata(final CSVWriter writer, final InundationDurationCalculationResults results) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
47 log.info("SalixLineExporter.writeCSVMeta");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
48
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
49 super.writeCSVGlobalMetadataDefaults(writer, results);
9107
41f4bc83aa7a vegzones improved
gernotbelger
parents: 9006
diff changeset
50
41f4bc83aa7a vegzones improved
gernotbelger
parents: 9006
diff changeset
51 // "# Höhensystem des Flusses: "
41f4bc83aa7a vegzones improved
gernotbelger
parents: 9006
diff changeset
52 writeCSVMetaEntry(writer, I18NStrings.CSV_META_HEIGHT_UNIT_RIVER, results.getRiver().getWstUnit());
41f4bc83aa7a vegzones improved
gernotbelger
parents: 9006
diff changeset
53
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
54 writer.writeNext(new String[] { "" }); // break line
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
55 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
56
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
57 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
58 protected void writeCSVResultMetadata(final CSVWriter writer, final InundationDurationCalculationResults results,
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
59 final InundationDurationCalculationResult result) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
60
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
61 /*
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
62 * final BedHeightInfo sounding = result.getSounding();
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
63 * super.writeCSVSoundingMetadata(writer, sounding);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
64 * final WstInfo wst = result.getWst();
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
65 * super.writeCSVWaterlevelMetadata(writer, wst);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
66 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
67 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
68
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
69 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
70 * Write the header, with different headings depending on whether at a
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
71 * gauge or at a location.
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
72 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
73 * @param river
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
74 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
75 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
76 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
77 protected void writeCSVHeader(final CSVWriter writer, final InundationDurationCalculationResults results, final RiverInfo river) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
78 log.info("FlowDepthExporter.writeCSVHeader");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
79
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
80 final Collection<String> header = new ArrayList<>(11);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
81
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
82 header.add(msg(GeneralResultType.station.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
83 header.add(msgUnit(SInfoResultType.flowdepth.getCsvHeader(), SInfoResultType.flowdepth.getUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
84
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
85 header.add(msgUnit(SInfoResultType.waterlevel.getCsvHeader(), river.getWstUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
86 header.add(msgUnit(SInfoResultType.discharge.getCsvHeader(), SInfoResultType.discharge.getUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
87 header.add(msg(SInfoResultType.waterlevelLabel.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
88 header.add(msg(SInfoResultType.gaugeLabel.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
89 header.add(msgUnit(SInfoResultType.meanBedHeight.getCsvHeader(), river.getWstUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
90 header.add(msg(SInfoResultType.soundingLabel.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
91 header.add(msg(SInfoResultType.location.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
92
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
93 writer.writeNext(header.toArray(new String[header.size()]));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
94 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
95
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
96 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
97 * 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
98 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
99 * @param pdf
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
100 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
101 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
102 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
103 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
104 protected String[] formatRow(final InundationDurationCalculationResults results, final ResultRow row, final ExportMode mode) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
105
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
106 final Collection<String> lines = new ArrayList<>(11);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
107
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
108 lines.add(row.exportValue(this.context, GeneralResultType.station));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
109 lines.add(row.exportValue(this.context, SInfoResultType.flowdepth));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
110
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
111 lines.add(row.exportValue(this.context, SInfoResultType.waterlevel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
112 lines.add(row.exportValue(this.context, SInfoResultType.discharge));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
113 lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
114 lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
115 lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
116 lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
117 lines.add(row.exportValue(this.context, SInfoResultType.location));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
118
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
119 return lines.toArray(new String[lines.size()]);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
120 }
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 final void addJRMetaData(final MetaAndTableJRDataSource source, final InundationDurationCalculationResults results) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
124
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
125 /* general metadata */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
126 super.addJRMetaData(source, results);
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
127
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
128 /* column headings */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
129 source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta()));
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
130
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
131 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
132
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
133 @Override
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
134 protected void writePDF(final OutputStream out) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
135 try {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
136 final MetaAndTableJRDataSource source = createJRData(this.data);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
137
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
138 final JasperReporter reporter = new JasperReporter();
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
139 reporter.addReport(JASPER_FILE, source);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
140 reporter.exportPDF(out);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
141 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
142 catch (final JRException je) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
143 getLog().warn("Error generating PDF Report!", je);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
144 }
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
145 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
146
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
147 }

http://dive4elements.wald.intevation.org