gernotbelger@8914: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8914:  * Software engineering by Intevation GmbH
gernotbelger@8914:  *
gernotbelger@8914:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8914:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8914:  * documentation coming with Dive4Elements River for details.
gernotbelger@8914:  */
gernotbelger@8914: 
gernotbelger@8915: package org.dive4elements.river.artifacts.sinfo.tkhstate;
gernotbelger@8914: 
gernotbelger@8914: import java.util.List;
gernotbelger@8914: 
gernotbelger@8914: import org.dive4elements.artifactdatabase.state.Facet;
gernotbelger@8914: import org.dive4elements.artifacts.CallContext;
gernotbelger@8914: import org.dive4elements.river.artifacts.ChartArtifact;
gernotbelger@8914: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@8916: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8914: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8938: import org.dive4elements.river.artifacts.model.DataFacet;
gernotbelger@8914: import org.dive4elements.river.artifacts.model.EmptyFacet;
gernotbelger@8938: import org.dive4elements.river.artifacts.model.FacetTypes;
gernotbelger@8916: import org.dive4elements.river.artifacts.model.ReportFacet;
gernotbelger@8914: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@8941: import org.dive4elements.river.artifacts.sinfo.common.D50Processor;
gernotbelger@8940: import org.dive4elements.river.artifacts.sinfo.common.FlowDepthProcessor;
gernotbelger@8941: import org.dive4elements.river.artifacts.sinfo.common.TauProcessor;
gernotbelger@8916: import org.dive4elements.river.artifacts.sinfo.common.TkhProcessor;
gernotbelger@8941: import org.dive4elements.river.artifacts.sinfo.common.VelocityProcessor;
gernotbelger@8914: import org.dive4elements.river.artifacts.states.DefaultState;
gernotbelger@8914: 
gernotbelger@8914: /** State in which a waterlevel has been calculated. */
gernotbelger@8914: public class TkhState extends DefaultState {
gernotbelger@8914: 
gernotbelger@8914:     /// ** The log that is used in this state. */
gernotbelger@8914:     // private static Logger log = Logger.getLogger(FlowDepthState.class);
gernotbelger@8914: 
gernotbelger@8914:     private static final long serialVersionUID = 1L;
gernotbelger@8914: 
gernotbelger@8914:     /**
gernotbelger@8914:      * From this state can only be continued trivially.
gernotbelger@8914:      */
gernotbelger@8914:     @Override
gernotbelger@8914:     protected String getUIProvider() {
gernotbelger@8914:         return "continue";
gernotbelger@8914:     }
gernotbelger@8914: 
gernotbelger@8914:     @Override
gernotbelger@8914:     public Object computeFeed(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
gernotbelger@8914:         // FIXME: why is this necessary?
gernotbelger@8914:         if (artifact instanceof ChartArtifact) {
gernotbelger@8914:             facets.add(new EmptyFacet());
gernotbelger@8914:             return null;
gernotbelger@8914:         }
gernotbelger@8914: 
gernotbelger@8914:         return compute((SINFOArtifact) artifact, context, hash, facets, old);
gernotbelger@8914:     }
gernotbelger@8914: 
gernotbelger@8914:     @Override
gernotbelger@8914:     public Object computeAdvance(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
gernotbelger@8914:         if (artifact instanceof ChartArtifact) {
gernotbelger@8914:             facets.add(new EmptyFacet());
gernotbelger@8914:             return null;
gernotbelger@8914:         }
gernotbelger@8914:         return compute((SINFOArtifact) artifact, context, hash, facets, old);
gernotbelger@8914:     }
gernotbelger@8914: 
gernotbelger@8914:     /**
gernotbelger@8914:      * Compute result or returned object from cache, create facets.
gernotbelger@8914:      *
gernotbelger@8914:      * @param old
gernotbelger@8914:      *            Object that was cached.
gernotbelger@8914:      */
gernotbelger@8914:     private Object compute(final SINFOArtifact sinfo, final CallContext context, final String hash, final List<Facet> facets, final Object old) {
gernotbelger@8914: 
gernotbelger@8914:         final CalculationResult res = doCompute(sinfo, context, old);
gernotbelger@8914: 
gernotbelger@8914:         if (facets == null)
gernotbelger@8914:             return res;
gernotbelger@8914: 
gernotbelger@8916:         final TkhCalculationResults results = (TkhCalculationResults) res.getData();
gernotbelger@8916: 
gernotbelger@8916:         /* add themes for chart, for each result */
gernotbelger@8916:         final List<TkhCalculationResult> resultList = results.getResults();
gernotbelger@8916:         for (int index = 0; index < resultList.size(); index++) {
gernotbelger@8916: 
gernotbelger@8916:             final TkhCalculationResult result = resultList.get(index);
gernotbelger@8916: 
gernotbelger@8916:             facets.add(TkhProcessor.createTkhFacet(context, hash, this.id, result, index));
gernotbelger@8940: 
gernotbelger@8941:             facets.add(FlowDepthProcessor.createFlowDepthFacet(context, hash, this.id, result, index));
gernotbelger@8941:             facets.add(VelocityProcessor.createVelocityFacet(context, hash, this.id, result, index));
gernotbelger@8941:             facets.add(D50Processor.createD50Facet(context, hash, this.id, result, index));
gernotbelger@8941:             facets.add(TauProcessor.createTauFacet(context, hash, this.id, result, index));
gernotbelger@8916:         }
gernotbelger@8916: 
gernotbelger@8938:         if (!resultList.isEmpty()) {
gernotbelger@8938:             facets.add(new DataFacet(FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, this.id));
gernotbelger@8938:             facets.add(new DataFacet(FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, this.id));
gernotbelger@8938:         }
gernotbelger@8916: 
gernotbelger@8916:         final Calculation report = res.getReport();
gernotbelger@8916: 
gernotbelger@8916:         if (report.hasProblems())
gernotbelger@8916:             facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
gernotbelger@8916: 
gernotbelger@8916:         return res;
gernotbelger@8914:     }
gernotbelger@8914: 
gernotbelger@8914:     private CalculationResult doCompute(final SINFOArtifact sinfo, final CallContext context, final Object old) {
gernotbelger@8914:         if (old instanceof CalculationResult)
gernotbelger@8914:             return (CalculationResult) old;
gernotbelger@8914: 
gernotbelger@8915:         return new TkhCalculation(context).calculate(sinfo);
gernotbelger@8914:     }
gernotbelger@8914: }