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