gernotbelger@8884: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8884:  * Software engineering by
gernotbelger@8884:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8884:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8884:  *
gernotbelger@8884:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8884:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8884:  * documentation coming with Dive4Elements River for details.
gernotbelger@8884:  */
gernotbelger@8884: 
gernotbelger@8884: package org.dive4elements.river.artifacts.sinfo.flowdepth;
gernotbelger@8884: 
gernotbelger@8884: import java.util.Set;
gernotbelger@8884: 
gernotbelger@8884: import org.apache.log4j.Logger;
gernotbelger@8884: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
gernotbelger@8884: import org.dive4elements.river.exports.DiagramGenerator;
gernotbelger@8884: import org.dive4elements.river.exports.process.DefaultProcessor;
gernotbelger@8884: import org.dive4elements.river.themes.ThemeDocument;
gernotbelger@8884: 
gernotbelger@8884: /**
gernotbelger@8884:  * Abstraction for some processor implementation within S-INFO. Probably this abstraction could also be used for other
gernotbelger@8884:  * cases as well.
gernotbelger@8884:  *
gernotbelger@8884:  * @author Gernot Belger
gernotbelger@8884:  *
gernotbelger@8884:  */
gernotbelger@8884: abstract class AbstractSInfoProcessor extends DefaultProcessor {
gernotbelger@8884: 
gernotbelger@8884:     private final static Logger log = Logger.getLogger(AbstractSInfoProcessor.class);
gernotbelger@8884: 
gernotbelger@8884:     private String yAxisLabel;
gernotbelger@8884: 
gernotbelger@8884:     private final Set<String> handled_facet_types;
gernotbelger@8884: 
gernotbelger@8884:     private final String i18n_axis_label;
gernotbelger@8884: 
gernotbelger@8884:     public AbstractSInfoProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) {
gernotbelger@8884:         this.i18n_axis_label = i18n_axis_label;
gernotbelger@8884:         this.handled_facet_types = handled_facet_types;
gernotbelger@8884:     }
gernotbelger@8884: 
gernotbelger@8884:     @Override
gernotbelger@8884:     public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
gernotbelger@8886:         try {
gernotbelger@8886:             this.yAxisLabel = generateSeries(generator, bundle, theme, visible);
gernotbelger@8884:         }
gernotbelger@8886:         catch (final Exception e) {
gernotbelger@8886:             log.error(e.getMessage(), e);
gernotbelger@8886:         }
gernotbelger@8884:     }
gernotbelger@8884: 
gernotbelger@8884:     /**
gernotbelger@8886:      * @return The axis label
gernotbelger@8884:      */
gernotbelger@8886:     protected abstract String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible);
gernotbelger@8884: 
gernotbelger@8884:     @Override
gernotbelger@8884:     public final boolean canHandle(final String facettype) {
gernotbelger@8884:         return this.handled_facet_types.contains(facettype);
gernotbelger@8884:     }
gernotbelger@8884: 
gernotbelger@8884:     @Override
gernotbelger@8884:     public final String getAxisLabel(final DiagramGenerator generator) {
gernotbelger@8884:         if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) {
gernotbelger@8884:             // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata),
gernotbelger@8884:             // and cannot be resolved, so we need to give the resolved value as default
gernotbelger@8884:             // FIXME: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here,
gernotbelger@8884:             // probably the English version will also show German (CHECK)
gernotbelger@8884:             return generator.msg(this.yAxisLabel, this.yAxisLabel);
gernotbelger@8884:         }
gernotbelger@8884:         return generator.msg(this.i18n_axis_label, "MISSING");
gernotbelger@8884:     }
gernotbelger@8884: }