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.Map;
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.artifacts.CallContext;
gernotbelger@8884: import org.dive4elements.river.exports.DiagramGenerator;
gernotbelger@8884: import org.dive4elements.river.exports.StyledSeriesBuilder;
gernotbelger@8884: import org.dive4elements.river.exports.process.DefaultProcessor;
gernotbelger@8884: import org.dive4elements.river.jfree.StyledXYSeries;
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@8884: 
gernotbelger@8884:         final CallContext context = generator.getCallContext();
gernotbelger@8884:         final Map<String, String> metaData = bundle.getFacet().getMetaData();
gernotbelger@8884: 
gernotbelger@8884:         final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
gernotbelger@8884:         series.putMetaData(metaData, bundle.getArtifact(), context);
gernotbelger@8884: 
gernotbelger@8884:         this.yAxisLabel = metaData.get("Y");
gernotbelger@8884: 
gernotbelger@8884:         final String facetName = bundle.getFacetName();
gernotbelger@8884:         final FlowDepthCalculationResult data = (FlowDepthCalculationResult) bundle.getData(context);
gernotbelger@8884:         if (data == null) {
gernotbelger@8884:             // Check has been here before so we keep it for security reasons
gernotbelger@8884:             // this should never happen though.
gernotbelger@8884:             log.error("Data is null for facet: " + facetName);
gernotbelger@8884:             return;
gernotbelger@8884:         }
gernotbelger@8884: 
gernotbelger@8884:         final double[][] points = generatePoints(data, facetName);
gernotbelger@8884: 
gernotbelger@8884:         StyledSeriesBuilder.addPoints(series, points, true);
gernotbelger@8884:         generator.addAxisSeries(series, this.axisName, visible);
gernotbelger@8884:     }
gernotbelger@8884: 
gernotbelger@8884:     /**
gernotbelger@8884:      * Override to implement, call super as last line for default case.
gernotbelger@8884:      */
gernotbelger@8884:     protected double[][] generatePoints(@SuppressWarnings("unused") final FlowDepthCalculationResult data, final String facetName) {
gernotbelger@8884:         final String error = String.format("Unknown facet name: %s", facetName);
gernotbelger@8884:         log.error(error);
gernotbelger@8884:         throw new UnsupportedOperationException(error);
gernotbelger@8884:     }
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: }