annotate artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/inundationduration/InundationDurationExporter.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.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;
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.common.SInfoResultType;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.uinfo.commons.AbstractUInfoExporter;
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 InundationDurationExporter extends AbstractUInfoExporter<InundationDurationCalculationResult, InundationDurationCalculationResults> {
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(InundationDurationExporter.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.inundationduration.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 InundationDurationCalculationResults 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);
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
49 writer.writeNext(new String[] { "" }); // break line
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
50 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
51
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
52 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
53 protected void writeCSVResultMetadata(final CSVWriter writer, final InundationDurationCalculationResults results,
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
54 final InundationDurationCalculationResult result) {
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 * final BedHeightInfo sounding = result.getSounding();
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
58 * super.writeCSVSoundingMetadata(writer, sounding);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
59 * final WstInfo wst = result.getWst();
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
60 * super.writeCSVWaterlevelMetadata(writer, wst);
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 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
65 * Write the header, with different headings depending on whether at a
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
66 * gauge or at a location.
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
67 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
68 * @param river
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
69 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
70 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
71 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
72 protected void writeCSVHeader(final CSVWriter writer, final InundationDurationCalculationResults results, final RiverInfo river) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
73 log.info("FlowDepthExporter.writeCSVHeader");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
74
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
75 final Collection<String> header = new ArrayList<>(11);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
76
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
77 header.add(msg(GeneralResultType.station.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
78 header.add(msgUnit(SInfoResultType.flowdepth.getCsvHeader(), SInfoResultType.flowdepth.getUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
79
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
80 header.add(msgUnit(SInfoResultType.waterlevel.getCsvHeader(), river.getWstUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
81 header.add(msgUnit(SInfoResultType.discharge.getCsvHeader(), SInfoResultType.discharge.getUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
82 header.add(msg(SInfoResultType.waterlevelLabel.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
83 header.add(msg(SInfoResultType.gaugeLabel.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
84 header.add(msgUnit(SInfoResultType.meanBedHeight.getCsvHeader(), river.getWstUnit()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
85 header.add(msg(SInfoResultType.soundingLabel.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
86 header.add(msg(SInfoResultType.location.getCsvHeader()));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
87
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
88 writer.writeNext(header.toArray(new String[header.size()]));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
89 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
90
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
91 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
92 * 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
93 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
94 * @param pdf
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
95 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
96 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
97 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
98 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
99 protected String[] formatRow(final InundationDurationCalculationResults results, final ResultRow row, final ExportMode mode) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
100
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
101 final Collection<String> lines = new ArrayList<>(11);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
102
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
103 lines.add(row.exportValue(this.context, GeneralResultType.station));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
104 lines.add(row.exportValue(this.context, SInfoResultType.flowdepth));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
105
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
106 lines.add(row.exportValue(this.context, SInfoResultType.waterlevel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
107 lines.add(row.exportValue(this.context, SInfoResultType.discharge));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
108 lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
109 lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
110 lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
111 lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
112 lines.add(row.exportValue(this.context, SInfoResultType.location));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
113
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
114 return lines.toArray(new String[lines.size()]);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
115 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
116
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
117 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
118 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final InundationDurationCalculationResults results) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
119
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
120 /* general metadata */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
121 super.addJRMetaData(source, results);
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
122
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
123 /* column headings */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
124 source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta()));
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
125
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
126 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
127
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
128 @Override
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
129 protected void writePDF(final OutputStream out) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
130 try {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
131 final MetaAndTableJRDataSource source = createJRData(this.data);
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 final JasperReporter reporter = new JasperReporter();
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
134 reporter.addReport(JASPER_FILE, source);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
135 reporter.exportPDF(out);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
136 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
137 catch (final JRException je) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
138 getLog().warn("Error generating PDF Report!", je);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
139 }
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
140 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
141
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
142 }

http://dive4elements.wald.intevation.org