Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepthminmax/FlowDepthMinMaxExporter.java @ 8997:d5802f22e4f5
Work on uinfo
| author | gernotbelger |
|---|---|
| date | Thu, 12 Apr 2018 19:14:19 +0200 |
| parents | 0adc6d04de95 |
| children | 7134a4c7d1b6 |
| rev | line source |
|---|---|
| 8946 | 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.flowdepthminmax; | |
| 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; | |
| 8946 | 17 import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter; |
| 8948 | 18 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; |
| 8946 | 19 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo; |
| 20 import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource; | |
| 21 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; | |
| 22 import org.dive4elements.river.artifacts.sinfo.util.WstInfo; | |
| 23 | |
| 24 import au.com.bytecode.opencsv.CSVWriter; | |
| 25 | |
| 26 /** | |
| 27 * Generates different output formats (csv, pdf) of data that resulted from a flow depths computation. | |
| 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 FlowDepthMinMaxExporter extends AbstractSInfoExporter<FlowDepthMinMaxCalculationResult, FlowDepthMinMaxCalculationResults> { |
| 8946 | 34 |
| 35 /** The log used in this exporter. */ | |
| 36 private static Logger log = Logger.getLogger(FlowDepthMinMaxExporter.class); | |
| 37 | |
| 8948 | 38 private static final String JASPER_FILE = "/jasper/sinfo.flowdepthminmax.jasper"; |
| 8946 | 39 |
| 40 @Override | |
| 41 protected Logger getLog() { | |
| 42 return log; | |
| 43 } | |
| 44 | |
| 45 @Override | |
| 46 protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthMinMaxCalculationResults results, | |
| 47 final FlowDepthMinMaxCalculationResult result) { | |
| 48 | |
|
8993
0adc6d04de95
SInfo - FlowDepthMinMax: choosing bed heights, not bed height min and max separately
gernotbelger
parents:
8949
diff
changeset
|
49 final BedHeightInfo sounding = result.getSounding(); |
| 8946 | 50 super.writeCSVSoundingMetadata(writer, sounding); |
| 8997 | 51 writer.writeNext(new String[] { "" }); // break line |
| 8946 | 52 final WstInfo wst = result.getWst(); |
| 53 writeCSVWaterlevelMetadata(writer, wst); | |
| 54 } | |
| 55 | |
| 56 @Override | |
| 57 protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthMinMaxCalculationResults results) { | |
| 58 | |
| 59 super.writeCSVGlobalMetadataDefaults(writer, results); | |
| 60 } | |
| 61 | |
| 62 /** | |
| 63 * Write the header, with different headings depending on whether at a | |
| 64 * gauge or at a location. | |
| 65 * | |
| 66 * @param river | |
| 67 * @param useTkh | |
| 68 */ | |
| 69 @Override | |
| 70 protected void writeCSVHeader(final CSVWriter writer, final FlowDepthMinMaxCalculationResults results, final RiverInfo river) { | |
| 71 log.info("FlowDepthExporter.writeCSVHeader"); | |
| 72 | |
| 73 final Collection<String> header = new ArrayList<>(11); | |
| 74 | |
| 8997 | 75 header.add(msg(GeneralResultType.station.getCsvHeader())); |
| 8948 | 76 header.add(msgUnit(SInfoResultType.flowdepthmin.getCsvHeader(), SInfoResultType.flowdepthmin.getUnit())); |
| 77 header.add(msgUnit(SInfoResultType.flowdepthmax.getCsvHeader(), SInfoResultType.flowdepthmax.getUnit())); | |
| 78 header.add(msgUnit(SInfoResultType.waterlevel.getCsvHeader(), river.getWstUnit())); | |
| 79 header.add(msgUnit(SInfoResultType.discharge.getCsvHeader(), SInfoResultType.discharge.getUnit())); | |
| 80 header.add(msg(SInfoResultType.waterlevelLabel.getCsvHeader())); | |
| 81 header.add(msg(SInfoResultType.gaugeLabel.getCsvHeader())); | |
| 82 header.add(msgUnit(SInfoResultType.meanBedHeight.getCsvHeader(), river.getWstUnit())); | |
| 83 header.add(msg(SInfoResultType.soundingLabel.getCsvHeader())); | |
| 84 header.add(msg(SInfoResultType.location.getCsvHeader())); | |
| 8946 | 85 |
| 86 writer.writeNext(header.toArray(new String[header.size()])); | |
| 87 } | |
| 88 | |
| 89 /** | |
| 90 * Format a row of a flow depth result into an array of string, both used by csv and pdf | |
| 91 * | |
| 8948 | 92 * @param result |
| 93 * | |
| 8946 | 94 * @param useTkh |
| 95 */ | |
| 8997 | 96 @Override |
| 97 protected String[] formatRow(final FlowDepthMinMaxCalculationResults results, final ResultRow row, final ExportMode mode) { | |
| 8946 | 98 |
| 8948 | 99 final Collection<String> lines = new ArrayList<>(10); |
| 8946 | 100 |
| 8997 | 101 lines.add(row.exportValue(this.context, GeneralResultType.station)); |
| 8946 | 102 |
| 8948 | 103 // REMARK: null check as pdf will call this with null and in that case we show all columns (to avoid multiple jasper |
| 104 // FIXME: does not work like this: we may have several pairs of min/max; so we need to look at all of them? | |
| 105 // templates) | |
| 106 // if (result == null || result.getMinSounding() != null) | |
| 107 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthmin)); | |
| 108 // if (result == null || result.getMaxSounding() != null) | |
| 109 lines.add(row.exportValue(this.context, SInfoResultType.flowdepthmax)); | |
| 8946 | 110 |
| 8948 | 111 lines.add(row.exportValue(this.context, SInfoResultType.waterlevel)); |
| 112 lines.add(row.exportValue(this.context, SInfoResultType.discharge)); | |
| 113 lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel)); | |
| 114 lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel)); | |
| 115 lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight)); | |
| 116 lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel)); | |
| 117 lines.add(row.exportValue(this.context, SInfoResultType.location)); | |
| 8946 | 118 |
| 119 return lines.toArray(new String[lines.size()]); | |
| 120 } | |
| 121 | |
| 122 @Override | |
| 123 protected final String getJasperFile() { | |
| 124 return JASPER_FILE; | |
| 125 } | |
| 126 | |
| 127 @Override | |
| 128 protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthMinMaxCalculationResults results) { | |
| 129 | |
| 130 /* general metadata */ | |
| 8997 | 131 super.addJRMetaData(source, results); |
| 8946 | 132 |
| 133 /* column headings */ | |
| 8997 | 134 source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta())); |
|
8949
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
135 source.addMetaData("flowdepthmin_header", SInfoResultType.flowdepthmin.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
136 source.addMetaData("flowdepthmax_header", SInfoResultType.flowdepthmax.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
137 source.addMetaData("waterlevel_header", SInfoResultType.waterlevel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
138 source.addMetaData("discharge_header", SInfoResultType.discharge.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
139 source.addMetaData("waterlevel_name_header", SInfoResultType.waterlevelLabel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
140 source.addMetaData("gauge_header", SInfoResultType.gaugeLabel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
141 source.addMetaData("bedheight_header", SInfoResultType.meanBedHeight.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
142 source.addMetaData("sounding_name_header", SInfoResultType.soundingLabel.getPdfHeader(this.context.getMeta())); |
|
09e4a4909814
Distinguish between csv and pdf column headers
gernotbelger
parents:
8948
diff
changeset
|
143 source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta())); |
| 8946 | 144 } |
| 145 | |
| 146 } |