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