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.salix;
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@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.FacetTypes;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.ReportFacet;
mschaefer@9316: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8996: import org.dive4elements.river.artifacts.states.DefaultState;
gernotbelger@8996: import org.dive4elements.river.artifacts.uinfo.UINFOArtifact;
gernotbelger@9429: import org.dive4elements.river.artifacts.uinfo.salix.SalixLineCrossSectionIndexData.SalixWaterlevel;
gernotbelger@9514: import org.dive4elements.river.artifacts.uinfo.vegetationzones.VegetationZonesCrossSectionProcessor;
gernotbelger@8996: 
gernotbelger@8996: /**
gernotbelger@8996:  * @author Domenico Nardi Tironi
gernotbelger@8996:  */
gernotbelger@8996: public class SalixLineState extends DefaultState {
gernotbelger@8996: 
gernotbelger@8996:     private static final long serialVersionUID = 1L;
gernotbelger@8996: 
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@9426:         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@9426:         return compute((UINFOArtifact) artifact, context, ComputeType.ADVANCE, hash, facets, old);
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@9426:     private Object compute(final UINFOArtifact uinfo, final CallContext context, final ComputeType type, final String hash, final List<Facet> facets,
gernotbelger@9426:             final Object old) {
gernotbelger@8996: 
mschaefer@9316:         final CalculationResult res = doCompute(uinfo, context, old);
gernotbelger@8996: 
gernotbelger@8996:         if (facets == null)
gernotbelger@8996:             return res;
gernotbelger@8996: 
gernotbelger@8996:         final SalixLineCalculationResults results = (SalixLineCalculationResults) res.getData();
gernotbelger@8996: 
mschaefer@9361:         final List<SalixLineCalculationResult> resultList = results.getResults();
gernotbelger@8996: 
gernotbelger@9426:         final String stateId = getID();
gernotbelger@9426: 
gernotbelger@9347:         int facetIndex = 0;
gernotbelger@9347: 
gernotbelger@8996:         if (!resultList.isEmpty()) {
gernotbelger@9514: 
gernotbelger@9514:             /* we know there is exactly one result */
gernotbelger@9514:             final SalixLineCalculationResult result = resultList.get(0);
gernotbelger@9514: 
gernotbelger@9426:             facets.add(SalixLineProcessor.createSalixLineFilteredFacet(context, hash, stateId, facetIndex++, 0));
gernotbelger@9426:             facets.add(SalixLineProcessor.createSalixLineRawFacet(context, hash, stateId, facetIndex++, 0));
gernotbelger@9426:             facets.add(SalixLineProcessor.createSalixMnwMwFilteredFacet(context, hash, stateId, facetIndex++, 0));
gernotbelger@9426:             facets.add(SalixLineProcessor.createSalixMnwMwRawFacet(context, hash, stateId, facetIndex++, 0));
gernotbelger@9426:             facets.add(SalixLineProcessor.createSalixRankFacet(context, hash, stateId, facetIndex++, 0));
gernotbelger@9426: 
gernotbelger@9429:             facets.add(SalixLineProcessor.createSalixCrossSectionFacet(context, type, hash, stateId, facetIndex++));
gernotbelger@9514:             facets.add(VegetationZonesCrossSectionProcessor.createDefaultVegetationZonesCrossSectionFacet(context.getMeta()));
gernotbelger@9347: 
mschaefer@9361:             for (int i = 0; i <= result.getScenarioCount() - 1; i++) {
gernotbelger@9429:                 final String scenarioLabel = result.getScenarioLabel(i);
gernotbelger@9429: 
gernotbelger@9429:                 final String sublabel = Resources.getMsg(context.getMeta(), "uinfo_salix_scenario_deltaw", "uinfo_salix_scenario_deltaw", scenarioLabel);
gernotbelger@9426:                 facets.add(SalixLineProcessor.createSalixScenarioFilteredFacet(context, hash, stateId, i, 0, facetIndex++, sublabel));
gernotbelger@9426:                 facets.add(SalixLineProcessor.createSalixScenarioRawFacet(context, hash, stateId, i, 0, facetIndex++, sublabel));
gernotbelger@9426: 
gernotbelger@9429:                 facets.add(SalixLineProcessor.createSalixScenarioCrossSectionFacet(context, type, hash, stateId, i, facetIndex++, sublabel));
mschaefer@9316:             }
mschaefer@9295: 
gernotbelger@9429:             for (final SalixWaterlevel knownWaterlevel : SalixLineCrossSectionIndexData.SalixWaterlevel.values())
gernotbelger@9429:                 facets.add(SalixLineProcessor.createSalixWaterlevelCrossSectionFacet(context, type, hash, stateId, knownWaterlevel, facetIndex++));
gernotbelger@9426: 
gernotbelger@9426:             final Facet csv = new DataFacet(FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, stateId);
gernotbelger@9426:             final Facet pdf = new DataFacet(FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, stateId);
gernotbelger@8996: 
gernotbelger@8996:             facets.add(csv);
gernotbelger@8996:             facets.add(pdf);
gernotbelger@8996:         }
gernotbelger@8996: 
gernotbelger@8996:         final Calculation report = res.getReport();
gernotbelger@8996: 
gernotbelger@8996:         if (report.hasProblems())
gernotbelger@9426:             facets.add(new ReportFacet(ComputeType.ADVANCE, hash, stateId));
gernotbelger@8996: 
gernotbelger@8996:         return res;
gernotbelger@8996:     }
gernotbelger@8996: 
mschaefer@9295:     private CalculationResult doCompute(final UINFOArtifact uinfo, final CallContext context, final Object old) {
gernotbelger@8996:         if (old instanceof CalculationResult)
gernotbelger@8996:             return (CalculationResult) old;
gernotbelger@8996: 
mschaefer@9295:         return new SalixLineCalculation(context).calculate(uinfo);
gernotbelger@8996:     }
gernotbelger@8996: }