teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde teichmann@5863: * Software engineering by Intevation GmbH teichmann@5863: * teichmann@5994: * This file is Free Software under the GNU AGPL (>=v3) teichmann@5863: * and comes with ABSOLUTELY NO WARRANTY! Check out the teichmann@5994: * documentation coming with Dive4Elements River for details. teichmann@5863: */ teichmann@5863: teichmann@5831: package org.dive4elements.river.exports; ingo@359: gernotbelger@9312: import org.apache.log4j.Logger; teichmann@5831: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet; teichmann@5831: import org.dive4elements.artifactdatabase.state.Facet; gernotbelger@9123: import org.dive4elements.artifacts.CallContext; teichmann@5867: import org.dive4elements.river.artifacts.D4EArtifact; teichmann@5831: import org.dive4elements.river.artifacts.geom.Lines; teichmann@5831: import org.dive4elements.river.artifacts.model.AreaFacet; teichmann@5831: import org.dive4elements.river.artifacts.model.FacetTypes; teichmann@5831: import org.dive4elements.river.artifacts.model.WKms; teichmann@5831: import org.dive4elements.river.artifacts.model.WQKms; gernotbelger@9312: import org.dive4elements.river.exports.process.AnnotationProcessor; felix@6689: import org.dive4elements.river.exports.process.BedDiffHeightYearProcessor; felix@6689: import org.dive4elements.river.exports.process.BedDiffYearProcessor; gernotbelger@9312: import org.dive4elements.river.exports.process.Processor; felix@6927: import org.dive4elements.river.exports.process.QOutProcessor; teichmann@5831: import org.dive4elements.river.exports.process.WOutProcessor; teichmann@5831: import org.dive4elements.river.jfree.StyledAreaSeriesCollection; teichmann@5831: import org.dive4elements.river.jfree.StyledXYSeries; teichmann@6905: import org.dive4elements.river.themes.ThemeDocument; teichmann@5865: import org.dive4elements.river.utils.RiverUtils; christian@3409: import org.jfree.chart.axis.NumberAxis; christian@3409: import org.jfree.chart.axis.ValueAxis; christian@3409: import org.jfree.chart.plot.XYPlot; christian@3409: import org.jfree.data.xy.XYSeries; felix@2664: felix@1035: /** felix@2206: * An OutGenerator that generates longitudinal section curves. ingo@359: * ingo@359: * @author Ingo Weinzierl ingo@359: */ gernotbelger@9312: public class LongitudinalSectionGenerator extends XYChartGenerator implements FacetTypes { felix@1953: public enum YAXIS { gernotbelger@9312: W(0), D(1), Q(2); felix@1931: protected int idx; gernotbelger@9312: gernotbelger@9312: private YAXIS(final int c) { gernotbelger@9312: this.idx = c; felix@1931: } felix@1931: } felix@1931: teichmann@8202: /** The log that is used in this generator. */ gernotbelger@9312: private static Logger log = Logger.getLogger(LongitudinalSectionGenerator.class); ingo@359: felix@1700: /** Key to look up internationalized String for annotations label. */ gernotbelger@9312: public static final String I18N_ANNOTATIONS_LABEL = "chart.longitudinal.annotations.label"; felix@1041: felix@1701: /** felix@1701: * Key to look up internationalized String for LongitudinalSection diagrams felix@1701: * titles. felix@1701: */ gernotbelger@9312: public static final String I18N_CHART_TITLE = "chart.longitudinal.section.title"; felix@1701: felix@1701: /** felix@1701: * Key to look up internationalized String for LongitudinalSection diagrams felix@1701: * subtitles. felix@1701: */ gernotbelger@9312: public static final String I18N_CHART_SUBTITLE = "chart.longitudinal.section.subtitle"; felix@1701: raimund@2159: /** raimund@2159: * Key to look up internationalized String for LongitudinalSection diagrams raimund@2159: * short subtitles. raimund@2159: */ gernotbelger@9312: public static final String I18N_CHART_SHORT_SUBTITLE = "chart.longitudinal.section.shortsubtitle"; felix@1701: gernotbelger@9312: public static final String I18N_XAXIS_LABEL = "chart.longitudinal.section.xaxis.label"; felix@1701: gernotbelger@9312: public static final String I18N_YAXIS_LABEL = "chart.longitudinal.section.yaxis.label"; felix@1701: gernotbelger@9312: public static final String I18N_2YAXIS_LABEL = "common.export.csv.header.q"; gernotbelger@9312: gernotbelger@9312: public static final String I18N_CHART_TITLE_DEFAULT = "W-L\u00e4ngsschnitt"; gernotbelger@9312: public static final String I18N_XAXIS_LABEL_DEFAULT = "km"; gernotbelger@9312: public static final String I18N_YAXIS_LABEL_DEFAULT = "W [NN + m]"; felix@1701: public static final String I18N_2YAXIS_LABEL_DEFAULT = "Q [m\u00b3/s]"; felix@1701: gernotbelger@9312: public final static String I18N_WDIFF_YAXIS_LABEL = "chart.w_differences.yaxis.label"; felix@1953: felix@1953: public final static String I18N_WDIFF_YAXIS_LABEL_DEFAULT = "m"; felix@1953: ingo@359: public LongitudinalSectionGenerator() { ingo@359: super(); ingo@369: } ingo@369: ingo@2000: @Override ingo@2000: protected YAxisWalker getYAxisWalker() { ingo@2000: return new YAxisWalker() { ingo@2000: @Override ingo@2000: public int length() { ingo@2000: return YAXIS.values().length; ingo@2000: } ingo@2000: ingo@2000: @Override gernotbelger@9312: public String getId(final int idx) { gernotbelger@9312: final YAXIS[] yaxes = YAXIS.values(); ingo@2000: return yaxes[idx].toString(); ingo@2000: } ingo@2000: }; ingo@2000: } ingo@2000: felix@3621: /** felix@3621: * Return left most data points x value (on first axis). felix@3621: * Overridden because axis could be inverted. felix@3621: */ felix@3621: @Override felix@3621: protected double getLeftX() { felix@3621: if (isInverted()) { gernotbelger@9312: return (Double) getXBounds(0).getUpper(); felix@3621: } gernotbelger@9312: return (Double) getXBounds(0).getLower(); felix@3621: } felix@3621: felix@3621: /** felix@3621: * Return right most data points x value (on first axis). felix@3621: * Overridden because axis could be inverted. felix@3621: */ felix@3621: @Override felix@3621: protected double getRightX() { felix@3621: if (isInverted()) { gernotbelger@9312: return (Double) getXBounds(0).getLower(); felix@3621: } gernotbelger@9312: return (Double) getXBounds(0).getUpper(); felix@3621: } felix@3621: felix@1700: /** ingo@2048: * Returns the default title for this chart. ingo@2047: * ingo@2048: * @return the default title for this chart. felix@1700: */ ingo@2047: @Override gernotbelger@9123: public String getDefaultChartTitle(final CallContext context) { felix@1701: return msg(I18N_CHART_TITLE, I18N_CHART_TITLE_DEFAULT); felix@1700: } felix@1700: ingo@2047: /** ingo@2048: * Returns the default subtitle for this chart. ingo@2047: * ingo@2048: * @return the default subtitle for this chart. ingo@2047: */ ingo@1989: @Override gernotbelger@9123: protected String getDefaultChartSubtitle(final CallContext context) { gernotbelger@9312: final double[] dist = getRange(); ingo@1989: raimund@2154: Object[] args = null; raimund@2154: if (dist == null) { gernotbelger@9312: args = new Object[] { getRiverName() }; raimund@2159: return msg(getChartShortSubtitleKey(), "", args); raimund@2154: } gernotbelger@9312: args = new Object[] { getRiverName(), dist[0], dist[1] }; ingo@1989: return msg(getChartSubtitleKey(), "", args); ingo@1989: } ingo@1989: felix@1700: /** felix@1700: * Gets key to look up internationalized String for the charts subtitle. gernotbelger@9556: * felix@1700: * @return key to look up translated subtitle. felix@1700: */ felix@1700: protected String getChartSubtitleKey() { felix@1701: return I18N_CHART_SUBTITLE; felix@1700: } felix@1700: felix@1700: /** sascha@3076: * Gets key to look up internationalized String for the charts short raimund@2159: * subtitle. gernotbelger@9556: * raimund@2159: * @return key to look up translated subtitle. raimund@2159: */ raimund@2159: protected String getChartShortSubtitleKey() { raimund@2159: return I18N_CHART_SHORT_SUBTITLE; raimund@2159: } raimund@2159: raimund@2159: /** felix@1700: * Get internationalized label for the x axis. felix@1700: */ ingo@2051: @Override gernotbelger@9312: protected String getDefaultXAxisLabel(final CallContext context) { gernotbelger@9312: final D4EArtifact flys = getArtifact(); ingo@1667: gernotbelger@9312: return msg(I18N_XAXIS_LABEL, I18N_XAXIS_LABEL_DEFAULT, new Object[] { RiverUtils.getRiver(flys).getName() }); ingo@369: } ingo@369: felix@1953: @Override gernotbelger@9312: protected String getDefaultYAxisLabel(final int index) { ingo@2051: String label = "default"; ingo@2051: ingo@2051: if (index == YAXIS.W.idx) { ingo@2051: label = getWAxisLabel(); gernotbelger@9312: } else if (index == YAXIS.Q.idx) { ingo@2051: label = msg(getQAxisLabelKey(), getQAxisDefaultLabel()); gernotbelger@9312: } else if (index == YAXIS.D.idx) { gernotbelger@9312: label = msg(I18N_WDIFF_YAXIS_LABEL, I18N_WDIFF_YAXIS_LABEL_DEFAULT); ingo@2051: } ingo@2051: ingo@2051: return label; felix@1953: } felix@1953: felix@1700: /** felix@1700: * Get internationalized label for the y axis. felix@1700: */ felix@1953: protected String getWAxisLabel() { gernotbelger@9312: final D4EArtifact flys = getArtifact(); ingo@1667: gernotbelger@9312: final String unit = RiverUtils.getRiver(flys).getWstUnit().getName(); gernotbelger@9312: gernotbelger@9312: return msg(I18N_YAXIS_LABEL, I18N_YAXIS_LABEL_DEFAULT, new Object[] { unit }); ingo@369: } ingo@369: felix@1700: /** felix@1931: * Create Axis for given index. gernotbelger@9556: * felix@1931: * @return axis with according internationalized label. felix@1931: */ felix@1931: @Override gernotbelger@9312: protected NumberAxis createYAxis(final int index) { gernotbelger@9312: final NumberAxis axis = super.createYAxis(index); ingo@1991: felix@1941: // "Q" Axis shall include 0. felix@1941: if (index == YAXIS.Q.idx) { felix@1941: axis.setAutoRangeIncludesZero(true); gernotbelger@9312: } else { felix@1941: axis.setAutoRangeIncludesZero(false); felix@1941: } ingo@2053: felix@1931: return axis; felix@1931: } felix@1931: felix@1931: /** felix@1700: * Get default value for the second Y-Axis' label (if no translation was felix@1700: * found). felix@1700: */ felix@1953: protected String getQAxisDefaultLabel() { felix@1701: return I18N_2YAXIS_LABEL_DEFAULT; felix@1700: } felix@1700: felix@1700: /** felix@1700: * Get key for internationalization of the second Y-Axis' label. felix@1700: */ felix@1953: protected String getQAxisLabelKey() { felix@1701: return I18N_2YAXIS_LABEL; felix@1700: } felix@1700: felix@1700: /** felix@1931: * Trigger inversion. felix@1700: */ felix@1700: @Override gernotbelger@9312: protected void adjustAxes(final XYPlot plot) { ingo@375: super.adjustAxes(plot); ingo@422: invertXAxis(plot.getDomainAxis()); ingo@422: } ingo@422: ingo@422: /** ingo@422: * This method inverts the x-axis based on the kilometer information of the ingo@422: * selected river. If the head of the river is at kilometer 0, the axis is ingo@422: * not inverted, otherwise it is. ingo@422: * gernotbelger@9312: * @param xaxis gernotbelger@9312: * The domain axis. ingo@422: */ gernotbelger@9312: protected void invertXAxis(final ValueAxis xaxis) { bjoern@4445: if (isInverted()) { teichmann@8202: log.debug("X-Axis.setInverted(true)"); ingo@422: xaxis.setInverted(true); ingo@422: } ingo@359: } ingo@359: felix@1769: /** felix@1769: * Produce output. gernotbelger@9556: * gernotbelger@9312: * @param artifactAndFacet gernotbelger@9312: * current facet and artifact. gernotbelger@9312: * @param attr gernotbelger@9312: * theme for facet felix@1769: */ christian@3409: @Override gernotbelger@9312: public void doOut(final ArtifactAndFacet artifactAndFacet, final ThemeDocument attr, final boolean visible) { gernotbelger@9312: final String name = artifactAndFacet.getFacetName(); ingo@359: teichmann@8202: log.debug("LongitudinalSectionGenerator.doOut: " + name); ingo@695: ingo@695: if (name == null) { teichmann@8202: log.error("No facet name for doOut(). No output generated!"); ingo@369: return; ingo@369: } ingo@369: gernotbelger@9312: final Facet facet = artifactAndFacet.getFacet(); ingo@696: felix@1944: if (facet == null) { ingo@696: return; ingo@369: } ingo@696: gernotbelger@9312: final CallContext context = getContext(); gernotbelger@9312: gernotbelger@9312: final Processor wProcessor = new WOutProcessor(); gernotbelger@9312: final Processor qProcessor = new QOutProcessor(); gernotbelger@9312: final Processor bdyProcessor = new BedDiffYearProcessor(); gernotbelger@9312: final Processor bdhyProcessor = new BedDiffHeightYearProcessor(); gernotbelger@9312: final Processor annotationProcessor = new AnnotationProcessor(); felix@6689: felix@6689: if (wProcessor.canHandle(name)) { gernotbelger@9312: wProcessor.doOut(this, artifactAndFacet, attr, visible, YAXIS.W.idx); ingo@696: } felix@6927: if (qProcessor.canHandle(name)) { gernotbelger@9312: qProcessor.doOut(this, artifactAndFacet, attr, visible, YAXIS.Q.idx); gernotbelger@9312: } else if (bdyProcessor.canHandle(name)) { gernotbelger@9312: bdyProcessor.doOut(this, artifactAndFacet, attr, visible, YAXIS.W.idx); gernotbelger@9312: } else if (bdhyProcessor.canHandle(name)) { gernotbelger@9312: bdhyProcessor.doOut(this, artifactAndFacet, attr, visible, YAXIS.W.idx); gernotbelger@9312: } else if (annotationProcessor.canHandle(name)) { gernotbelger@9312: annotationProcessor.doOut(this, artifactAndFacet, attr, visible, 0); gernotbelger@9312: } else if (name.equals(W_DIFFERENCES)) { gernotbelger@9312: doWDifferencesOut((WKms) artifactAndFacet.getData(context), artifactAndFacet, attr, visible); gernotbelger@9312: } else if (FacetTypes.IS.AREA(name)) { gernotbelger@9312: doArea(artifactAndFacet.getData(context), artifactAndFacet, attr, visible); gernotbelger@9312: } else if (FacetTypes.IS.MANUALPOINTS(name)) { gernotbelger@9312: doPoints(artifactAndFacet.getData(context), artifactAndFacet, attr, visible, YAXIS.W.idx); gernotbelger@9312: } else { teichmann@8202: log.warn("Unknown facet name: " + name); ingo@369: return; ingo@369: } ingo@369: } ingo@369: felix@1769: /** felix@1769: * Add items to dataseries which describes the differences. felix@1769: */ gernotbelger@9312: protected void doWDifferencesOut(final WKms wkms, final ArtifactAndFacet aandf, final ThemeDocument theme, final boolean visible) { teichmann@8202: log.debug("WDifferencesCurveGenerator.doWDifferencesOut"); felix@1769: if (wkms == null) { teichmann@8202: log.warn("No data to add to WDifferencesChart."); felix@1769: return; gernotbelger@9312: } felix@1769: gernotbelger@9556: final XYSeries series = new StyledXYSeries(aandf.getFacetName(), aandf.getFacetDescription(), theme); felix@1769: teichmann@8202: if (log.isDebugEnabled()) { felix@1769: if (wkms.size() > 0) { teichmann@8202: log.debug("Generate series: " + series.getKey()); teichmann@8202: log.debug("Start km: " + wkms.getKm(0)); teichmann@8202: log.debug("End km: " + wkms.getKm(wkms.size() - 1)); teichmann@8202: log.debug("Values : " + wkms.size()); felix@1769: } felix@1769: } felix@1769: felix@1791: StyledSeriesBuilder.addPoints(series, wkms); felix@1769: felix@1931: addAxisSeries(series, YAXIS.D.idx, visible); ingo@369: } ingo@369: ingo@369: /** felix@1041: * Get name of series (displayed in legend). gernotbelger@9556: * felix@1041: * @return name of the series. felix@1041: */ gernotbelger@9312: protected String getSeriesName(final WQKms wqkms, final String mode) { gernotbelger@9312: final String name = wqkms.getName(); gernotbelger@9312: final String prefix = name != null && name.indexOf(mode) >= 0 ? null : mode; ingo@448: gernotbelger@9312: return prefix != null && prefix.length() > 0 ? prefix + "(" + name + ")" : name; ingo@359: } felix@2029: felix@2104: /** Look up the axis identifier for a given facet type. */ gernotbelger@9312: public int axisIdxForFacet(final String facetName) { felix@2104: if (FacetTypes.IS.W(facetName)) { felix@2104: return YAXIS.W.idx; gernotbelger@9312: } else if (FacetTypes.IS.Q(facetName)) { felix@2104: return YAXIS.Q.idx; gernotbelger@9312: } else { teichmann@8202: log.warn("Could not find axis for facet " + facetName); felix@2104: return YAXIS.W.idx; felix@2104: } felix@2104: } felix@2104: felix@2029: /** felix@2029: * Do Area out. gernotbelger@9556: * gernotbelger@9312: * @param theme gernotbelger@9312: * styling information. gernotbelger@9312: * @param visible gernotbelger@9312: * whether or not visible. felix@2029: */ gernotbelger@9312: protected void doArea(final Object o, final ArtifactAndFacet aandf, final ThemeDocument theme, final boolean visible) { teichmann@8202: log.debug("LongitudinalSectionGenerator.doArea"); gernotbelger@9556: gernotbelger@9556: final String facetName = aandf.getFacetName(); gernotbelger@9556: gernotbelger@9556: final StyledAreaSeriesCollection area = new StyledAreaSeriesCollection(facetName, theme); felix@2029: gernotbelger@9312: final String seriesName = aandf.getFacetDescription(); ingo@2325: gernotbelger@9312: final AreaFacet.Data data = (AreaFacet.Data) o; felix@2104: gernotbelger@9312: XYSeries up = null; felix@2029: XYSeries down = null; felix@2029: felix@2104: if (data.getUpperData() != null) { gernotbelger@9556: up = new StyledXYSeries(facetName, seriesName, false, theme); felix@2104: if (data.getUpperData() instanceof WQKms) { aheinecke@7718: if (FacetTypes.IS.Q(data.getUpperFacetName())) { gernotbelger@9312: StyledSeriesBuilder.addPointsKmQ(up, (WQKms) data.getUpperData()); gernotbelger@9312: } else { gernotbelger@9312: StyledSeriesBuilder.addPoints(up, (WKms) data.getUpperData()); felix@2104: } gernotbelger@9312: } else if (data.getUpperData() instanceof double[][]) { gernotbelger@9312: StyledSeriesBuilder.addPoints(up, (double[][]) data.getUpperData(), false); gernotbelger@9312: } else if (data.getUpperData() instanceof WKms) { felix@2567: StyledSeriesBuilder.addPoints(up, (WKms) data.getUpperData()); gernotbelger@9312: } else if (data.getUpperData() instanceof Lines.LineData) { gernotbelger@9312: StyledSeriesBuilder.addPoints(up, ((Lines.LineData) data.getUpperData()).points, false); gernotbelger@9312: } else { gernotbelger@9312: log.error("Do not know how to deal with (up) area info from: " + data.getUpperData()); felix@2029: } felix@2029: } felix@2029: tom@8856: // TODO Depending on style, the area (e.g. 20m^2) tom@8856: // should be added as annotation. felix@2420: felix@2104: if (data.getLowerData() != null) { felix@2029: // TODO: Sort this out: when the two series have the same name, felix@2029: // the renderer (or anything in between) will not work correctly. gernotbelger@9556: down = new StyledXYSeries(facetName, seriesName + " ", false, theme); felix@2104: if (data.getLowerData() instanceof WQKms) { aheinecke@7718: if (FacetTypes.IS.Q(data.getLowerFacetName())) { gernotbelger@9312: StyledSeriesBuilder.addPointsKmQ(down, (WQKms) data.getLowerData()); gernotbelger@9312: } else { gernotbelger@9312: StyledSeriesBuilder.addPoints(down, (WQKms) data.getLowerData()); felix@2104: } gernotbelger@9312: } else if (data.getLowerData() instanceof double[][]) { gernotbelger@9312: StyledSeriesBuilder.addPoints(down, (double[][]) data.getLowerData(), false); gernotbelger@9312: } else if (data.getLowerData() instanceof WKms) { gernotbelger@9312: StyledSeriesBuilder.addPoints(down, (WKms) data.getLowerData()); gernotbelger@9312: } else if (data.getLowerData() instanceof Lines.LineData) { gernotbelger@9312: StyledSeriesBuilder.addPoints(down, ((Lines.LineData) data.getLowerData()).points, false); gernotbelger@9312: } else { gernotbelger@9312: log.error("Do not know how to deal with (down) area info from: " + data.getLowerData()); felix@2029: } felix@2029: } felix@2029: felix@2029: if (up == null && down != null) { felix@2029: area.setMode(StyledAreaSeriesCollection.FILL_MODE.ABOVE); felix@2029: down.setKey(seriesName); felix@2029: area.addSeries(down); felix@2601: area.addSeries(StyledSeriesBuilder.createGroundAtInfinity(down)); gernotbelger@9312: } else if (up != null && down == null) { felix@2029: area.setMode(StyledAreaSeriesCollection.FILL_MODE.UNDER); felix@2029: area.addSeries(up); felix@2601: area.addSeries(StyledSeriesBuilder.createGroundAtInfinity(up)); gernotbelger@9312: } else if (up != null && down != null) { felix@2104: if (data.doPaintBetween()) { felix@2104: area.setMode(StyledAreaSeriesCollection.FILL_MODE.BETWEEN); gernotbelger@9312: } else { felix@2104: area.setMode(StyledAreaSeriesCollection.FILL_MODE.ABOVE); felix@2104: } felix@2029: area.addSeries(up); felix@2029: area.addSeries(down); felix@2029: } felix@2104: // Add area to the respective axis. gernotbelger@9312: final String facetAxisName = data.getUpperFacetName() == null ? data.getLowerFacetName() : data.getUpperFacetName(); aheinecke@7718: addAreaSeries(area, axisIdxForFacet(facetAxisName), visible); felix@2029: } ingo@359: } ingo@359: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :