/* 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.model;

import java.util.ArrayList;
import java.util.List;

import org.apache.log4j.Logger;

import org.dive4elements.artifacts.Artifact;
import org.dive4elements.artifacts.CallContext;
import org.dive4elements.artifacts.DataProvider;

import org.dive4elements.artifactdatabase.state.DefaultFacet;

import org.dive4elements.river.artifacts.MainValuesArtifact;
import org.dive4elements.river.jfree.RiverAnnotation;
import org.dive4elements.river.jfree.StickyAxisAnnotation;

import org.dive4elements.river.exports.DurationCurveGenerator;
import org.dive4elements.river.exports.fixings.FixChartGenerator;


/**
 * Facet to show Main Q Values.
 * TODO Join with W implementation.
 */
public class MainValuesQFacet
extends      DefaultFacet
implements   FacetTypes {

    /** Own logger. */
    private static Logger logger = Logger.getLogger(MainValuesQFacet.class);

    /** Do we want MainValues at Gauge (not interpolated)? */
    protected boolean isAtGauge;


    /** Trivial Constructor. */
    public MainValuesQFacet(String name, String description, boolean atGauge) {
        this.description = description;
        this.name        = name;
        this.index       = 0;
        this.isAtGauge   = atGauge;
    }

    /**
     * Set the hit-point in Q where a line drawn from the axis would hit the
     * curve in WQDay (if hit).
     * Employ linear interpolation.
     */
    protected static void setHitPoint(WQDay wqday, StickyAxisAnnotation annotation) {

        float q = annotation.getPos();
        Double day = wqday.interpolateDayByQ(q);

        if (day != null) {
            annotation.setHitPoint(day.floatValue());
        }
        else if (logger.isDebugEnabled()) {
            logger.debug("StickyAnnotation does not hit wqday curve: " + q);
        }
    }


    /**
     * Returns the data this facet requires.
     *
     * @param artifact the owner artifact.
     * @param context  the CallContext (can be used to find out if in
     *                 navigable fixation-setting, or durationcurve).
     *
     * @return the data.
     */
    @Override
    public Object getData(Artifact artifact, CallContext context) {
        MainValuesArtifact mvArtifact = (MainValuesArtifact) artifact;

        List<NamedDouble>          qs = mvArtifact.getMainValuesQ(isAtGauge);
        List<StickyAxisAnnotation> xy = new ArrayList<StickyAxisAnnotation>();

        WQDay wqdays = null;
        List<DataProvider> providers = context.
            getDataProvider(DurationCurveFacet.BB_DURATIONCURVE);
        if (providers.size() < 1) {
            logger.warn("Could not find durationcurve data provider.");
            // Do we have a current km in context?
            // If so, we are likely fetching data for a navigable
            // diagram (i.e. in fixation branch).
            Object xkm = context.getContextValue(FixChartGenerator.CURRENT_KM);
            if (xkm != null) {
                Double ckm = (Double)xkm;
                // Return linearly interpolated values, in m if not at gauge,
                // in cm if at gauge.
                qs = mvArtifact.getMainValuesQ(new double[] {ckm});
            }
        }
        else {
            wqdays = (WQDay) providers.get(0).provideData(
                DurationCurveFacet.BB_DURATIONCURVE,
                null,
                context);
        }

        // Rather specific case, Q-Annotations at a maybe second yaxis.
        StickyAxisAnnotation annotation = null;
        if (this.name.equals(DURATION_MAINVALUES_Q)) {
            for (NamedDouble q: qs) {
                if (Double.isNaN(q.getValue())) {
                    logger.warn("NaN MainValue " + q.getName());
                    continue;
                }
                annotation =
                    new StickyAxisAnnotation(
                        q.getName(),
                        (float) q.getValue(),
                        StickyAxisAnnotation.SimpleAxis.Y_AXIS,
                        DurationCurveGenerator.YAXIS.Q.idx);
                xy.add(annotation);
                if (wqdays != null) {
                    setHitPoint(wqdays, annotation);
                }
            }
        }
        else {
            for (NamedDouble q: qs) {
                if (Double.isNaN(q.getValue())) {
                    logger.warn("NaN MainValue " + q.getName());
                    continue;
                }
                annotation =
                    new StickyAxisAnnotation(
                        q.getName(),
                        (float) q.getValue(),
                        StickyAxisAnnotation.SimpleAxis.X_AXIS);
                xy.add(annotation);
                if (wqdays != null) {
                    setHitPoint(wqdays, annotation);
                }
            }
        }

        return new RiverAnnotation(description, xy);
    }


    /**
     * Create a deep copy of this Facet.
     * @return a deep copy.
     */
    @Override
    public MainValuesQFacet deepCopy() {
        MainValuesQFacet copy = new MainValuesQFacet(this.name,
            description, this.isAtGauge);
        copy.set(this);
        return copy;
    }
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :