mschaefer@9176: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@9176:  * Software engineering by
mschaefer@9176:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@9176:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@9176:  *
mschaefer@9176:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@9176:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@9176:  * documentation coming with Dive4Elements River for details.
mschaefer@9176:  */
mschaefer@9176: 
gernotbelger@9215: package org.dive4elements.river.artifacts.sinfo.flood_duration;
mschaefer@9176: 
mschaefer@9176: import java.util.HashSet;
mschaefer@9176: import java.util.Set;
mschaefer@9176: 
gernotbelger@9203: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
mschaefer@9176: import org.dive4elements.artifactdatabase.state.Facet;
mschaefer@9176: import org.dive4elements.artifacts.CallContext;
mschaefer@9176: import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
mschaefer@9202: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@9215: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoProcessor;
mschaefer@9229: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultFacet;
gernotbelger@9215: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
gernotbelger@9208: import org.dive4elements.river.artifacts.sinfo.flood_duration.FloodDurationCalculationResult.ValueGetter;
mschaefer@9202: import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
gernotbelger@9203: import org.dive4elements.river.exports.DiagramGenerator;
mschaefer@9229: import org.dive4elements.river.model.Attribute.AttributeKey;
gernotbelger@9203: import org.dive4elements.river.themes.ThemeDocument;
mschaefer@9176: 
mschaefer@9176: /**
mschaefer@9176:  * Processor to generate the facet and data series of infrastructure flood durations
mschaefer@9176:  *
mschaefer@9176:  * @author Matthias Schäfer
mschaefer@9176:  *
mschaefer@9176:  */
gernotbelger@9203: public final class FloodDurationProcessor extends AbstractSInfoProcessor {
mschaefer@9176: 
mschaefer@9229:     private static final String FACET_FLOOD_DURATION_LEFT = "sinfo_facet_flood_duration.left";
mschaefer@9229: 
mschaefer@9229:     private static final String FACET_FLOOD_DURATION_RIGHT = "sinfo_facet_flood_duration.right";
mschaefer@9176: 
gernotbelger@9205:     private static final String FACET_FLOOD_DURATION_DESCRIPTION = "sinfo_facet_flood_duration.description";
mschaefer@9176: 
gernotbelger@9205:     private static final String FACET_MAIN_VALUE_DURATION = "mainvalue.duration";
mschaefer@9202: 
gernotbelger@9205:     private static final String FACET_MAIN_VALUE_DURATION_DESCRIPTION = "mainvalue.duration.description";
mschaefer@9176: 
mschaefer@9176:     private static final String I18N_AXIS_LABEL = "sinfo.chart.flood_duration.section.yaxis.label";
mschaefer@9176: 
mschaefer@9176:     private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
mschaefer@9176: 
mschaefer@9176:     static {
mschaefer@9229:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_LEFT);
mschaefer@9229:         HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_RIGHT);
gernotbelger@9205:         HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_DURATION);
mschaefer@9176:     }
mschaefer@9176: 
mschaefer@9176:     public FloodDurationProcessor() {
mschaefer@9176:         super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
mschaefer@9176:     }
mschaefer@9176: 
gernotbelger@9203:     public static Facet createFloodDurationFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
mschaefer@9229:             final int facetIndex, final int resultIndex) {
mschaefer@9176: 
mschaefer@9229:         if (facetIndex == 0) {
mschaefer@9229:             final String description = Resources.getMsg(context.getMeta(), FACET_FLOOD_DURATION_DESCRIPTION, FACET_FLOOD_DURATION_DESCRIPTION,
mschaefer@9229:                     SInfoResultType.localizeRiverside(context, AttributeKey.LEFT));
mschaefer@9229:             return new SInfoResultFacet(facetIndex, resultIndex, FACET_FLOOD_DURATION_LEFT, description, I18N_AXIS_LABEL, ComputeType.ADVANCE, id, hash);
mschaefer@9229:         }
mschaefer@9229:         else {
mschaefer@9229:             final String description = Resources.getMsg(context.getMeta(), FACET_FLOOD_DURATION_DESCRIPTION, FACET_FLOOD_DURATION_DESCRIPTION,
mschaefer@9229:                     SInfoResultType.localizeRiverside(context, AttributeKey.RIGHT));
mschaefer@9229:             return new SInfoResultFacet(facetIndex, resultIndex, FACET_FLOOD_DURATION_RIGHT, description, I18N_AXIS_LABEL, ComputeType.ADVANCE, id, hash);
mschaefer@9229:         }
mschaefer@9176:     }
mschaefer@9176: 
gernotbelger@9203:     public static Facet createMainValueDurationFacet(final CallContext context, final String hash, final String id, final FloodDurationCalculationResult result,
gernotbelger@9205:             final int facetIndex, final int resultIndex, final int dataIndex) {
mschaefer@9202: 
mschaefer@9202:         final String description = Resources.getMsg(context.getMeta(), FACET_MAIN_VALUE_DURATION_DESCRIPTION, FACET_MAIN_VALUE_DURATION_DESCRIPTION,
gernotbelger@9209:                 result.getMainValueLabel(dataIndex));
gernotbelger@9205: 
gernotbelger@9215:         return new FloodDurationFacet(facetIndex, resultIndex, dataIndex, FACET_MAIN_VALUE_DURATION, description, ComputeType.ADVANCE, I18N_AXIS_LABEL, hash,
gernotbelger@9215:                 id);
mschaefer@9176:     }
gernotbelger@9203: 
gernotbelger@9203:     @Override
gernotbelger@9203:     protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
mschaefer@9229: 
gernotbelger@9205:         final String facetName = bundle.getFacetName();
gernotbelger@9203: 
mschaefer@9229:         if (FACET_FLOOD_DURATION_LEFT.contentEquals(facetName)) {
mschaefer@9229:             return buildInfrastructureSeries(generator, bundle, theme, visible, AttributeKey.LEFT);
mschaefer@9229:         }
mschaefer@9229: 
mschaefer@9229:         if (FACET_FLOOD_DURATION_RIGHT.contentEquals(facetName))
mschaefer@9229:             return buildInfrastructureSeries(generator, bundle, theme, visible, AttributeKey.RIGHT);
gernotbelger@9205: 
gernotbelger@9205:         if (FACET_MAIN_VALUE_DURATION.contentEquals(facetName)) {
gernotbelger@9205: 
gernotbelger@9208:             final AbstractCalculationResult data = getResult(generator, bundle);
gernotbelger@9205: 
gernotbelger@9215:             final FloodDurationFacet facet = (FloodDurationFacet) bundle.getFacet();
gernotbelger@9215:             final int index = facet.getWaterlevelIndex();
gernotbelger@9215: 
gernotbelger@9208:             if (data instanceof FloodDurationCalculationResult) {
gernotbelger@9208:                 final FloodDurationCalculationResult.ValueGetter valuegetter = new ValueGetter() {
gernotbelger@9208:                     @Override
gernotbelger@9208:                     public double getValue(final DurationWaterlevel waterlevel) {
gernotbelger@9208:                         return waterlevel.getFloodDurDaysPerYear();
gernotbelger@9208:                     }
gernotbelger@9208:                 };
gernotbelger@9215:                 final double[][] points = ((FloodDurationCalculationResult) data).getMainValueDurationPoints(generator, valuegetter, index);
mschaefer@9229:                 return buildStepLineSeriesForType(points, generator, bundle, theme, visible);
gernotbelger@9208:             }
gernotbelger@9205:         }
gernotbelger@9205: 
gernotbelger@9205:         final String error = String.format("Unknown facet name: %s", facetName);
gernotbelger@9205:         throw new UnsupportedOperationException(error);
gernotbelger@9205:     }
mschaefer@9229: 
mschaefer@9229:     private String buildInfrastructureSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible,
mschaefer@9229:             final AttributeKey riverside) {
mschaefer@9229: 
mschaefer@9229:         final FloodDurationCalculationResult data = (FloodDurationCalculationResult) getResult(generator, bundle);
mschaefer@9229: 
mschaefer@9229:         final double[][] points = data.getInfrastructurePoints(SInfoResultType.floodDuration, riverside);
mschaefer@9229: 
mschaefer@9229:         return buildSeriesForType(points, generator, bundle, theme, visible, null);
mschaefer@9229:     }
mschaefer@9176: }