Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepth/FlowDepthExporter.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 |
|---|---|
| 8854 | 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.flowdepth; | |
| 10 | |
| 9006 | 11 import java.io.OutputStream; |
| 8854 | 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.JasperDesigner; |
| 18 import org.dive4elements.river.artifacts.common.JasperReporter; | |
| 19 import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource; | |
| 8997 | 20 import org.dive4elements.river.artifacts.common.ResultRow; |
| 8928 | 21 import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter; |
| 8948 | 22 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; |
| 8894 | 23 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo; |
| 24 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; | |
| 25 import org.dive4elements.river.artifacts.sinfo.util.WstInfo; | |
| 8854 | 26 |
| 27 import au.com.bytecode.opencsv.CSVWriter; | |
| 9006 | 28 import net.sf.jasperreports.engine.JRException; |
| 8854 | 29 |
| 30 /** | |
|
8946
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
31 * Generates different output formats (csv, pdf) of data that resulted from a flow depths min/max computation. |
| 8854 | 32 * |
| 33 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
| 34 * @author Gernot Belger | |
| 35 */ | |
| 36 // REMARK: must be public because its registered in generators.xml | |
| 8948 | 37 public class FlowDepthExporter extends AbstractSInfoExporter<FlowDepthCalculationResult, FlowDepthCalculationResults> { |
| 8854 | 38 |
| 8877 | 39 /** The log used in this exporter. */ |
| 8854 | 40 private static Logger log = Logger.getLogger(FlowDepthExporter.class); |
| 41 | |
| 8997 | 42 private static final String JASPER_FILE = "/jasper/templates/sinfo.flowdepth.jrxml"; // TODO use jrxml-path all over the project |
| 8863 | 43 |
| 8928 | 44 @Override |
| 45 protected Logger getLog() { | |
| 46 return log; | |
| 8863 | 47 } |
| 8877 | 48 |
| 8854 | 49 @Override |
|
8946
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
50 protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthCalculationResults results) { |
|
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
51 log.info("FlowDepthExporter.writeCSVMeta"); |
|
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
52 super.writeCSVGlobalMetadataDefaults(writer, results); |
| 8877 | 53 } |
| 8854 | 54 |
| 8928 | 55 @Override |
|
8946
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
56 protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthCalculationResults results, final FlowDepthCalculationResult result) { |
| 8854 | 57 |
|
8946
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
58 final BedHeightInfo sounding = result.getSounding(); |
|
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
59 super.writeCSVSoundingMetadata(writer, sounding); |
| 8854 | 60 |
| 8997 | 61 writer.writeNext(new String[] { "" }); // break line |
| 62 | |
|
8946
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
63 final WstInfo wst = result.getWst(); |
|
5d5d482da3e9
Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents:
8938
diff
changeset
|
64 super.writeCSVWaterlevelMetadata(writer, wst); |
| 8997 | 65 |
| 9006 | 66 writer.writeNext(new String[] { "" }); // break line |
| 67 | |
| 8854 | 68 } |
| 69 | |
| 8877 | 70 /** |
| 8854 | 71 * Write the header, with different headings depending on whether at a |
| 72 * gauge or at a location. | |
| 8877 | 73 * |
| 74 * @param river | |
| 75 * @param useTkh | |
| 8854 | 76 */ |
| 8928 | 77 @Override |
|
8938
9c02733a1b3c
Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents:
8928
diff
changeset
|
78 protected void writeCSVHeader(final CSVWriter writer, final FlowDepthCalculationResults results, final RiverInfo river) { |
| 8854 | 79 log.info("FlowDepthExporter.writeCSVHeader"); |
| 80 | |
| 81 final Collection<String> header = new ArrayList<>(11); | |
| 8877 | 82 |
| 8997 | 83 header.add(msg(GeneralResultType.station.getCsvHeader())); |
| 8948 | 84 header.add(msgUnit(SInfoResultType.flowdepth.getCsvHeader(), SInfoResultType.flowdepth.getUnit())); |
| 85 | |
| 86 if (results.isUseTkh()) { | |
| 87 header.add(msgUnit(SInfoResultType.flowdepthtkh.getCsvHeader(), SInfoResultType.flowdepthtkh.getUnit())); | |
| 88 header.add(msgUnit(SInfoResultType.tkh.getCsvHeader(), SInfoResultType.tkh.getUnit())); | |
| 8854 | 89 } |
| 8863 | 90 |
| 8948 | 91 header.add(msgUnit(SInfoResultType.waterlevel.getCsvHeader(), river.getWstUnit())); |
| 92 header.add(msgUnit(SInfoResultType.discharge.getCsvHeader(), SInfoResultType.discharge.getUnit())); | |
| 93 header.add(msg(SInfoResultType.waterlevelLabel.getCsvHeader())); | |
| 94 header.add(msg(SInfoResultType.gaugeLabel.getCsvHeader())); | |
| 95 header.add(msgUnit(SInfoResultType.meanBedHeight.getCsvHeader(), river.getWstUnit())); | |
| 96 header.add(msg(SInfoResultType.soundingLabel.getCsvHeader())); | |
| 97 header.add(msg(SInfoResultType.location.getCsvHeader())); | |
| 8854 | 98 |
| 8877 | 99 writer.writeNext(header.toArray(new String[header.size()])); |
| 8854 | 100 } |
| 101 | |
| 102 /** | |
| 103 * Format a row of a flow depth result into an array of string, both used by csv and pdf | |
| 8877 | 104 * |
|
8954
183f42641ab6
Fixed: flowd depth calculation without transport bodies heights did not work any more
gernotbelger
parents:
8949
diff
changeset
|
105 * @param pdf |
|
183f42641ab6
Fixed: flowd depth calculation without transport bodies heights did not work any more
gernotbelger
parents:
8949
diff
changeset
|
106 * |
| 8877 | 107 * @param useTkh |
| 8854 | 108 */ |
| 8997 | 109 @Override |
| 110 protected String[] formatRow(final FlowDepthCalculationResults results, final ResultRow row, final ExportMode mode) { | |
| 8854 | 111 |
| 8877 | 112 final Collection<String> lines = new ArrayList<>(11); |
| 8854 | 113 |
| 8997 | 114 lines.add(row.exportValue(this.context, GeneralResultType.station)); |
| 8948 | 115 lines.add(row.exportValue(this.context, SInfoResultType.flowdepth)); |
| 8877 | 116 |
|
8954
183f42641ab6
Fixed: flowd depth calculation without transport bodies heights did not work any more
gernotbelger
parents:
8949
diff
changeset
|
117 if (mode == ExportMode.pdf || getData().isUseTkh()) { |
| 8948 | 118 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthtkh)); |
| 119 lines.add(row.exportValue(this.context, SInfoResultType.tkh)); | |
| 8877 | 120 } |
| 121 | |
| 8948 | 122 lines.add(row.exportValue(this.context, SInfoResultType.waterlevel)); |
| 123 lines.add(row.exportValue(this.context, SInfoResultType.discharge)); | |
| 124 lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel)); | |
| 125 lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel)); | |
| 126 lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight)); | |
| 127 lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel)); | |
| 128 lines.add(row.exportValue(this.context, SInfoResultType.location)); | |
| 8877 | 129 |
| 130 return lines.toArray(new String[lines.size()]); | |
| 8854 | 131 } |
| 8877 | 132 |
| 8928 | 133 @Override |
| 9006 | 134 protected void writePDF(final OutputStream out) { |
| 135 | |
| 136 try { | |
| 137 final MetaAndTableJRDataSource source = createJRData(this.data); | |
| 138 final JasperReporter reporter = new JasperReporter(); | |
| 139 final JasperDesigner design = reporter.addReport(JASPER_FILE, source); | |
| 140 | |
| 141 if (!getData().isUseTkh()) { | |
| 142 design.removeColumn("tkh"); | |
| 143 design.removeColumn("flowdepthtkh"); | |
| 144 } | |
| 145 reporter.exportPDF(out); | |
| 146 } | |
| 147 catch (final JRException je) { | |
| 148 getLog().warn("Error generating PDF Report!", je); | |
| 149 } | |
| 8854 | 150 } |
| 151 | |
| 8877 | 152 @Override |
| 8928 | 153 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthCalculationResults results) { |
| 8854 | 154 |
| 8877 | 155 /* general metadata */ |
| 8997 | 156 super.addJRMetaData(source, results); |
| 8854 | 157 |
| 8863 | 158 /* column headings */ |
| 8997 | 159 source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta())); |
|
8949
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
160 source.addMetaData("flowdepth_header", SInfoResultType.flowdepth.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
161 source.addMetaData("flowdepth_tkh_header", SInfoResultType.flowdepthtkh.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
162 source.addMetaData("tkh_header", SInfoResultType.tkh.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
163 source.addMetaData("waterlevel_header", SInfoResultType.waterlevel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
164 source.addMetaData("discharge_header", SInfoResultType.discharge.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
165 source.addMetaData("waterlevel_name_header", SInfoResultType.waterlevelLabel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
166 source.addMetaData("gauge_header", SInfoResultType.gaugeLabel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
167 source.addMetaData("bedheight_header", SInfoResultType.meanBedHeight.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
168 source.addMetaData("sounding_name_header", SInfoResultType.soundingLabel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
169 source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta())); |
| 8854 | 170 } |
| 171 | |
| 8928 | 172 } |