mschaefer@9252: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@9252:  * Software engineering by
mschaefer@9252:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@9252:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@9252:  *
mschaefer@9252:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@9252:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@9252:  * documentation coming with Dive4Elements River for details.
mschaefer@9252:  */
mschaefer@9252: 
mschaefer@9252: package org.dive4elements.river.artifacts.sinfo.flood_duration;
mschaefer@9252: 
mschaefer@9252: import java.util.HashSet;
mschaefer@9252: import java.util.Set;
mschaefer@9252: 
mschaefer@9252: import org.dive4elements.artifactdatabase.state.Facet;
mschaefer@9252: import org.dive4elements.artifacts.CallContext;
mschaefer@9252: import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
mschaefer@9259: import org.dive4elements.river.artifacts.model.FacetTypes;
d@9612: import org.dive4elements.river.artifacts.resources.Resources;
d@9612: import org.dive4elements.river.artifacts.sinfo.flood_duration.FloodDurationCalculationResult.Infrastructure;
mschaefer@9252: import org.dive4elements.river.exports.DiagramGenerator;
mschaefer@9252: import org.dive4elements.river.exports.DurationCurveGenerator;
mschaefer@9252: import org.dive4elements.river.exports.process.DefaultProcessor;
mschaefer@9376: import org.dive4elements.river.model.Attribute.AttributeKey;
mschaefer@9252: 
mschaefer@9252: /**
mschaefer@9252:  * Processor to generate the facet and data series of a flood duration curve
mschaefer@9252:  *
mschaefer@9252:  * @author Matthias Schäfer
mschaefer@9252:  *
mschaefer@9252:  */
mschaefer@9252: public final class FloodDurationCurveProcessor extends DefaultProcessor {
mschaefer@9252: 
mschaefer@9259:     private static final String FACET_FLOOD_DURATION_W = FacetTypes.DURATION_W; // "duration_curve.w";
mschaefer@9252: 
mschaefer@9259:     private static final String FACET_FLOOD_DURATION_Q = FacetTypes.DURATION_Q; // "duration_curve.q";
mschaefer@9252: 
mschaefer@9259:     public static final String FACET_FLOOD_DURATION_MAINVALUES_W = "sinfo.mainvalues.w";
mschaefer@9257: 
mschaefer@9259:     public static final String FACET_FLOOD_DURATION_MAINVALUES_Q = "sinfo.mainvalues.q";
mschaefer@9259: 
mschaefer@9376:     public static final String FACET_FLOOD_DURATION_INFRASTRUCTURE_W_LEFT = "infrastructure.w.left";
mschaefer@9376: 
mschaefer@9376:     public static final String FACET_FLOOD_DURATION_INFRASTRUCTURE_W_RIGHT = "infrastructure.w.right";
mschaefer@9376: 
mschaefer@9376:     public static final String FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_LEFT = "infrastructure.q.left";
mschaefer@9376: 
mschaefer@9376:     public static final String FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_RIGHT = "infrastructure.q.right";
mschaefer@9257: 
mschaefer@9252:     private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
mschaefer@9252: 
mschaefer@9252:     static {
mschaefer@9252:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_W);
mschaefer@9252:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_Q);
mschaefer@9257:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_MAINVALUES_W);
mschaefer@9257:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_MAINVALUES_Q);
mschaefer@9376:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_INFRASTRUCTURE_W_LEFT);
mschaefer@9376:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_INFRASTRUCTURE_W_RIGHT);
mschaefer@9376:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_LEFT);
mschaefer@9376:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_RIGHT);
mschaefer@9376:     }
mschaefer@9376: 
mschaefer@9376:     public static boolean isInfrastructureFacet(final String name) {
mschaefer@9376:         return name.equals(FACET_FLOOD_DURATION_INFRASTRUCTURE_W_LEFT) || name.equals(FACET_FLOOD_DURATION_INFRASTRUCTURE_W_RIGHT)
mschaefer@9376:                 || name.equals(FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_LEFT) || name.equals(FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_RIGHT);
mschaefer@9252:     }
mschaefer@9252: 
mschaefer@9252:     public static Facet createFloodDurationWCurveFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
mschaefer@9252:             final int facetIndex, final int resultIndex, final String description) {
mschaefer@9252: 
mschaefer@9252:         return new FloodDurationCurveFacet(FACET_FLOOD_DURATION_W, description);
mschaefer@9252:     }
mschaefer@9252: 
mschaefer@9252:     public static Facet createFloodDurationQCurveFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
mschaefer@9252:             final int facetIndex, final int resultIndex, final String description) {
mschaefer@9252: 
mschaefer@9252:         return new FloodDurationCurveFacet(FACET_FLOOD_DURATION_Q, description);
mschaefer@9252:     }
mschaefer@9252: 
mschaefer@9257:     public static Facet createMainValuesWFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
mschaefer@9257:             final int facetIndex, final int resultIndex, final String description) {
mschaefer@9257: 
mschaefer@9257:         return new FloodDurationMainValuesWFacet(FACET_FLOOD_DURATION_MAINVALUES_W, description);
mschaefer@9257:     }
mschaefer@9257: 
mschaefer@9257:     public static Facet createMainValuesQFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
d@9612:             final int facetIndex, final int resultIndex, final String description, final Infrastructure infrastructure) {
mschaefer@9257: 
d@9612:         return new FloodDurationMainValuesQFacet(FACET_FLOOD_DURATION_MAINVALUES_Q, description, facetIndex, infrastructure);
mschaefer@9257:     }
mschaefer@9257: 
mschaefer@9376:     public static Facet createInfrastructureFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
d@9612:             final int facetIndex, final int resultIndex, final boolean isW, final AttributeKey riverside) {
mschaefer@9252: 
d@9612:         final String description = getLabel(context, isW, riverside);
d@9612:         final String facetName = getFacetName(riverside, isW);
d@9612: 
d@9612:         return new FloodDurationInfrastructureFacet(facetName, isW, resultIndex, riverside, facetIndex, description);
d@9612:     }
d@9612: 
d@9612:     private static String getFacetName(final AttributeKey riverside, final boolean isW) {
d@9612:         switch (riverside) {
d@9612:         case LEFT:
mschaefer@9376:             if (isW)
d@9612:                 return FACET_FLOOD_DURATION_INFRASTRUCTURE_W_LEFT;
mschaefer@9376:             else
d@9612:                 return FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_LEFT;
d@9612: 
d@9612:         case RIGHT:
d@9612:             if (isW)
d@9612:                 return FACET_FLOOD_DURATION_INFRASTRUCTURE_W_RIGHT;
d@9612:             else
d@9612:                 return FACET_FLOOD_DURATION_INFRASTRUCTURE_Q_RIGHT;
d@9612:         default:
d@9612:             throw new IllegalStateException();
mschaefer@9376:         }
d@9612:     }
d@9612: 
d@9612:     private static String getLabel(final CallContext context, final boolean isW, final AttributeKey riverside) {
d@9612:         switch (riverside) {
d@9612:         case LEFT:
mschaefer@9376:             if (isW)
d@9612:                 return Resources.getMsg(context.getMeta(), "sinfo_facet_flood_duration_curve.infra.w.left.description");
mschaefer@9376:             else
d@9612:                 return Resources.getMsg(context.getMeta(), "sinfo_facet_flood_duration_curve.infra.q.left.description");
d@9612:         case RIGHT:
d@9612:             if (isW)
d@9612:                 return Resources.getMsg(context.getMeta(), "sinfo_facet_flood_duration_curve.infra.w.right.description");
d@9612:             else
d@9612:                 return Resources.getMsg(context.getMeta(), "sinfo_facet_flood_duration_curve.infra.q.right.description");
d@9612: 
d@9612:         default:
d@9612:             throw new IllegalStateException();
mschaefer@9376:         }
mschaefer@9252:     }
mschaefer@9252: 
mschaefer@9252:     @Override
mschaefer@9252:     public final String getAxisLabel(final DiagramGenerator generator) {
mschaefer@9252:         return generator.msg(DurationCurveGenerator.I18N_YAXIS_LABEL_W);
mschaefer@9252:     }
mschaefer@9252: 
mschaefer@9252:     @Override
mschaefer@9252:     public final boolean canHandle(final String facettype) {
mschaefer@9252:         return HANDLED_FACET_TYPES.contains(facettype);
mschaefer@9252:     }
mschaefer@9252: }