annotate artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/vegetationzones/VegetationZonesExporter.java @ 9023:c4c11358ffa9

test2
author gernotbelger
date Mon, 23 Apr 2018 17:29:37 +0200
parents ea3908c3cbb6
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.vegetationzones;
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
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
16 import org.apache.commons.lang.math.DoubleRange;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
17 import org.apache.log4j.Logger;
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
18 import org.dive4elements.river.artifacts.common.I18NStrings;
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.util.RiverInfo;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.uinfo.commons.AbstractUInfoExporter;
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
24 import org.dive4elements.river.artifacts.uinfo.commons.UInfoResultType;
8996
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 VegetationZonesExporter extends AbstractUInfoExporter<VegetationZonesCalculationResult, VegetationZonesCalculationResults> {
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(VegetationZonesExporter.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.vegetationzones.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 VegetationZonesCalculationResults results) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
47 log.info("SalixLineExporter.writeCSVMeta");
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
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
50 final DoubleRange calcRange = results.getCalcRange();
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
51 if (calcRange != null) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
52 // "# Ort/Bereich (km): "
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
53 writeCSVMetaEntry(writer, I18NStrings.CSV_META_RANGE, msg(I18NStrings.CSV_META_RANGE_LABEL), getKmFormatter().format(calcRange.getMinimumDouble()),
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
54 getKmFormatter().format(calcRange.getMaximumDouble()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
55 }
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
56 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
57
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
58 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
59 * Write the header, with different headings depending on whether at a
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
60 * gauge or at a location.
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
61 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
62 * @param river
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
63 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
64 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
65 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
66 protected void writeCSVHeader(final CSVWriter writer, final VegetationZonesCalculationResults results, final RiverInfo river) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
67 log.info("FlowDepthExporter.writeCSVHeader");
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
68
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
69 final Collection<String> header = new ArrayList<>(11);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
70
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
71 header.add(msg(UInfoResultType.vegname.getCsvHeader()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
72 header.add(msg(UInfoResultType.vegdauervon.getCsvHeader()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
73 header.add(msg(UInfoResultType.vegdauerbis.getCsvHeader()));
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
74
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
75 writer.writeNext(header.toArray(new String[header.size()]));
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
76 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
77
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
78 /**
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
79 * 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
80 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
81 * @param pdf
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
82 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
83 * @param useTkh
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
84 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
85 @Override
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
86 protected String[] formatRow(final VegetationZonesCalculationResults results, final ResultRow row, final ExportMode mode) {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
87
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
88 final Collection<String> lines = new ArrayList<>(11);
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
89
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
90 lines.add(row.exportValue(this.context, UInfoResultType.vegname));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
91 lines.add(row.exportValue(this.context, UInfoResultType.vegdauervon));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
92 lines.add(row.exportValue(this.context, UInfoResultType.vegdauerbis));
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
93
9023
gernotbelger
parents: 9022
diff changeset
94 return lines.toArray(new String[lines.size()]);
8996
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 @Override
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
98 protected void writeCSVResultMetadata(final CSVWriter writer, final VegetationZonesCalculationResults results,
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
99 final VegetationZonesCalculationResult result) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
100
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
101 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
102
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
103 @Override
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
104 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final VegetationZonesCalculationResults results) {
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
105
9006
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
106 super.addJRMetaData(source, results);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
107
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
108 /* additional column headings */
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
109 source.addMetaData("veg_name", UInfoResultType.vegname.getPdfHeader(this.context.getMeta()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
110 source.addMetaData("veg_dauervon", UInfoResultType.vegdauervon.getPdfHeader(this.context.getMeta()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
111 source.addMetaData("veg_dauerbis", UInfoResultType.vegdauerbis.getPdfHeader(this.context.getMeta()));
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
112 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
113
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
114 @Override
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
115 protected void writePDF(final OutputStream out) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
116 try {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
117 final MetaAndTableJRDataSource source = createJRData(this.data);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
118
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
119 final JasperReporter reporter = new JasperReporter();
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
120 reporter.addReport(JASPER_FILE, source);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
121 reporter.exportPDF(out);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
122 }
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
123 catch (final JRException je) {
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
124 getLog().warn("Error generating PDF Report!", je);
7134a4c7d1b6 U-Info S-Info general work
gernotbelger
parents: 8996
diff changeset
125 }
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
126 }
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
127
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
128 }

http://dive4elements.wald.intevation.org