Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepthdev/FlowDepthDevelopmentExporter.java @ 8953:c40db8e8dcae
SINFO - Flow depth development - implemented exporters
author | gernotbelger |
---|---|
date | Mon, 19 Mar 2018 14:01:21 +0100 |
parents | 322b0e6298ea |
children | 7c1611b5a59e |
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 | |
11 import java.util.ArrayList; | |
12 import java.util.Collection; | |
13 | |
14 import org.apache.log4j.Logger; | |
15 import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter; | |
16 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultRow; | |
17 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; | |
18 import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource; | |
19 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; | |
20 | |
21 import au.com.bytecode.opencsv.CSVWriter; | |
22 | |
23 /** | |
24 * Generates different output formats (csv, pdf) of data that resulted from a flow depths computation. | |
25 * | |
26 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
27 * @author Gernot Belger | |
28 */ | |
29 // REMARK: must be public because its registered in generators.xml | |
30 public class FlowDepthDevelopmentExporter extends AbstractSInfoExporter<FlowDepthDevelopmentCalculationResult, FlowDepthDevelopmentCalculationResults> { | |
31 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
32 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
|
33 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
34 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
|
35 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
36 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
|
37 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
38 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
|
39 |
8951 | 40 /** The log used in this exporter. */ |
41 private static Logger log = Logger.getLogger(FlowDepthDevelopmentExporter.class); | |
42 | |
43 private static final String JASPER_FILE = "/jasper/sinfo.flowdepthminmax.jasper"; | |
44 | |
45 @Override | |
46 protected Logger getLog() { | |
47 return log; | |
48 } | |
49 | |
50 @Override | |
51 protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results, | |
52 final FlowDepthDevelopmentCalculationResult result) { | |
53 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
54 writeCSVSoundingMetadata(writer, result.getCurrentSounding(), CSV_META_HEADER_SOUNDING_CURRENT); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
55 writeCSVWaterlevelMetadata(writer, result.getCurrentWst(), CSV_META_HEADER_WATERLEVEL_CURRENT); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
56 writeCSVSoundingMetadata(writer, result.getHistoricalSounding(), CSV_META_HEADER_SOUNDING_HISTORICAL); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
57 writeCSVWaterlevelMetadata(writer, result.getHistoricalWst(), CSV_META_HEADER_WATERLEVEL_HISTORICAL); |
8951 | 58 } |
59 | |
60 @Override | |
61 protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results) { | |
62 | |
63 super.writeCSVGlobalMetadataDefaults(writer, results); | |
64 | |
65 writer.writeNext(new String[] { "" }); | |
66 } | |
67 | |
68 /** | |
69 * Write the header, with different headings depending on whether at a | |
70 * gauge or at a location. | |
71 * | |
72 * @param river | |
73 * @param useTkh | |
74 */ | |
75 @Override | |
76 protected void writeCSVHeader(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results, final RiverInfo river) { | |
77 log.info("FlowDepthExporter.writeCSVHeader"); | |
78 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
79 final FlowDepthDevelopmentCalculationResult result = results.getResult(); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
80 |
8951 | 81 final Collection<String> header = new ArrayList<>(11); |
82 | |
83 header.add(msg(SInfoResultType.station.getCsvHeader())); | |
84 header.add(msgUnit(SInfoResultType.flowdepthDevelopment.getCsvHeader(), SInfoResultType.flowdepthDevelopment.getUnit())); | |
85 header.add(msgUnit(SInfoResultType.flowdepthDevelopmentPerYear.getCsvHeader(), SInfoResultType.flowdepthDevelopmentPerYear.getUnit())); | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
86 header.add(msgUnitLabel(SInfoResultType.waterlevelDifference.getCsvHeader(), SInfoResultType.waterlevelDifference.getUnit(), |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
87 result.getWaterlevelDifferenceLabel())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
88 header.add(msgUnitLabel(SInfoResultType.bedHeightDifference.getCsvHeader(), SInfoResultType.bedHeightDifference.getUnit(), |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
89 result.getBedHeightDifferenceLabel())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
90 header.add( |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
91 msgUnitLabel(SInfoResultType.flowdepthCurrent.getCsvHeader(), SInfoResultType.flowdepthCurrent.getUnit(), result.getFlowDepthCurrentLabel())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
92 header.add(msgUnitLabel(SInfoResultType.flowdepthHistorical.getCsvHeader(), SInfoResultType.flowdepthHistorical.getUnit(), |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
93 result.getFlowDepthHistoricalLabel())); |
8951 | 94 header.add(msg(SInfoResultType.location.getCsvHeader())); |
95 | |
96 writer.writeNext(header.toArray(new String[header.size()])); | |
97 } | |
98 | |
99 @Override | |
100 protected String[] formatCSVRow(final FlowDepthDevelopmentCalculationResults results, final FlowDepthDevelopmentCalculationResult result, | |
101 final SInfoResultRow row) { | |
102 return formatRow(result, row); | |
103 } | |
104 | |
105 /** | |
106 * Format a row of a flow depth result into an array of string, both used by csv and pdf | |
107 * | |
108 * @param result | |
109 * | |
110 * @param useTkh | |
111 */ | |
112 private String[] formatRow(final FlowDepthDevelopmentCalculationResult result, final SInfoResultRow row) { | |
113 | |
114 final Collection<String> lines = new ArrayList<>(10); | |
115 | |
116 lines.add(row.exportValue(this.context, SInfoResultType.station)); | |
117 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
118 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthDevelopment)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
119 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthDevelopmentPerYear)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
120 lines.add(row.exportValue(this.context, SInfoResultType.waterlevelDifference)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
121 lines.add(row.exportValue(this.context, SInfoResultType.bedHeightDifference)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
122 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthCurrent)); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
123 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthHistorical)); |
8951 | 124 lines.add(row.exportValue(this.context, SInfoResultType.location)); |
125 | |
126 return lines.toArray(new String[lines.size()]); | |
127 } | |
128 | |
129 @Override | |
130 protected final String getJasperFile() { | |
131 return JASPER_FILE; | |
132 } | |
133 | |
134 @Override | |
135 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthDevelopmentCalculationResults results) { | |
136 | |
137 /* general metadata */ | |
138 super.addJRMetaDataDefaults(source, results); | |
139 | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
140 final FlowDepthDevelopmentCalculationResult result = results.getResult(); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
141 |
8951 | 142 /* column headings */ |
143 source.addMetaData("station_header", SInfoResultType.station.getPdfHeader(this.context.getMeta())); | |
8953
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
144 source.addMetaData("flowdeptdevelopment_header", SInfoResultType.flowdepthDevelopment.getPdfHeader(this.context.getMeta())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
145 source.addMetaData("flowdeptdevelopmentperyear_header", SInfoResultType.flowdepthDevelopmentPerYear.getPdfHeader(this.context.getMeta())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
146 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
147 source.addMetaData("waterleveldifference_header", SInfoResultType.waterlevelDifference.getPdfHeader(this.context.getMeta())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
148 source.addMetaData("waterleveldifference_header_label", result.getWaterlevelDifferenceLabel()); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
149 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
150 source.addMetaData("bedheightdifference_header", SInfoResultType.bedHeightDifference.getPdfHeader(this.context.getMeta())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
151 source.addMetaData("bedheightdifference_header_label", result.getBedHeightDifferenceLabel()); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
152 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
153 source.addMetaData("flowdepthcurrent_header", SInfoResultType.flowdepthCurrent.getPdfHeader(this.context.getMeta())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
154 source.addMetaData("flowdepthcurrent_header_label", result.getFlowDepthCurrentLabel()); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
155 |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
156 source.addMetaData("flowdepthhistorical_header", SInfoResultType.flowdepthHistorical.getPdfHeader(this.context.getMeta())); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
157 source.addMetaData("flowdepthhistorical_header_label", result.getFlowDepthHistoricalLabel()); |
c40db8e8dcae
SINFO - Flow depth development - implemented exporters
gernotbelger
parents:
8951
diff
changeset
|
158 |
8951 | 159 source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta())); |
160 } | |
161 | |
162 @Override | |
163 protected String[] formatPDFRow(final FlowDepthDevelopmentCalculationResults results, final SInfoResultRow row) { | |
164 return formatRow(null, row); | |
165 } | |
166 } |