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@8914: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8914: import org.dive4elements.river.artifacts.model.EmptyFacet;
gernotbelger@8914: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
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:     private static final String I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION = "sinfo.facet.flow_depth.filtered.description";
gernotbelger@8914: 
gernotbelger@8914:     private static final String I18N_FACET_FLOW_DEPTH_TKH_FILTERED_DESCRIPTION = "sinfo.facet.flow_depth.tkh.filtered.description";
gernotbelger@8914: 
gernotbelger@8914:     private static final String I18N_FACET_TKH_DESCRIPTION = "sinfo.facet.tkh.description";
gernotbelger@8914: 
gernotbelger@8914:     private static final String SINFO_CHART_FLOW_DEPTH_YAXIS_LABEL = "sinfo.chart.flow_depth.yaxis.label";
gernotbelger@8914: 
gernotbelger@8914:     private static final String SINFO_CHART_TKX_YAXIS_LABEL = "sinfo.chart.tkh.yaxis.label";
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@8914:         // final FlowDepthCalculationResults results = (FlowDepthCalculationResults) res.getData();
gernotbelger@8914:         //
gernotbelger@8914:         // /* add themes for chart, for each result */
gernotbelger@8914:         // final List<FlowDepthCalculationResult> resultList = results.getResults();
gernotbelger@8914:         // for (int index = 0; index < resultList.size(); index++) {
gernotbelger@8914:         //
gernotbelger@8914:         // final FlowDepthCalculationResult result = resultList.get(index);
gernotbelger@8914:         //
gernotbelger@8914:         // /* filtered (zoom dependent mean) flow depth */
gernotbelger@8914:         // final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(),
gernotbelger@8914:         // I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION,
gernotbelger@8914:         // I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION, result.getLabel());
gernotbelger@8914:         // facets.add(new FlowDepthFacet(index, FlowDepthProcessor.FACET_FLOW_DEPTH_FILTERED, facetFlowDepthFilteredDescription,
gernotbelger@8914:         // SINFO_CHART_FLOW_DEPTH_YAXIS_LABEL, ComputeType.ADVANCE, this.id, hash));
gernotbelger@8914:         //
gernotbelger@8914:         // if (results.isUseTkh()) {
gernotbelger@8914:         // /* filtered (zoom dependent mean) flow depth including tkh */
gernotbelger@8914:         // final String facetFlowDepthTkhFilteredDescription = Resources.getMsg(context.getMeta(),
gernotbelger@8914:         // I18N_FACET_FLOW_DEPTH_TKH_FILTERED_DESCRIPTION,
gernotbelger@8914:         // I18N_FACET_FLOW_DEPTH_TKH_FILTERED_DESCRIPTION, result.getLabel());
gernotbelger@8914:         // facets.add(new FlowDepthFacet(index, FlowDepthProcessor.FACET_FLOW_DEPTH_TKH_FILTERED,
gernotbelger@8914:         // facetFlowDepthTkhFilteredDescription,
gernotbelger@8914:         // SINFO_CHART_FLOW_DEPTH_YAXIS_LABEL, ComputeType.ADVANCE, this.id, hash));
gernotbelger@8914:         //
gernotbelger@8914:         // // FIXME: add other themes
gernotbelger@8914:         // // - Streckenfavoriten
gernotbelger@8914:         //
gernotbelger@8914:         // // FIXME:
gernotbelger@8914:         // // - Gemittelte Linie der Fließtiefe mitsamt TKH
gernotbelger@8914:         // // - Transportkörperhöhen (oben/unten/schraffur)
gernotbelger@8914:         // final String facetTkhDescription = Resources.getMsg(context.getMeta(), I18N_FACET_TKH_DESCRIPTION,
gernotbelger@8914:         // I18N_FACET_TKH_DESCRIPTION,
gernotbelger@8914:         // result.getLabel());
gernotbelger@8914:         // facets.add(new FlowDepthFacet(index, TkhProcessor.FACET_TKH, facetTkhDescription, SINFO_CHART_TKX_YAXIS_LABEL,
gernotbelger@8914:         // ComputeType.ADVANCE, this.id,
gernotbelger@8914:         // hash));
gernotbelger@8914:         // }
gernotbelger@8914:         //
gernotbelger@8914:         // // FIXME: Datenkorbkonfiguration
gernotbelger@8914:         // }
gernotbelger@8914:         //
gernotbelger@8914:         // if (!resultList.isEmpty()) {
gernotbelger@8914:         // final Facet csv = new DataFacet(FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, this.id);
gernotbelger@8914:         // final Facet pdf = new DataFacet(FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, this.id);
gernotbelger@8914:         //
gernotbelger@8914:         // facets.add(csv);
gernotbelger@8914:         // facets.add(pdf);
gernotbelger@8914:         // }
gernotbelger@8914:         //
gernotbelger@8914:         // final Calculation report = res.getReport();
gernotbelger@8914:         //
gernotbelger@8914:         // if (report.hasProblems()) {
gernotbelger@8914:         // facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
gernotbelger@8914:         // }
gernotbelger@8914:         //
gernotbelger@8914:         // return res;
gernotbelger@8914:         return null;
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: }