gernotbelger@8996: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@9150:  * Software engineering by
gernotbelger@9150:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8996:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8996:  *
gernotbelger@8996:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8996:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8996:  * documentation coming with Dive4Elements River for details.
gernotbelger@8996:  */
gernotbelger@8996: package org.dive4elements.river.artifacts.uinfo.inundationduration;
gernotbelger@8996: 
gernotbelger@8996: import java.util.List;
gernotbelger@8996: 
gernotbelger@8996: import org.dive4elements.artifactdatabase.state.Facet;
gernotbelger@8996: import org.dive4elements.artifacts.CallContext;
gernotbelger@8996: import org.dive4elements.river.artifacts.ChartArtifact;
gernotbelger@8996: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@9178: import org.dive4elements.river.artifacts.MapArtifact.MapState;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.DataFacet;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.EmptyFacet;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.ReportFacet;
gernotbelger@9190: import org.dive4elements.river.artifacts.model.map.WMSLayerFacet;
gernotbelger@8996: import org.dive4elements.river.artifacts.uinfo.UINFOArtifact;
gernotbelger@9190: import org.dive4elements.river.artifacts.uinfo.inundationduration.InundationDurationCalculationResult.WmsLayer;
gernotbelger@8996: 
gernotbelger@8996: /**
gernotbelger@8996:  * @author Domenico Nardi Tironi
gernotbelger@8996:  */
gernotbelger@9178: public class InundationDurationState extends MapState {
gernotbelger@8996: 
gernotbelger@8996:     /// ** The log that is used in this state. */
gernotbelger@8996:     // private static Logger log = Logger.getLogger(FlowDepthState.class);
gernotbelger@8996: 
gernotbelger@8996:     private static final long serialVersionUID = 1L;
gernotbelger@8996: 
gernotbelger@9190:     private static final String LABEL_URL_SEPARATOR = ";";// always sync with client (ExportPanel)
gernotbelger@9190: 
gernotbelger@8996:     /**
gernotbelger@8996:      * From this state can only be continued trivially.
gernotbelger@8996:      */
gernotbelger@8996:     @Override
gernotbelger@8996:     protected String getUIProvider() {
gernotbelger@8996:         return "continue";
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     @Override
gernotbelger@8996:     public Object computeFeed(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
gernotbelger@8996:         // FIXME: why is this necessary?
gernotbelger@8996:         if (artifact instanceof ChartArtifact) {
gernotbelger@8996:             facets.add(new EmptyFacet());
gernotbelger@8996:             return null;
gernotbelger@8996:         }
gernotbelger@8996: 
gernotbelger@9190:         return compute((UINFOArtifact) artifact, context, ComputeType.FEED, hash, facets, old);
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     @Override
gernotbelger@8996:     public Object computeAdvance(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
gernotbelger@8996:         if (artifact instanceof ChartArtifact) {
gernotbelger@8996:             facets.add(new EmptyFacet());
gernotbelger@8996:             return null;
gernotbelger@8996:         }
gernotbelger@9178: 
gernotbelger@9178:         if (facets != null)
gernotbelger@9178:             super.computeAdvance(artifact, hash, context, facets, old);
gernotbelger@9178: 
gernotbelger@9190:         return compute((UINFOArtifact) artifact, context, ComputeType.ADVANCE, hash, facets, old);
gernotbelger@9190: 
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     /**
gernotbelger@8996:      * Compute result or returned object from cache, create facets.
gernotbelger@8996:      *
gernotbelger@8996:      * @param old
gernotbelger@8996:      *            Object that was cached.
gernotbelger@8996:      */
gernotbelger@9190:     private Object compute(final UINFOArtifact sinfo, final CallContext context, final ComputeType type, final String hash, final List<Facet> facets,
gernotbelger@9190:             final Object old) {
gernotbelger@8996: 
gernotbelger@8996:         final CalculationResult res = doCompute(sinfo, context, old);
gernotbelger@8996: 
gernotbelger@8996:         if (facets == null)
gernotbelger@8996:             return res;
gernotbelger@8996: 
gernotbelger@9190:         final InundationDurationCalculationResult result = (InundationDurationCalculationResult) res.getData();
gernotbelger@9190:         final List<WmsLayer> layers = result.getLayers();
gernotbelger@8996: 
gernotbelger@9190:         int index = 1; // 1 because super.computeAdvance adds the river theme with index 0
gernotbelger@9190:         for (final WmsLayer layer : layers) {
gernotbelger@8996: 
gernotbelger@9190:             final String label = layer.getLabel();
gernotbelger@9190:             final String url = layer.getUrl();
gernotbelger@9190: 
gernotbelger@9190:             final WMSLayerFacet wmsFacet = new WMSLayerFacet(index, FLOODMAP_EXTERNAL_WMS_INUNDATIONDUR + index, label, type, getID(), hash, url);
gernotbelger@9190:             facets.add(wmsFacet);
gernotbelger@9190: 
gernotbelger@9190:             wmsFacet.addLayer("OSM-WMS-Dienst");
gernotbelger@9190: 
gernotbelger@9190:             // wmsFacet.setExtent(getExtent(false));
gernotbelger@9190:             // wmsFacet.setOriginalExtent(getExtent(true));
gernotbelger@9190:             wmsFacet.setSrid(getSrid());
gernotbelger@9190: 
gernotbelger@9190:             if (layer.isShowLayerLink())
gernotbelger@9190:                 facets.add(new DataFacet("wms_url", label + LABEL_URL_SEPARATOR + url, ComputeType.ADVANCE, hash, this.id));
gernotbelger@9190: 
gernotbelger@9190:             index++; // because super.computeAdvance adds the river theme with index 0
gernotbelger@8996:         }
gernotbelger@8996: 
gernotbelger@9190:         // tODO: create layer links: filter by "showLayerLink"
gernotbelger@9190: 
gernotbelger@9190:         // tODO: create layer links: filter by "showLayerLink"
gernotbelger@9190: 
gernotbelger@8996:         final Calculation report = res.getReport();
gernotbelger@8996:         if (report.hasProblems())
gernotbelger@8996:             facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
gernotbelger@8996: 
gernotbelger@8996:         return res;
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     private CalculationResult doCompute(final UINFOArtifact sinfo, final CallContext context, final Object old) {
gernotbelger@8996:         if (old instanceof CalculationResult)
gernotbelger@8996:             return (CalculationResult) old;
gernotbelger@8996: 
gernotbelger@8996:         return new InundationDurationCalculation(context).calculate(sinfo);
gernotbelger@8996:     }
gernotbelger@8996: }