felix@6878: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
felix@6878:  * Software engineering by Intevation GmbH
felix@6878:  *
felix@6878:  * This file is Free Software under the GNU AGPL (>=v3)
felix@6878:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
felix@6878:  * documentation coming with Dive4Elements River for details.
felix@6878:  */
felix@6878: 
felix@6878: package org.dive4elements.river.exports.process;
felix@6878: 
rrenkert@8354: import java.util.Map;
rrenkert@8354: 
felix@6878: import org.apache.log4j.Logger;
felix@6878: 
felix@6878: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
felix@6878: import org.dive4elements.artifacts.CallContext;
rrenkert@8354: import org.dive4elements.artifacts.CallMeta;
rrenkert@8182: import org.dive4elements.river.artifacts.D4EArtifact;
rrenkert@8182: import org.dive4elements.river.artifacts.access.RiverAccess;
felix@6878: import org.dive4elements.river.artifacts.model.FacetTypes;
felix@6878: import org.dive4elements.river.artifacts.model.WQKms;
rrenkert@8354: import org.dive4elements.river.artifacts.resources.Resources;
rrenkert@8182: import org.dive4elements.river.exports.DiagramGenerator;
rrenkert@8182: import org.dive4elements.river.exports.StyledSeriesBuilder;
felix@6878: import org.dive4elements.river.jfree.StyledXYSeries;
rrenkert@8182: import org.dive4elements.river.model.Gauge;
rrenkert@8182: import org.dive4elements.river.model.River;
teichmann@6905: import org.dive4elements.river.themes.ThemeDocument;
felix@6880: 
felix@6878: 
felix@6878: /** Helper for data handling in discharge diagrams. */
felix@6878: public class DischargeProcessor
aheinecke@7059: extends DefaultProcessor implements FacetTypes {
felix@6878: 
teichmann@8202:     private final static Logger log =
felix@6878:             Logger.getLogger(DischargeProcessor.class);
felix@6878: 
felix@6880:     /** Station for which the diagram is shown. */
felix@6880:     private double km;
felix@6880: 
felix@6880:     /** Tolerance for comparison of kilometers. */
felix@6880:     public static final double KM_EPSILON = 0.001d;
felix@6880: 
rrenkert@8354:     private String yAxisLabel = "";
rrenkert@8354: 
rrenkert@8354:     private String I18N_AXIS_LABEL = "chart.discharge.curve.yaxis.label";
rrenkert@8354: 
felix@6880: 
felix@6880:     /** This processor needs to be constructed with a given km. */
rrenkert@8182:     public DischargeProcessor() {
felix@6880:         km = Double.NaN;
felix@6880:     }
felix@6880: 
felix@6880: 
felix@6880:     public DischargeProcessor(double km) {
felix@6880:         this.km = km;
felix@6880:     }
felix@6880: 
felix@6878: 
felix@6878:     /** Process data, add it to plot. */
felix@6878:     @Override
felix@6878:     public void doOut(
rrenkert@8182:             DiagramGenerator generator,
aheinecke@7075:             ArtifactAndFacet bundle,
teichmann@6905:             ThemeDocument theme,
rrenkert@8182:             boolean visible
felix@6878:     ) {
felix@6878:         CallContext context = generator.getCallContext();
aheinecke@7075:         Object data = bundle.getData(context);
felix@7585:         if (data instanceof WQKms) {
rrenkert@8182:             doDischargeOut(
rrenkert@8182:                 generator,
rrenkert@8182:                 bundle,
tom@8390:                 bundle.getFacetDescription().trim(),
rrenkert@8182:                 theme,
rrenkert@8182:                 visible);
felix@6922:         }
felix@6922:         else {
teichmann@8202:             log.error("Can't process "
felix@6922:                 + data.getClass().getName() + " objects of facet "
aheinecke@7075:                 + bundle.getFacetName());
felix@6922:         }
felix@6878:     }
felix@6878: 
felix@6878:     /** True if this processor knows how to deal with facetType. */
felix@6878:     @Override
felix@6878:     public boolean canHandle(String facetType) {
rrenkert@8182:         return DISCHARGE_CURVE.equals(facetType)
rrenkert@8182:             || GAUGE_DISCHARGE_CURVE.equals(facetType);
felix@6878:     }
felix@6878: 
felix@6878: 
felix@6897:     /** The station of the current calculation/view. */
felix@6897:     protected double getKm() {
felix@6897:         return km;
felix@6897:     }
felix@6897: 
rrenkert@8182:     /**
rrenkert@8182:      * Add series with discharge curve to diagram.
rrenkert@8182:      */
rrenkert@8182:     protected void doDischargeOut(
rrenkert@8182:         DiagramGenerator generator,
aheinecke@7075:         ArtifactAndFacet bundle,
rrenkert@8182:         String        name,
teichmann@6905:         ThemeDocument theme,
rrenkert@8182:         boolean       visible)
rrenkert@8182:     {
teichmann@8202:         log.debug("DischargeCurveGenerator.doDischargeOut");
rrenkert@8182:         CallContext context = generator.getCallContext();
rrenkert@8354:         Map<String, String> metaData = bundle.getFacet().getMetaData(
rrenkert@8354:             bundle.getArtifact(), context);
rrenkert@8182:         WQKms data = (WQKms)bundle.getData(context);
teichmann@8421:         Double skm = data.sameKm();
teichmann@8421:         if (skm != null && Math.abs(skm-km) > 0.00001) {
teichmann@8421:             return;
teichmann@8421:         }
rrenkert@8354:         StyledXYSeries series = new StyledXYSeries(name, theme);
rrenkert@8182:         double[][] wqData = new double[2][data.size()];
teichmann@8421:         for (int i = 0, n = data.size(); i < n; i++) {
rrenkert@8182:             wqData[0][i] = data.getQ(i);
rrenkert@8182:             wqData[1][i] = data.getW(i);
felix@6880:         }
rrenkert@8182:         StyledSeriesBuilder.addPoints(series, wqData, false);
felix@6897: 
rrenkert@8354:         series.putMetaData(metaData, bundle.getArtifact(), context);
rrenkert@8354:         yAxisLabel = metaData.get("Y");
rrenkert@8354: 
rrenkert@8182:         String gaugeName = data.getName();
rrenkert@8182:         RiverAccess access = new RiverAccess((D4EArtifact)bundle.getArtifact());
rrenkert@8182:         River river = access.getRiver();
felix@6922: 
rrenkert@8182:         if (river == null) {
teichmann@8202:             log.debug("no river found");
felix@6922:             return;
felix@6922:         }
felix@6922: 
rrenkert@8182:         Gauge gauge = river.determineGaugeByName(gaugeName);
felix@6922: 
rrenkert@8182:         if (gauge == null) {
teichmann@8202:             log.debug("no gauge found");
rrenkert@8182:             return;
felix@6922:         }
rrenkert@8182:         generator.addAxisSeries(series, axisName, visible);
felix@6922:     }
rrenkert@8354: 
rrenkert@8354:     @Override
rrenkert@8354:     public String getAxisLabel(DiagramGenerator generator) {
rrenkert@8354:         CallMeta meta = generator.getCallContext().getMeta();
rrenkert@8354:         RiverAccess access = new RiverAccess((D4EArtifact)generator.getMaster());
rrenkert@8354:         String unit = access.getRiver().getWstUnit().getName();
rrenkert@8354: 
rrenkert@8354:         if (yAxisLabel != null && !yAxisLabel.isEmpty()) {
rrenkert@8354:             return Resources.getMsg(
rrenkert@8354:                 meta,
rrenkert@8354:                 yAxisLabel,
rrenkert@8354:                 new Object[] { unit });
rrenkert@8354:         }
rrenkert@8354:         return Resources.getMsg(
rrenkert@8354:                 meta,
rrenkert@8354:                 I18N_AXIS_LABEL,
rrenkert@8354:                 new Object[] { unit });
rrenkert@8354:     }
felix@6878: }
felix@6878: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :