Mercurial > dive4elements > river
view artifacts/src/main/java/org/dive4elements/river/exports/DischargeCurveGenerator.java @ 6792:962f6b805b48 longitudinal-symmetry
merged changes from default into longitudinal-symmetrie branch
author | Tom Gottfried <tom@intevation.de> |
---|---|
date | Wed, 07 Aug 2013 18:57:29 +0200 |
parents | be8a5e1911ed |
children | a77dca301419 |
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.exports; import org.dive4elements.artifactdatabase.state.ArtifactAndFacet; import org.dive4elements.river.artifacts.D4EArtifact; import org.dive4elements.river.artifacts.model.FacetTypes; import org.dive4elements.river.artifacts.model.WQKms; import org.dive4elements.river.jfree.Bounds; import org.dive4elements.river.jfree.RiverAnnotation; import org.dive4elements.river.jfree.StickyAxisAnnotation; import org.dive4elements.river.jfree.StyledXYSeries; import org.dive4elements.river.model.Gauge; import org.dive4elements.river.model.River; import org.dive4elements.river.utils.RiverUtils; import org.apache.log4j.Logger; import org.jfree.chart.annotations.XYTextAnnotation; import org.jfree.chart.axis.ValueAxis; import org.jfree.chart.plot.XYPlot; import org.jfree.data.Range; import org.jfree.data.xy.XYSeries; import org.w3c.dom.Document; /** * An OutGenerator that generates discharge curves. * * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> */ public class DischargeCurveGenerator extends XYChartGenerator implements FacetTypes { public static enum YAXIS { WCm(0), W(1); protected int idx; private YAXIS(int c) { idx = c; } } /** The logger used in this generator. */ private static Logger logger = Logger.getLogger(DischargeCurveGenerator.class); public static final String I18N_CHART_TITLE = "chart.discharge.curve.title"; public static final String I18N_CHART_SUBTITLE = "chart.discharge.curve.subtitle"; public static final String I18N_XAXIS_LABEL = "chart.discharge.curve.xaxis.label"; public static final String I18N_YAXIS_LABEL = "chart.discharge.curve.yaxis.label"; public static final String I18N_CHART_TITLE_DEFAULT = "Abflusskurven"; public static final String I18N_XAXIS_LABEL_DEFAULT = "Q [m\u00b3/s]"; public static final String I18N_YAXIS_LABEL_DEFAULT = "W [cm]"; /** * Returns the PNP (Datum) of gauge, if at gauge, 0 otherwise. */ public static double getCurrentGaugeDatum(double km, D4EArtifact artifact, double tolerance) { // Look if there is a gauge at chosen km: // Get gauge which is defined for km Gauge gauge = RiverUtils.getRiver(artifact).determineGauge(km-0.1d, km+0.1d); double subtractPNP = 0d; // Compare to km. if (Math.abs(km - gauge.getStation().doubleValue()) < tolerance) { subtractPNP = gauge.getDatum().doubleValue(); } return subtractPNP; } public double getCurrentGaugeDatum() { return getCurrentGaugeDatum(getRange()[0], (D4EArtifact) getMaster(), 1e-4); } /** Overriden to show second axis also if no visible data present. */ @Override protected void adjustAxes(XYPlot plot) { super.adjustAxes(plot); if (getCurrentGaugeDatum() != 0d) { // Show the W[*m] axis even if there is no data. plot.setRangeAxis(1, createYAxis(YAXIS.W.idx)); } } public DischargeCurveGenerator() { super(); } @Override protected YAxisWalker getYAxisWalker() { return new YAxisWalker() { @Override public int length() { return YAXIS.values().length; } @Override public String getId(int idx) { YAXIS[] yaxes = YAXIS.values(); return yaxes[idx].toString(); } }; } /** * Returns always null to suppress subtitles. */ @Override protected String getDefaultChartTitle() { return null; } @Override protected String getDefaultXAxisLabel() { return msg(I18N_XAXIS_LABEL, I18N_XAXIS_LABEL_DEFAULT); } @Override protected String getDefaultYAxisLabel(int pos) { return msg(I18N_YAXIS_LABEL, I18N_YAXIS_LABEL_DEFAULT); } /* TODO is this one really needed? */ @Override protected boolean zoomX(XYPlot plot, ValueAxis axis, Bounds bounds, Range x) { boolean zoomin = super.zoom(plot, axis, bounds, x); if (!zoomin) { axis.setLowerBound(0d); } return zoomin; } /** Translate River annotations if a gauge. */ public void translateRiverAnnotation(RiverAnnotation riverAnnotation) { if (getCurrentGaugeDatum() == 0d) { return; } logger.debug("Translate some river annotation."); double translate = getCurrentGaugeDatum(); double factor = 100d; for (StickyAxisAnnotation annotation: riverAnnotation.getAxisTextAnnotations()){ if (!annotation.atX()) { annotation.setPos((annotation.getPos() - translate)*factor); } } for (XYTextAnnotation annotation: riverAnnotation.getTextAnnotations()) { annotation.setY((annotation.getY() - translate)*factor); } } @Override public void doOut( ArtifactAndFacet artifactFacet, Document theme, boolean visible ) { String name = artifactFacet.getFacetName(); logger.debug("DischargeCurveGenerator.doOut: " + name); if (name.equals(DISCHARGE_CURVE) || name.equals(GAUGE_DISCHARGE_CURVE)) { doDischargeOut( (D4EArtifact)artifactFacet.getArtifact(), artifactFacet.getData(context), artifactFacet.getFacetDescription(), theme, visible); } else if (name.equals(COMPUTED_DISCHARGE_MAINVALUES_Q) || name.equals(MAINVALUES_Q) || name.equals(COMPUTED_DISCHARGE_MAINVALUES_W) || name.equals(MAINVALUES_W)) { RiverAnnotation mainValues = (RiverAnnotation) artifactFacet.getData(context); translateRiverAnnotation(mainValues); doAnnotations( mainValues, artifactFacet, theme, visible); } else if (FacetTypes.IS.MANUALPOINTS(name)) { doPoints(artifactFacet.getData(context), artifactFacet, theme, visible, YAXIS.W.idx); } else { logger.warn("DischargeCurveGenerator.doOut: Unknown facet name: " + name); return; } } /** * Add series with discharge curve to diagram. */ protected void doDischargeOut( D4EArtifact artifact, Object o, String description, Document theme, boolean visible) { WQKms wqkms = (WQKms) o; String gaugeName = wqkms.getName(); River river = RiverUtils.getRiver(artifact); if (river == null) { logger.debug("no river found"); return; } Gauge gauge = river.determineGaugeByName(gaugeName); if (gauge == null) { logger.debug("no gauge found"); return; } XYSeries series = new StyledXYSeries(description, theme); StyledSeriesBuilder.addPointsQW(series, wqkms); addAxisSeries(series, YAXIS.W.idx, visible); } } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :