gernotbelger@8956: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8956:  * Software engineering by
gernotbelger@8956:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8956:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8956:  *
gernotbelger@8956:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8956:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8956:  * documentation coming with Dive4Elements River for details.
gernotbelger@8956:  */
gernotbelger@8956: 
gernotbelger@8956: package org.dive4elements.river.artifacts.sinfo.common;
gernotbelger@8956: 
gernotbelger@8956: import java.util.HashSet;
gernotbelger@8956: import java.util.Set;
gernotbelger@8956: 
gernotbelger@9203: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
gernotbelger@8956: import org.dive4elements.artifactdatabase.state.Facet;
gernotbelger@8956: import org.dive4elements.artifacts.CallContext;
gernotbelger@9150: import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
gernotbelger@9347: import org.dive4elements.river.artifacts.common.AbstractProcessor;
gernotbelger@9347: import org.dive4elements.river.artifacts.common.ResultFacet;
gernotbelger@8956: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8956: import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
gernotbelger@9203: import org.dive4elements.river.exports.DiagramGenerator;
gernotbelger@9203: import org.dive4elements.river.themes.ThemeDocument;
gernotbelger@8956: 
gernotbelger@9347: public final class FlowDepthDevelopmentProcessor extends AbstractProcessor {
gernotbelger@8956: 
gernotbelger@8956:     private static final String I18N_AXIS_LABEL = "sinfo.chart.flow_depth_development.section.yaxis.label";
gernotbelger@8956: 
gernotbelger@9123:     private static final String SINFO_CHART_FLOW_DEPTH_DEVELOPMENT_YAXIS_LABEL = "sinfo.chart.flow_depth_development.yaxis.label";
gernotbelger@8956: 
gernotbelger@8956:     /* Theme name, usually defined in 'FacetTypes', but that is soooo bad dependencies... */
gernotbelger@8980:     // REMARK: these must end with 'filtered' so extra handling happens in chart: point are always recalculated, because
gernotbelger@8980:     // data changes depending on zoom state
gernotbelger@8956:     public static final String FACET_FLOW_DEPTH_DEVELOPMENT_FILTERED = "sinfo_facet_flow_depth_development.filtered";
gernotbelger@8956: 
gernotbelger@8980:     private static final String FACET_FLOW_DEPTH_DEVELOPMENT_FILTERED_DESCRIPTION = "sinfo.facet.flow_depth_development.filtered.description";
gernotbelger@8980: 
gernotbelger@8980:     public static final String FACET_FLOW_DEPTH_DEVELOPMENT_RAW = "sinfo_facet_flow_depth_development";
gernotbelger@8980: 
gernotbelger@8980:     private static final String FACET_FLOW_DEPTH_DEVELOPMENT_RAW_DESCRIPTION = "sinfo.facet.flow_depth_development.raw.description";
gernotbelger@8956: 
gernotbelger@8956:     public static final String FACET_WATERLEVEL_DIFFERENCE_FILTERED = "sinfo_facet_waterlevel_difference.filtered";
d@9617:     public static final String FACET_WATERLEVEL_DIFFERENCE_RAW = "sinfo_facet_waterlevel_difference";
gernotbelger@8956: 
gernotbelger@8980:     private static final String FACET_WATERLEVEL_DIFFERENCE_FILTERED_DESCRIPTION = "sinfo.facet.waterlevel_difference.filtered.description";
d@9617:     private static final String FACET_WATERLEVEL_DIFFERENCE_RAW_DESCRIPTION = "sinfo.facet.waterlevel_difference.raw.description"; // TODO
gernotbelger@8956: 
gernotbelger@8956:     public static final String FACET_BEDHEIGHT_DIFFERENCE_FILTERED = "sinfo_facet_bedheight_difference.filtered";
d@9617:     public static final String FACET_BEDHEIGHT_DIFFERENCE_RAW = "sinfo_facet_bedheight_difference";
gernotbelger@8956: 
gernotbelger@8980:     private static final String FACET_BEDHEIGHT_DIFFERENCE_FILTERED_DESCRIPTION = "sinfo.facet.bedheight_difference.filtered.description";
d@9617:     private static final String FACET_BEDHEIGHT_DIFFERENCE_RAW_DESCRIPTION = "sinfo.facet.bedheight_difference.raw.description";
gernotbelger@8956: 
gernotbelger@8956:     private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
gernotbelger@8956: 
gernotbelger@8956:     static {
gernotbelger@8956:         HANDLED_FACET_TYPES.add(FACET_FLOW_DEPTH_DEVELOPMENT_FILTERED);
gernotbelger@8980:         HANDLED_FACET_TYPES.add(FACET_FLOW_DEPTH_DEVELOPMENT_RAW);
gernotbelger@8956:         HANDLED_FACET_TYPES.add(FACET_WATERLEVEL_DIFFERENCE_FILTERED);
d@9617:         HANDLED_FACET_TYPES.add(FACET_WATERLEVEL_DIFFERENCE_RAW);
gernotbelger@8956:         HANDLED_FACET_TYPES.add(FACET_BEDHEIGHT_DIFFERENCE_FILTERED);
d@9617:         HANDLED_FACET_TYPES.add(FACET_BEDHEIGHT_DIFFERENCE_RAW);
gernotbelger@8956:     }
gernotbelger@8956: 
gernotbelger@8956:     public FlowDepthDevelopmentProcessor() {
gernotbelger@8956:         super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
gernotbelger@8956:     }
gernotbelger@8956: 
gernotbelger@9600:     private SInfoResultType doGetType(final String facetName) {
gernotbelger@8956: 
gernotbelger@8956:         if (FACET_FLOW_DEPTH_DEVELOPMENT_FILTERED.contentEquals(facetName))
gernotbelger@9203:             return SInfoResultType.flowdepthDevelopment;
gernotbelger@8980:         if (FACET_FLOW_DEPTH_DEVELOPMENT_RAW.contentEquals(facetName))
gernotbelger@9203:             return SInfoResultType.flowdepthDevelopment;
gernotbelger@8956: 
gernotbelger@8956:         if (FACET_WATERLEVEL_DIFFERENCE_FILTERED.contentEquals(facetName))
gernotbelger@9203:             return SInfoResultType.waterlevelDifference;
d@9617:         if (FACET_WATERLEVEL_DIFFERENCE_RAW.contentEquals(facetName))
d@9617:             return SInfoResultType.waterlevelDifference;
gernotbelger@8956: 
gernotbelger@8956:         if (FACET_BEDHEIGHT_DIFFERENCE_FILTERED.contentEquals(facetName))
gernotbelger@9203:             return SInfoResultType.bedHeightDifference;
d@9617:         if (FACET_BEDHEIGHT_DIFFERENCE_RAW.contentEquals(facetName))
d@9617:             return SInfoResultType.bedHeightDifference;
gernotbelger@8956: 
gernotbelger@8956:         final String error = String.format("Unknown facet name: %s", facetName);
gernotbelger@8956:         throw new UnsupportedOperationException(error);
gernotbelger@8956:     }
gernotbelger@8956: 
gernotbelger@8980:     public static Facet createFlowDepthDevelopmentFilteredFacet(final CallContext context, final String hash, final String id,
gernotbelger@9150:             final AbstractCalculationResult result, final int index) {
gernotbelger@9347:         return AbstractProcessor.createFacet(context, hash, id, result, index, SINFO_CHART_FLOW_DEPTH_DEVELOPMENT_YAXIS_LABEL,
gernotbelger@8980:                 FACET_FLOW_DEPTH_DEVELOPMENT_FILTERED, FACET_FLOW_DEPTH_DEVELOPMENT_FILTERED_DESCRIPTION);
gernotbelger@8980:     }
gernotbelger@8980: 
gernotbelger@8980:     public static Facet createFlowDepthDevelopmentRawFacet(final CallContext context, final String hash, final String id,
gernotbelger@9150:             final AbstractCalculationResult result, final int index) {
d@9617:         return AbstractProcessor.createFacet(context, hash, id, result, index, SINFO_CHART_FLOW_DEPTH_DEVELOPMENT_YAXIS_LABEL, FACET_FLOW_DEPTH_DEVELOPMENT_RAW,
d@9617:                 FACET_FLOW_DEPTH_DEVELOPMENT_RAW_DESCRIPTION);
gernotbelger@8956:     }
gernotbelger@8956: 
d@9617:     public static Facet createWaterlevelDifferenceFacetRaw(final CallContext context, final String hash, final String id,
d@9617:             final AbstractCalculationResult result, final int index) {
d@9617:         return createWaterlevelDifferenceFacet(context, hash, id, result, index, FACET_WATERLEVEL_DIFFERENCE_RAW, FACET_WATERLEVEL_DIFFERENCE_RAW_DESCRIPTION);
gernotbelger@8956:     }
gernotbelger@8956: 
d@9617:     public static Facet createBedHeightDifferenceFacetRaw(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
gernotbelger@9150:             final int index) {
d@9617:         return createBedHeightDifferenceFacet(context, hash, id, result, index, FACET_BEDHEIGHT_DIFFERENCE_RAW, FACET_BEDHEIGHT_DIFFERENCE_RAW_DESCRIPTION);
d@9617:     }
gernotbelger@8956: 
d@9617:     public static Facet createWaterlevelDifferenceFacetFiltered(final CallContext context, final String hash, final String id,
d@9617:             final AbstractCalculationResult result, final int index) {
d@9617:         return createWaterlevelDifferenceFacet(context, hash, id, result, index, FACET_WATERLEVEL_DIFFERENCE_FILTERED,
d@9617:                 FACET_WATERLEVEL_DIFFERENCE_FILTERED_DESCRIPTION);
d@9617:     }
d@9617: 
d@9617:     public static Facet createBedHeightDifferenceFacetFiltered(final CallContext context, final String hash, final String id,
d@9617:             final AbstractCalculationResult result, final int index) {
d@9617:         return createBedHeightDifferenceFacet(context, hash, id, result, index, FACET_BEDHEIGHT_DIFFERENCE_FILTERED,
d@9617:                 FACET_BEDHEIGHT_DIFFERENCE_FILTERED_DESCRIPTION);
d@9617:     }
d@9617: 
d@9617:     private static Facet createWaterlevelDifferenceFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
d@9617:             final int index, final String facetName, final String description) {
d@9617:         final String facetFlowDepthTkhFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel());
d@9617:         return new ResultFacet(index, facetName, facetFlowDepthTkhFilteredDescription, SINFO_CHART_FLOW_DEPTH_DEVELOPMENT_YAXIS_LABEL, ComputeType.ADVANCE, id,
d@9617:                 hash);
d@9617:     }
d@9617: 
d@9617:     private static Facet createBedHeightDifferenceFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
d@9617:             final int index, final String facetName, final String description) {
d@9617: 
d@9617:         final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel());
d@9617:         return new ResultFacet(index, facetName, facetFlowDepthFilteredDescription, SINFO_CHART_FLOW_DEPTH_DEVELOPMENT_YAXIS_LABEL, ComputeType.ADVANCE, id,
d@9617:                 hash);
gernotbelger@8956:     }
gernotbelger@9203: 
gernotbelger@9203:     @Override
gernotbelger@9203:     protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
gernotbelger@9203: 
gernotbelger@9600:         return buildSeriesForType(generator, bundle, theme, visible, doGetType(bundle.getFacetName()), GAP_DISTANCE);
gernotbelger@9203:     }
gernotbelger@8956: }