Mercurial > dive4elements > river
view artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepth/FlowDepthExporter.java @ 8948:a4f1ac81f26d
Work on SINFO-FlowDepthMinMax.
Also rework of result row stuff, in order to reduce abstraction, using result type concept
author | gernotbelger |
---|---|
date | Wed, 14 Mar 2018 14:10:32 +0100 |
parents | 5d5d482da3e9 |
children | 09e4a4909814 |
line wrap: on
line source
/* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde * Software engineering by Intevation GmbH * * This file is Free Software under the GNU AGPL (>=v3) * and comes with ABSOLUTELY NO WARRANTY! Check out the * documentation coming with Dive4Elements River for details. */ package org.dive4elements.river.artifacts.sinfo.flowdepth; import java.util.ArrayList; import java.util.Collection; import org.apache.log4j.Logger; import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter; import org.dive4elements.river.artifacts.sinfo.common.SInfoResultRow; import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo; import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource; import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; import org.dive4elements.river.artifacts.sinfo.util.WstInfo; import au.com.bytecode.opencsv.CSVWriter; /** * Generates different output formats (csv, pdf) of data that resulted from a flow depths min/max computation. * * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> * @author Gernot Belger */ // REMARK: must be public because its registered in generators.xml public class FlowDepthExporter extends AbstractSInfoExporter<FlowDepthCalculationResult, FlowDepthCalculationResults> { /** The log used in this exporter. */ private static Logger log = Logger.getLogger(FlowDepthExporter.class); private static final String JASPER_FILE = "/jasper/sinfo.flowdepth.jasper"; @Override protected Logger getLog() { return log; } @Override protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthCalculationResults results) { log.info("FlowDepthExporter.writeCSVMeta"); super.writeCSVGlobalMetadataDefaults(writer, results); writer.writeNext(new String[] { "" }); } @Override protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthCalculationResults results, final FlowDepthCalculationResult result) { final BedHeightInfo sounding = result.getSounding(); super.writeCSVSoundingMetadata(writer, sounding); final WstInfo wst = result.getWst(); super.writeCSVWaterlevelMetadata(writer, wst); } /** * Write the header, with different headings depending on whether at a * gauge or at a location. * * @param river * @param useTkh */ @Override protected void writeCSVHeader(final CSVWriter writer, final FlowDepthCalculationResults results, final RiverInfo river) { log.info("FlowDepthExporter.writeCSVHeader"); final Collection<String> header = new ArrayList<>(11); header.add(msg(SInfoResultType.station.getCsvHeader())); header.add(msgUnit(SInfoResultType.flowdepth.getCsvHeader(), SInfoResultType.flowdepth.getUnit())); if (results.isUseTkh()) { header.add(msgUnit(SInfoResultType.flowdepthtkh.getCsvHeader(), SInfoResultType.flowdepthtkh.getUnit())); header.add(msgUnit(SInfoResultType.tkh.getCsvHeader(), SInfoResultType.tkh.getUnit())); } header.add(msgUnit(SInfoResultType.waterlevel.getCsvHeader(), river.getWstUnit())); header.add(msgUnit(SInfoResultType.discharge.getCsvHeader(), SInfoResultType.discharge.getUnit())); header.add(msg(SInfoResultType.waterlevelLabel.getCsvHeader())); header.add(msg(SInfoResultType.gaugeLabel.getCsvHeader())); header.add(msgUnit(SInfoResultType.meanBedHeight.getCsvHeader(), river.getWstUnit())); header.add(msg(SInfoResultType.soundingLabel.getCsvHeader())); header.add(msg(SInfoResultType.location.getCsvHeader())); writer.writeNext(header.toArray(new String[header.size()])); } @Override protected String[] formatCSVRow(final FlowDepthCalculationResults results, final FlowDepthCalculationResult result, final SInfoResultRow row) { return formatRow(row); } /** * Format a row of a flow depth result into an array of string, both used by csv and pdf * * @param useTkh */ private String[] formatRow(final SInfoResultRow row) { final Collection<String> lines = new ArrayList<>(11); lines.add(row.exportValue(this.context, SInfoResultType.station)); lines.add(row.exportValue(this.context, SInfoResultType.flowdepth)); if (getData().isUseTkh()) { lines.add(row.exportValue(this.context, SInfoResultType.flowdepthtkh)); lines.add(row.exportValue(this.context, SInfoResultType.tkh)); } lines.add(row.exportValue(this.context, SInfoResultType.waterlevel)); lines.add(row.exportValue(this.context, SInfoResultType.discharge)); lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel)); lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel)); lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight)); lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel)); lines.add(row.exportValue(this.context, SInfoResultType.location)); return lines.toArray(new String[lines.size()]); } @Override protected final String getJasperFile() { return JASPER_FILE; } @Override protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthCalculationResults results) { /* general metadata */ super.addJRMetaDataDefaults(source, results); /* column headings */ source.addMetaData("station_header", msg(SInfoResultType.station.getCsvHeader())); source.addMetaData("flowdepth_header", msg(SInfoResultType.flowdepth.getCsvHeader())); source.addMetaData("flowdepth_tkh_header", msg(SInfoResultType.flowdepthtkh.getCsvHeader())); source.addMetaData("tkh_header", msg(SInfoResultType.tkh.getCsvHeader())); source.addMetaData("waterlevel_header", msg(SInfoResultType.waterlevel.getCsvHeader())); source.addMetaData("discharge_header", msg(SInfoResultType.discharge.getCsvHeader())); source.addMetaData("waterlevel_name_header", msg(SInfoResultType.waterlevelLabel.getCsvHeader())); source.addMetaData("gauge_header", msg(SInfoResultType.gaugeLabel.getCsvHeader())); source.addMetaData("bedheight_header", msg(SInfoResultType.meanBedHeight.getCsvHeader())); source.addMetaData("sounding_name_header", msg(SInfoResultType.soundingLabel.getCsvHeader())); source.addMetaData("location_header", msg(SInfoResultType.location.getCsvHeader())); } @Override protected String[] formatPDFRow(final FlowDepthCalculationResults results, final SInfoResultRow row) { return formatRow(row); } }