Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepthdev/FlowDepthDevelopmentExporter.java @ 9006:7134a4c7d1b6
U-Info S-Info general work
author | gernotbelger |
---|---|
date | Tue, 17 Apr 2018 13:20:25 +0200 |
parents | d5802f22e4f5 |
children | 23945061daec |
rev | line source |
---|---|
8951 | 1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde |
2 * Software engineering by Intevation GmbH | |
3 * | |
4 * This file is Free Software under the GNU AGPL (>=v3) | |
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the | |
6 * documentation coming with Dive4Elements River for details. | |
7 */ | |
8 | |
9 package org.dive4elements.river.artifacts.sinfo.flowdepthdev; | |
10 | |
9006 | 11 import java.io.OutputStream; |
8951 | 12 import java.util.ArrayList; |
13 import java.util.Collection; | |
14 | |
15 import org.apache.log4j.Logger; | |
8997 | 16 import org.dive4elements.river.artifacts.common.GeneralResultType; |
9006 | 17 import org.dive4elements.river.artifacts.common.JasperReporter; |
18 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource; | |
8997 | 19 import org.dive4elements.river.artifacts.common.ResultRow; |
8951 | 20 import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter; |
21 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; | |
22 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; | |
23 | |
24 import au.com.bytecode.opencsv.CSVWriter; | |
9006 | 25 import net.sf.jasperreports.engine.JRException; |
8951 | 26 |
27 /** | |
28 * Generates different output formats (csv, pdf) of data that resulted from a flow depths computation. | |
29 * | |
30 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
31 * @author Gernot Belger | |
32 */ | |
33 // REMARK: must be public because its registered in generators.xml | |
34 public class FlowDepthDevelopmentExporter extends AbstractSInfoExporter<FlowDepthDevelopmentCalculationResult, FlowDepthDevelopmentCalculationResults> { | |
35 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
36 private static final String CSV_META_HEADER_SOUNDING_CURRENT = "sinfo.export.csv.meta.header.sounding.current"; |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
37 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
38 private static final String CSV_META_HEADER_SOUNDING_HISTORICAL = "sinfo.export.csv.meta.header.sounding.historical"; |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
39 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
40 private static final String CSV_META_HEADER_WATERLEVEL_CURRENT = "sinfo.export.csv.meta.header.waterlevel.current"; |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
41 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
42 private static final String CSV_META_HEADER_WATERLEVEL_HISTORICAL = "sinfo.export.csv.meta.header.waterlevel.historical"; |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
43 |
8951 | 44 /** The log used in this exporter. */ |
45 private static Logger log = Logger.getLogger(FlowDepthDevelopmentExporter.class); | |
46 | |
9006 | 47 private static final String JASPER_FILE = "/jasper/templates/sinfo.flowdepthdevelopment.jrxml"; |
8951 | 48 |
49 @Override | |
50 protected Logger getLog() { | |
51 return log; | |
52 } | |
53 | |
54 @Override | |
55 protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results, | |
56 final FlowDepthDevelopmentCalculationResult result) { | |
57 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
58 writeCSVSoundingMetadata(writer, result.getCurrentSounding(), CSV_META_HEADER_SOUNDING_CURRENT); |
8997 | 59 writer.writeNext(new String[] { "" }); // break line |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
60 writeCSVWaterlevelMetadata(writer, result.getCurrentWst(), CSV_META_HEADER_WATERLEVEL_CURRENT); |
8997 | 61 writer.writeNext(new String[] { "" }); // break line |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
62 writeCSVSoundingMetadata(writer, result.getHistoricalSounding(), CSV_META_HEADER_SOUNDING_HISTORICAL); |
8997 | 63 writer.writeNext(new String[] { "" }); // break line |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
64 writeCSVWaterlevelMetadata(writer, result.getHistoricalWst(), CSV_META_HEADER_WATERLEVEL_HISTORICAL); |
9006 | 65 writer.writeNext(new String[] { "" }); // break line |
8951 | 66 } |
67 | |
68 @Override | |
69 protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results) { | |
70 super.writeCSVGlobalMetadataDefaults(writer, results); | |
71 } | |
72 | |
73 /** | |
74 * Write the header, with different headings depending on whether at a | |
75 * gauge or at a location. | |
76 * | |
77 * @param river | |
78 * @param useTkh | |
79 */ | |
80 @Override | |
81 protected void writeCSVHeader(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results, final RiverInfo river) { | |
82 log.info("FlowDepthExporter.writeCSVHeader"); | |
83 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
84 final FlowDepthDevelopmentCalculationResult result = results.getResult(); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
85 |
8951 | 86 final Collection<String> header = new ArrayList<>(11); |
87 | |
8997 | 88 header.add(msg(GeneralResultType.station.getCsvHeader())); |
8951 | 89 header.add(msgUnit(SInfoResultType.flowdepthDevelopment.getCsvHeader(), SInfoResultType.flowdepthDevelopment.getUnit())); |
90 header.add(msgUnit(SInfoResultType.flowdepthDevelopmentPerYear.getCsvHeader(), SInfoResultType.flowdepthDevelopmentPerYear.getUnit())); | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
91 header.add(msgUnitLabel(SInfoResultType.waterlevelDifference.getCsvHeader(), SInfoResultType.waterlevelDifference.getUnit(), |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
92 result.getWaterlevelDifferenceLabel())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
93 header.add(msgUnitLabel(SInfoResultType.bedHeightDifference.getCsvHeader(), SInfoResultType.bedHeightDifference.getUnit(), |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
94 result.getBedHeightDifferenceLabel())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
95 header.add( |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
96 msgUnitLabel(SInfoResultType.flowdepthCurrent.getCsvHeader(), SInfoResultType.flowdepthCurrent.getUnit(), result.getFlowDepthCurrentLabel())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
97 header.add(msgUnitLabel(SInfoResultType.flowdepthHistorical.getCsvHeader(), SInfoResultType.flowdepthHistorical.getUnit(), |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
98 result.getFlowDepthHistoricalLabel())); |
8951 | 99 header.add(msg(SInfoResultType.location.getCsvHeader())); |
100 | |
101 writer.writeNext(header.toArray(new String[header.size()])); | |
102 } | |
103 | |
104 /** | |
105 * Format a row of a flow depth result into an array of string, both used by csv and pdf | |
106 * | |
107 * @param result | |
108 * | |
109 * @param useTkh | |
110 */ | |
8997 | 111 @Override |
112 protected String[] formatRow(final FlowDepthDevelopmentCalculationResults results, final ResultRow row, final ExportMode mode) { | |
8951 | 113 |
114 final Collection<String> lines = new ArrayList<>(10); | |
115 | |
8997 | 116 lines.add(row.exportValue(this.context, GeneralResultType.station)); |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
117 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthDevelopment)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
118 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthDevelopmentPerYear)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
119 lines.add(row.exportValue(this.context, SInfoResultType.waterlevelDifference)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
120 lines.add(row.exportValue(this.context, SInfoResultType.bedHeightDifference)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
121 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthCurrent)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
122 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthHistorical)); |
8951 | 123 lines.add(row.exportValue(this.context, SInfoResultType.location)); |
124 | |
125 return lines.toArray(new String[lines.size()]); | |
126 } | |
127 | |
128 @Override | |
129 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthDevelopmentCalculationResults results) { | |
130 | |
131 /* general metadata */ | |
8997 | 132 super.addJRMetaData(source, results); |
8951 | 133 |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
134 final FlowDepthDevelopmentCalculationResult result = results.getResult(); |
8984 | 135 source.addMetaData("flowdepthdevelopment", result.getLabel()); |
8997 | 136 source.addMetaData("flowdepthdevelopment_header_label", SInfoResultType.flowdepthDevelopment.getCsvHeader(this.context.getMeta()));// (this.context.getMeta())); |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
137 |
8951 | 138 /* column headings */ |
8997 | 139 source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta())); |
8984 | 140 source.addMetaData("flowdepthdevelopment_header", SInfoResultType.flowdepthDevelopment.getPdfHeader(this.context.getMeta())); |
141 source.addMetaData("flowdepthdevelopmentperyear_header", SInfoResultType.flowdepthDevelopmentPerYear.getPdfHeader(this.context.getMeta())); | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
142 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
143 source.addMetaData("waterleveldifference_header", SInfoResultType.waterlevelDifference.getPdfHeader(this.context.getMeta())); |
8984 | 144 source.addMetaData("waterleveldifference_header2", result.getWaterlevelDifferenceLabel()); |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
145 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
146 source.addMetaData("bedheightdifference_header", SInfoResultType.bedHeightDifference.getPdfHeader(this.context.getMeta())); |
8984 | 147 source.addMetaData("bedheightdifference_header2", result.getBedHeightDifferenceLabel()); |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
148 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
149 source.addMetaData("flowdepthcurrent_header", SInfoResultType.flowdepthCurrent.getPdfHeader(this.context.getMeta())); |
8984 | 150 source.addMetaData("flowdepthcurrent_header2", result.getFlowDepthCurrentLabel()); |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
151 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
152 source.addMetaData("flowdepthhistorical_header", SInfoResultType.flowdepthHistorical.getPdfHeader(this.context.getMeta())); |
8984 | 153 source.addMetaData("flowdepthhistorical_header2", result.getFlowDepthHistoricalLabel()); |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
154 |
8951 | 155 source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta())); |
156 } | |
157 | |
9006 | 158 @Override |
159 protected void writePDF(final OutputStream out) { | |
160 try { | |
161 final MetaAndTableJRDataSource source = createJRData(this.data); | |
162 | |
163 final JasperReporter reporter = new JasperReporter(); | |
164 reporter.addReport(JASPER_FILE, source); | |
165 reporter.exportPDF(out); | |
166 } | |
167 catch (final JRException je) { | |
168 getLog().warn("Error generating PDF Report!", je); | |
169 } | |
170 } | |
171 | |
8951 | 172 } |