view flys-artifacts/src/main/java/de/intevation/flys/exports/minfo/SedimentLoadLSGenerator.java @ 5645:696d710470f5

flys/issue1077: Show loads as step line, therefore transform data in SedimentLoadFacet to stretch as in the measurement stations bounds. Deal with this new kind of data in the Generator.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Wed, 10 Apr 2013 09:35:07 +0200
parents ca4b6263996c
children 04687db03218
line wrap: on
line source
package de.intevation.flys.exports.minfo;

import java.util.Arrays;

import org.apache.log4j.Logger;
import org.jfree.data.xy.XYSeries;
import org.w3c.dom.Document;

import de.intevation.artifactdatabase.state.ArtifactAndFacet;
import de.intevation.artifactdatabase.state.Facet;
import de.intevation.flys.artifacts.FLYSArtifact;
import de.intevation.flys.artifacts.access.RangeAccess;
import de.intevation.flys.artifacts.access.RiverAccess;
import de.intevation.flys.artifacts.access.SedimentLoadAccess;
import de.intevation.flys.artifacts.model.FacetTypes;
import de.intevation.flys.artifacts.model.FlowVelocityData;
import de.intevation.flys.artifacts.model.WKms;
import de.intevation.flys.artifacts.model.minfo.BedDiffEpochResult;
import de.intevation.flys.artifacts.model.minfo.BedDiffYearResult;
import de.intevation.flys.artifacts.model.minfo.SedimentLoadResult;
import de.intevation.flys.exports.StyledSeriesBuilder;
import de.intevation.flys.exports.XYChartGenerator;
import de.intevation.flys.jfree.Bounds;
import de.intevation.flys.jfree.DoubleBounds;
import de.intevation.flys.jfree.FLYSAnnotation;
import de.intevation.flys.jfree.StyledXYSeries;
import de.intevation.flys.utils.DataUtil;


public class SedimentLoadLSGenerator
extends XYChartGenerator
implements FacetTypes
{
    public enum YAXIS {
        L(0),
        D(1),
        DW(2),
        V(3);

        protected int idx;

        private YAXIS(int c) {
            idx = c;
        }
    }
    /** The logger that is used in this generator. */
    private static Logger logger = Logger.getLogger(SedimentLoadLSGenerator.class);

    public static final String I18N_CHART_TITLE = "chart.sedimentload.ls.title";
    public static final String I18N_XAXIS_LABEL = "chart.sedimentload.ls.xaxis.label";
    public static final String I18N_YAXIS_LABEL_1 = "chart.sedimentload.ls.yaxis.label.tpera";
    public static final String I18N_YAXIS_LABEL_2 = "chart.sedimentload.ls.yaxis.label.m3pera";
    public static final String I18N_YAXIS_D_LABEL = "chart.beddifference.yaxis.label.diff";
    public static final String I18N_YAXIS_V_LABEL =
        "chart.flow_velocity.section.yaxis.label";
    public final static String I18N_WDIFF_YAXIS_LABEL =
        "chart.w_differences.yaxis.label";

    public final static String I18N_WDIFF_YAXIS_LABEL_DEFAULT = "m";
    public static final String I18N_CHART_TITLE_DEFAULT = "Sedimentfracht";
    public static final String I18N_XAXIS_LABEL_DEFAULT = "Fluss-Km";
    public static final String I18N_YAXIS_LABEL_DEFAULT_1 = "[t/a]";
    public static final String I18N_YAXIS_LABEL_DEFAULT_2 = "[m\u00b3/a]";
    public static final String I18N_YAXIS_D_LABEL_DEFAULT = "delta S [m]";
    public static final String I18N_YAXIS_V_LABEL_DEFAULT = "Geschwindigkeit v [m/s]";

    private FLYSArtifact artifact;

    @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();
            }
        };
    }

    @Override
    public void doOut(ArtifactAndFacet bundle, Document attr, boolean visible) {
        String name = bundle.getFacetName();

        logger.debug("doOut: " + name);

        if (name == null) {
            logger.error("No facet name for doOut(). No output generated!");
            return;
        }

        Facet facet = bundle.getFacet();
        artifact = (FLYSArtifact)bundle.getArtifact();

        if (facet == null) {
            return;
        }
        if (getXBounds(0) != null && getDomainAxisRange() != null) {
            logger.debug(Arrays.toString(getDomainAxisRangeFromRequest()));
            Bounds bounds =
                calculateZoom(getXBounds(0), getDomainAxisRange());
            context.putContextValue("startkm", bounds.getLower());
            context.putContextValue("endkm", bounds.getUpper());
        }
        else if (getXBounds(0) != null && getDomainAxisRange() == null) {
            context.putContextValue("startkm", getXBounds(0).getLower());
            context.putContextValue("endkm", getXBounds(0).getUpper());
        }
        else if (getXBounds(0) == null && getDomainAxisRange() == null) {
            FLYSArtifact artifact = (FLYSArtifact)bundle.getArtifact();
            RangeAccess access = new RangeAccess(artifact, context);
            context.putContextValue("startkm", access.getFrom());
            context.putContextValue("endkm", access.getTo());
        }
        else if (getXBounds(0) == null && getDomainAxisRange() != null){
            FLYSArtifact artifact = (FLYSArtifact)bundle.getArtifact();
            RangeAccess access = new RangeAccess(artifact, context);
            Bounds b = new DoubleBounds(access.getFrom(), access.getTo());
            Bounds bounds =
                calculateZoom(b, getDomainAxisRange());
            context.putContextValue("startkm", bounds.getLower());
            context.putContextValue("endkm", bounds.getUpper());
        }
        if (name.equals(SEDIMENT_LOAD_COARSE)) {
            doSedimentLoadCoarseOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_SAND)) {
            doSedimentLoadSandOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_FINEMIDDLE)) {
            doSedimentLoadFineMiddleOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_SUSP_SAND)) {
            doSedimentLoadSuspSandOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_SUSP_SAND_BED)) {
            doSedimentLoadSuspSandBedOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_SUSP_SEDIMENT)) {
            doSedimentLoadSuspSedimentOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_TOTAL_LOAD)) {
            doSedimentLoadTotalLoadOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(SEDIMENT_LOAD_TOTAL)) {
            doSedimentLoadTotalOut(
                (double[][]) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(FLOW_VELOCITY_TOTALCHANNEL)) {
            doFlowVelocityTotalOut(
                (FlowVelocityData) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(FLOW_VELOCITY_TOTALCHANNEL_FILTERED)) {
            doFlowVelocityTotalOut(
                (FlowVelocityData) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(FLOW_VELOCITY_MAINCHANNEL)) {
            doFlowVelocityMainOut(
                (FlowVelocityData) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(FLOW_VELOCITY_MAINCHANNEL_FILTERED)) {
            doFlowVelocityMainOut(
                (FlowVelocityData) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(BED_DIFFERENCE_YEAR)) {
            doBedDifferenceYearOut(
                (BedDiffYearResult) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(BED_DIFFERENCE_YEAR_FILTERED)) {
            doBedDifferenceYearOut(
                (BedDiffYearResult) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(BED_DIFFERENCE_EPOCH)) {
            doBedDifferenceEpochOut(
                (BedDiffEpochResult) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(W_DIFFERENCES)) {
            doWDifferencesOut(
                (WKms) bundle.getData(context),
                bundle,
                attr,
                visible);
        }
        else if (name.equals(LONGITUDINAL_ANNOTATION)) {
            doAnnotations(
                (FLYSAnnotation) bundle.getData(context),
                 bundle,
                 attr,
                 visible);
        }
        else if (FacetTypes.IS.MANUALPOINTS(name)) {
            doPoints(
                bundle.getData(context),
                bundle,
                attr,
                visible,
                YAXIS.L.idx);
        }
    }

    @Override
    protected String getDefaultChartTitle() {
        return msg(I18N_CHART_TITLE, I18N_CHART_TITLE_DEFAULT);
    }

    @Override
    protected String getDefaultXAxisLabel() {
        return msg(I18N_XAXIS_LABEL, I18N_XAXIS_LABEL_DEFAULT);
    }

    @Override
    protected String getDefaultYAxisLabel(int pos) {
        String label = "default";
        if (pos == YAXIS.L.idx) {
            SedimentLoadAccess access = new SedimentLoadAccess(artifact, context);
            if (access.getUnit().equals("m3_per_a")) {
                label = msg(I18N_YAXIS_LABEL_2, I18N_YAXIS_LABEL_DEFAULT_2);
            }
            else {
                label = msg(I18N_YAXIS_LABEL_1, I18N_YAXIS_LABEL_DEFAULT_1);
            }
        }
        else if (pos == YAXIS.V.idx) {
            label = msg(I18N_YAXIS_V_LABEL, I18N_YAXIS_V_LABEL_DEFAULT);
        }
        else if (pos == YAXIS.D.idx) {
            label = msg(I18N_YAXIS_D_LABEL, I18N_YAXIS_D_LABEL_DEFAULT);
        }
        else if (pos == YAXIS.DW.idx) {
            label = msg(I18N_WDIFF_YAXIS_LABEL, I18N_WDIFF_YAXIS_LABEL_DEFAULT);
        }

        return label;
    }

    // TODO all double[][] eating *Out() can be subsumed.
    protected void doSedimentLoadCoarseOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadSandOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadFineMiddleOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadSuspSandOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadSuspSandBedOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadSuspSedimentOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadTotalLoadOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);
    }

    protected void doSedimentLoadTotalOut(double[][] data,
        ArtifactAndFacet aandf, Document theme, boolean visible) {

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data, true);

        addAxisSeries(series, YAXIS.L.idx, visible);

    protected void doFlowVelocityMainOut(
        FlowVelocityData data,
        ArtifactAndFacet aandf,
        Document         theme,
        boolean          visible
    ) {
        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data.getMainChannelPoints(), true);

        addAxisSeries(series, YAXIS.V.idx, visible);
    }

    protected void doFlowVelocityTotalOut(
        FlowVelocityData data,
        ArtifactAndFacet aandf,
        Document         theme,
        boolean          visible
    ) {
        if (data == null) {
            logger.warn("No data to add to FlowVelocity chart.");
            return;
         }

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data.getTotalChannelPoints(), true);

        addAxisSeries(series, YAXIS.V.idx, visible);
    }

    protected void doBedDifferenceYearOut(
        BedDiffYearResult data,
        ArtifactAndFacet aandf,
        Document theme,
        boolean visible
    ) {
        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data.getDifferencesData(), true);

        addAxisSeries(series, YAXIS.D.idx, visible);
    }

    protected void doBedDifferenceEpochOut(
        BedDiffEpochResult data,
        ArtifactAndFacet aandf,
        Document theme,
        boolean visible
    ) {
        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
        StyledSeriesBuilder.addPoints(series, data.getDifferencesData(), true);

        addAxisSeries(series, YAXIS.D.idx, visible);
    }

    protected void doWDifferencesOut(
        WKms       wkms,
        ArtifactAndFacet aandf,
        Document   theme,
        boolean    visible
    ) {
        if (wkms == null) {
            logger.warn("No data to add to WDifferencesChart.");
            return;
        }

        XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);

        StyledSeriesBuilder.addPoints(series, wkms);

        addAxisSeries(series, YAXIS.D.idx, visible);
        if (DataUtil.guessWaterIncreasing(wkms.allWs())) {
            setInverted(true);
        }
    }

}

http://dive4elements.wald.intevation.org