view artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/FloodDurationProcessor.java @ 9203:9831f6c60473

AbstractSInfoLineProcessor refactoring
author gernotbelger
date Mon, 02 Jul 2018 13:00:59 +0200
parents b4402594213b
children 3dae6b78e1da
line wrap: on
line source
/** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
 * Software engineering by
 *  Björnsen Beratende Ingenieure GmbH
 *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
 *
 * 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.sinfo.common;

import java.util.HashSet;
import java.util.Set;

import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
import org.dive4elements.artifactdatabase.state.Facet;
import org.dive4elements.artifacts.CallContext;
import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
import org.dive4elements.river.artifacts.resources.Resources;
import org.dive4elements.river.artifacts.sinfo.flood_duration.FloodDurationCalculationResult;
import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
import org.dive4elements.river.exports.DiagramGenerator;
import org.dive4elements.river.themes.ThemeDocument;

/**
 * Processor to generate the facet and data series of infrastructure flood durations
 *
 * @author Matthias Schäfer
 *
 */
public final class FloodDurationProcessor extends AbstractSInfoProcessor {

    public static final String FACET_FLOOD_DURATION = "sinfo_facet_flood_duration";

    public static final String FACET_FLOOD_DURATION_DESCRIPTION = "sinfo_facet_flood_duration.description";

    public static final String FACET_MAIN_VALUE_1_DURATION = "mainvalue.1.duration";

    public static final String FACET_MAIN_VALUE_2_DURATION = "mainvalue.2.duration";

    public static final String FACET_MAIN_VALUE_3_DURATION = "mainvalue.3.duration";

    public static final String FACET_MAIN_VALUE_DURATION_DESCRIPTION = "mainvalue.duration.description";

    private static final String I18N_AXIS_LABEL = "sinfo.chart.flood_duration.section.yaxis.label";

    private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();

    static {
        HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION);
        HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_1_DURATION);
        HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_2_DURATION);
        HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_3_DURATION);
    }

    public FloodDurationProcessor() {
        super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
    }

    // @Override TODO: REMOVE (has been replaced by doGetType
    // protected double[][] doGetPoints(final AbstractCalculationResult data, final String facetName) {
    //
    // if (FACET_FLOOD_DURATION.contentEquals(facetName))
    // return ((FloodDurationCalculationResult) data).fetchInfrastructurePoints(SInfoResultType.floodDuration);
    //
    // if (FACET_MAIN_VALUE_1_DURATION.contentEquals(facetName))
    // return ((FloodDurationCalculationResult) data).fetchMainValuePoints(SInfoResultType.mainValue1Duration);
    //
    // if (FACET_MAIN_VALUE_2_DURATION.contentEquals(facetName))
    // return ((FloodDurationCalculationResult) data).fetchMainValuePoints(SInfoResultType.mainValue2Duration);
    //
    // if (FACET_MAIN_VALUE_3_DURATION.contentEquals(facetName))
    // return ((FloodDurationCalculationResult) data).fetchMainValuePoints(SInfoResultType.mainValue3Duration);
    //
    // final String error = String.format("Unknown facet name: %s", facetName);
    // throw new UnsupportedOperationException(error);
    // }

    public static Facet createFloodDurationFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
            final int index) {

        return AbstractSInfoProcessor.createFacet(context, hash, id, result, index, I18N_AXIS_LABEL, FACET_FLOOD_DURATION, FACET_FLOOD_DURATION_DESCRIPTION);
    }

    private SInfoResultType doGetType(final String facetName) {

        if (FACET_FLOOD_DURATION.contentEquals(facetName))
            return SInfoResultType.floodDuration;

        if (FACET_MAIN_VALUE_1_DURATION.contentEquals(facetName))
            return SInfoResultType.mainValue1Duration;

        if (FACET_MAIN_VALUE_2_DURATION.contentEquals(facetName))
            return SInfoResultType.mainValue2Duration;

        if (FACET_MAIN_VALUE_3_DURATION.contentEquals(facetName))
            return SInfoResultType.mainValue3Duration;

        final String error = String.format("Unknown facet name: %s", facetName);
        throw new UnsupportedOperationException(error);

    }

    public static Facet createMainValueDurationFacet(final CallContext context, final String hash, final String id, final FloodDurationCalculationResult result,
            final int index) {

        final String description = Resources.getMsg(context.getMeta(), FACET_MAIN_VALUE_DURATION_DESCRIPTION, FACET_MAIN_VALUE_DURATION_DESCRIPTION,
                result.getMainValueLabel(index));
        assert ((index >= 0) && (index <= 2));
        final String facetName = new String[] { FACET_MAIN_VALUE_1_DURATION, FACET_MAIN_VALUE_2_DURATION, FACET_MAIN_VALUE_3_DURATION }[index];
        return new SInfoResultFacet(0, facetName, description, I18N_AXIS_LABEL, ComputeType.ADVANCE, id, hash);
    }

    @Override
    protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {

        return buildSeriesForType(generator, bundle, theme, visible, doGetType(bundle.getFacetName()), GAP_DISTANCE);
    }
}

http://dive4elements.wald.intevation.org