mschaefer@9157: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@9157:  * Software engineering by
mschaefer@9157:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@9157:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@9157:  *
mschaefer@9157:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@9157:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@9157:  * documentation coming with Dive4Elements River for details.
mschaefer@9157:  */
mschaefer@9157: 
mschaefer@9157: package org.dive4elements.river.artifacts.sinfo.common;
mschaefer@9157: 
mschaefer@9157: import java.util.HashSet;
mschaefer@9157: import java.util.Set;
mschaefer@9157: 
mschaefer@9157: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
mschaefer@9157: import org.dive4elements.artifactdatabase.state.Facet;
mschaefer@9157: import org.dive4elements.artifacts.CallContext;
mschaefer@9157: import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
mschaefer@9157: import org.dive4elements.river.artifacts.resources.Resources;
mschaefer@9157: import org.dive4elements.river.artifacts.sinfo.collision.CollisionCalcFacet;
mschaefer@9157: import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
mschaefer@9157: import org.dive4elements.river.exports.DiagramGenerator;
mschaefer@9157: import org.dive4elements.river.themes.ThemeDocument;
mschaefer@9157: 
mschaefer@9157: /**
mschaefer@9157:  * Processor to generate the facet and data series of calculated bed collision counts
mschaefer@9157:  *
mschaefer@9157:  * @author Matthias Schäfer
mschaefer@9157:  *
mschaefer@9157:  */
mschaefer@9157: public final class CollisionCalcProcessor extends AbstractSInfoProcessor {
mschaefer@9157: 
mschaefer@9157:     public static final String FACET_COLLISION_CALC_COUNT = "sinfo_facet_collision_calc_count";
mschaefer@9157: 
mschaefer@9157:     private static final String I18N_AXIS_LABEL = "chart.collision_count.section.yaxis.label";
mschaefer@9157: 
mschaefer@9157:     private static final String I18N_SERIES_NAME_PATTERN = "collision.count.title";
mschaefer@9157: 
mschaefer@9157:     private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
mschaefer@9157: 
mschaefer@9157:     static {
mschaefer@9157:         HANDLED_FACET_TYPES.add(FACET_COLLISION_CALC_COUNT);
mschaefer@9157:     }
mschaefer@9157: 
mschaefer@9157:     public CollisionCalcProcessor() {
mschaefer@9157:         super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
mschaefer@9157:     }
mschaefer@9157: 
mschaefer@9157:     @Override
mschaefer@9157:     protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
mschaefer@9157: 
gernotbelger@9200:         return buildSeriesForType(generator, bundle, theme, visible, SInfoResultType.collisionCount, null);
mschaefer@9157:     }
mschaefer@9157: 
mschaefer@9157:     public static final Facet createFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
mschaefer@9157:             final int index) {
mschaefer@9157:         final String facetDescription = Resources.getMsg(context.getMeta(), I18N_SERIES_NAME_PATTERN, I18N_SERIES_NAME_PATTERN, result.getLabel());
mschaefer@9157:         return new CollisionCalcFacet(index, FACET_COLLISION_CALC_COUNT, facetDescription, I18N_AXIS_LABEL, ComputeType.ADVANCE, id, hash);
mschaefer@9157:     }
mschaefer@9157: }