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@9347: package org.dive4elements.river.artifacts.common;
gernotbelger@8884: 
gernotbelger@9200: 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@9203: import org.dive4elements.artifactdatabase.state.Facet;
gernotbelger@9200: import org.dive4elements.artifacts.Artifact;
gernotbelger@9200: import org.dive4elements.artifacts.CallContext;
gernotbelger@9200: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@9200: import org.dive4elements.river.artifacts.access.RiverAccess;
gernotbelger@9200: import org.dive4elements.river.artifacts.context.RiverContext;
gernotbelger@9200: import org.dive4elements.river.artifacts.math.MovingAverage;
mschaefer@9229: import org.dive4elements.river.artifacts.model.WQKms;
gernotbelger@9200: import org.dive4elements.river.artifacts.model.ZoomScale;
gernotbelger@9203: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@9347: import org.dive4elements.river.artifacts.sinfo.common.AbstractTkhCalculationResult;
gernotbelger@9203: import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
gernotbelger@8884: import org.dive4elements.river.exports.DiagramGenerator;
gernotbelger@9200: import org.dive4elements.river.exports.StyledSeriesBuilder;
gernotbelger@8884: import org.dive4elements.river.exports.process.DefaultProcessor;
gernotbelger@9200: import org.dive4elements.river.jfree.StyledAreaSeriesCollection;
gernotbelger@9200: 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@9347: 
gernotbelger@9347: public abstract class AbstractProcessor extends DefaultProcessor {
gernotbelger@8884: 
gernotbelger@9200:     protected static final double GAP_DISTANCE = 0.101;
gernotbelger@9200: 
gernotbelger@9347:     private final static Logger log = Logger.getLogger(AbstractProcessor.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@9347:     public AbstractProcessor(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@9205:     protected static final AbstractCalculationResult getResult(final DiagramGenerator generator, final ArtifactAndFacet bundle) {
gernotbelger@9205:         final CallContext context = generator.getContext();
gernotbelger@9205:         final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context);
gernotbelger@9205:         if (data == null) {
gernotbelger@9205:             // Check has been here before so we keep it for security reasons
gernotbelger@9205:             // this should never happen though.
gernotbelger@9205:             final String facetName = bundle.getFacetName();
gernotbelger@9205:             throw new IllegalStateException("Data is null for facet: " + facetName);
gernotbelger@9205:         }
gernotbelger@9205: 
gernotbelger@9205:         return data;
gernotbelger@9205:     }
gernotbelger@9205: 
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@9200:     protected final String buildSeriesForType(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible,
gernotbelger@9200:             final IResultType resultType, final Double gapDistance) {
gernotbelger@9205: 
gernotbelger@9205:         final AbstractCalculationResult data = getResult(generator, bundle);
gernotbelger@9205: 
gernotbelger@9205:         final double[][] points = data.getStationPoints(resultType);
gernotbelger@9205: 
gernotbelger@9347:         return buildSeriesForPoints(points, generator, bundle, theme, visible, gapDistance);
gernotbelger@9205:     }
gernotbelger@9205: 
gernotbelger@9347:     protected final String buildSeriesForPoints(final double[][] points, final DiagramGenerator generator, final ArtifactAndFacet bundle,
gernotbelger@9205:             final ThemeDocument theme, final boolean visible, final Double gapDistance) {
gernotbelger@9200:         final CallContext context = generator.getContext();
gernotbelger@9200:         final Map<String, String> metaData = bundle.getFacet().getMetaData();
gernotbelger@9200: 
gernotbelger@9200:         final Artifact artifact = bundle.getArtifact();
gernotbelger@9200: 
gernotbelger@9556:         final String facetDescription = bundle.getFacetDescription();
gernotbelger@9556:         final String facetName = bundle.getFacetName();
gernotbelger@9556: 
gernotbelger@9556:         final StyledXYSeries series = new StyledXYSeries(facetName, facetDescription, theme);
gernotbelger@9200:         series.putMetaData(metaData, artifact, context);
gernotbelger@9200: 
gernotbelger@9205:         final double[][] filteredPoints = filterPoints(points, context, artifact, facetName);
gernotbelger@9200: 
gernotbelger@9200:         if (gapDistance == null)
gernotbelger@9205:             StyledSeriesBuilder.addPoints(series, filteredPoints, true);
gernotbelger@9200:         else
gernotbelger@9205:             StyledSeriesBuilder.addPoints(series, filteredPoints, true, gapDistance);
gernotbelger@9200: 
gernotbelger@9200:         generator.addAxisSeries(series, getAxisName(), visible);
gernotbelger@9200: 
gernotbelger@9200:         return metaData.get("Y");
gernotbelger@9200:     }
gernotbelger@9200: 
mschaefer@9229:     protected final String buildStepLineSeriesForType(final double[][] points, final DiagramGenerator generator, final ArtifactAndFacet bundle,
mschaefer@9229:             final ThemeDocument theme, final boolean visible) {
mschaefer@9229: 
mschaefer@9229:         final CallContext context = generator.getContext();
mschaefer@9229:         final Map<String, String> metaData = bundle.getFacet().getMetaData();
mschaefer@9229: 
mschaefer@9229:         final Artifact artifact = bundle.getArtifact();
mschaefer@9229: 
gernotbelger@9556:         final String facetName = bundle.getFacetName();
gernotbelger@9556:         final String facetDescription = bundle.getFacetDescription();
gernotbelger@9556: 
gernotbelger@9556:         final StyledXYSeries series = new StyledXYSeries(facetName, facetDescription, theme);
mschaefer@9229:         series.putMetaData(metaData, artifact, context);
mschaefer@9229: 
mschaefer@9229:         // Create WQKms to use the step points method
mschaefer@9229:         // REMARK: must have any values in w array; not sure whether the name is needed
mschaefer@9229:         final WQKms wqkms = new WQKms(points[0], points[1], points[1], facetName);
mschaefer@9229: 
mschaefer@9229:         StyledSeriesBuilder.addStepPointsKmQ(series, wqkms);
mschaefer@9229: 
mschaefer@9229:         generator.addAxisSeries(series, getAxisName(), visible);
mschaefer@9229: 
mschaefer@9229:         return metaData.get("Y");
mschaefer@9229:     }
mschaefer@9204: 
gernotbelger@9200:     protected final String buildSeriesForTkh(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme,
gernotbelger@9200:             final boolean visible) {
gernotbelger@9200: 
gernotbelger@9205:         final AbstractTkhCalculationResult data = (AbstractTkhCalculationResult) getResult(generator, bundle);
gernotbelger@9200: 
gernotbelger@9556:         final String facetName = bundle.getFacetName();
gernotbelger@9556:         final String facetDescription = bundle.getFacetDescription();
gernotbelger@9556: 
gernotbelger@9556:         final StyledXYSeries seriesUp = new StyledXYSeries(facetName, facetDescription, theme);
gernotbelger@9200:         final double[][] pointsUp = data.getTkhUpPoints();
gernotbelger@9200:         StyledSeriesBuilder.addPoints(seriesUp, pointsUp, true);
gernotbelger@9200: 
gernotbelger@9200:         // REMARK: we add " " because the description is misused as id, which must be unique.
gernotbelger@9556:         final StyledXYSeries seriesDown = new StyledXYSeries(facetName, facetDescription + " ", theme);
gernotbelger@9200:         final double[][] pointsDown = data.getTkhDownPoints();
gernotbelger@9200:         StyledSeriesBuilder.addPoints(seriesDown, pointsDown, true);
gernotbelger@9200: 
gernotbelger@9556:         final StyledAreaSeriesCollection area = new StyledAreaSeriesCollection(facetName, theme);
gernotbelger@9200:         area.setMode(StyledAreaSeriesCollection.FILL_MODE.BETWEEN);
gernotbelger@9200:         area.addSeries(seriesUp);
gernotbelger@9200:         area.addSeries(seriesDown);
gernotbelger@9200: 
gernotbelger@9496:         generator.addAxisDataset(area, getAxisName(), visible);
gernotbelger@9496: 
gernotbelger@9496:         return null;
gernotbelger@9496:     }
gernotbelger@9496: 
gernotbelger@9200:     private Double findRadius(final CallContext context, final Artifact artifact) {
gernotbelger@9200:         final Double start = (Double) context.getContextValue("startkm");
gernotbelger@9200:         final Double end = (Double) context.getContextValue("endkm");
gernotbelger@9200: 
gernotbelger@9200:         if (start == null || end == null)
gernotbelger@9200:             return null;
gernotbelger@9200: 
gernotbelger@9200:         final RiverContext fc = (RiverContext) context.globalContext();
gernotbelger@9200:         final ZoomScale scales = (ZoomScale) fc.get("zoomscale");
gernotbelger@9200:         final RiverAccess access = new RiverAccess((D4EArtifact) artifact);
gernotbelger@9200:         final String river = access.getRiverName();
gernotbelger@9200: 
gernotbelger@9200:         return scales.getRadius(river, start, end);
gernotbelger@9200:     }
gernotbelger@9200: 
gernotbelger@9205:     private double[][] filterPoints(final double[][] points, final CallContext context, final Artifact artifact, final String facetName) {
gernotbelger@9200: 
gernotbelger@9200:         if (facetName.endsWith(".filtered")) {
gernotbelger@9200:             final Double radius = findRadius(context, artifact);
gernotbelger@9200:             return movingAverage(radius, points);
gernotbelger@9200:         }
gernotbelger@9200: 
gernotbelger@9200:         return points;
gernotbelger@9200:     }
gernotbelger@9200: 
gernotbelger@9200:     private double[][] movingAverage(final Double radius, final double[][] points) {
gernotbelger@9200: 
gernotbelger@9200:         if (radius == null)
gernotbelger@9200:             return points;
gernotbelger@9200: 
gernotbelger@9200:         return MovingAverage.weighted(points, radius);
gernotbelger@9200:     }
gernotbelger@9200: 
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@9040:             // TODO: 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@9203: 
gernotbelger@9203:     protected static final Facet createFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
gernotbelger@9205:             final int resultIndex, final String axisLabel, final String facetId, final String description) {
gernotbelger@9205:         final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel());
gernotbelger@9347:         return new ResultFacet(resultIndex, facetId, facetFlowDepthFilteredDescription, axisLabel, ComputeType.ADVANCE, id, hash);
gernotbelger@9205:     }
gernotbelger@8884: }