gernotbelger@8854: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8854:  * Software engineering by Intevation GmbH
gernotbelger@8854:  *
gernotbelger@8854:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8854:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8854:  * documentation coming with Dive4Elements River for details.
gernotbelger@8854:  */
gernotbelger@8854: 
gernotbelger@8854: package org.dive4elements.river.artifacts.sinfo.flowdepth;
gernotbelger@8854: 
gernotbelger@8854: import java.util.List;
gernotbelger@8854: 
gernotbelger@8854: import org.dive4elements.artifactdatabase.state.Facet;
gernotbelger@8854: import org.dive4elements.artifacts.CallContext;
gernotbelger@8854: import org.dive4elements.river.artifacts.ChartArtifact;
gernotbelger@8854: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.DataFacet;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.EmptyFacet;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.FacetTypes;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.ReportFacet;
gernotbelger@8854: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8854: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@8854: import org.dive4elements.river.artifacts.states.DefaultState;
gernotbelger@8854: 
gernotbelger@8854: /** State in which a waterlevel has been calculated. */
gernotbelger@8854: public class FlowDepthState
gernotbelger@8854: extends      DefaultState
gernotbelger@8854: {
gernotbelger@8854:     /// ** The log that is used in this state. */
gernotbelger@8854:     // private static Logger log = Logger.getLogger(FlowDepthState.class);
gernotbelger@8854: 
gernotbelger@8877:     private static final long serialVersionUID = 1L;
gernotbelger@8877: 
gernotbelger@8854:     private static final String I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION = "sinfo.facet.flow_depth.filtered.description";
gernotbelger@8854: 
gernotbelger@8854:     /**
gernotbelger@8854:      * From this state can only be continued trivially.
gernotbelger@8854:      */
gernotbelger@8854:     @Override
gernotbelger@8854:     protected String getUIProvider() {
gernotbelger@8854:         return "continue";
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8854:     @Override
gernotbelger@8854:     public Object computeFeed(
gernotbelger@8854:         final D4EArtifact artifact,
gernotbelger@8854:         final String       hash,
gernotbelger@8854:         final CallContext  context,
gernotbelger@8854:         final List<Facet>  facets,
gernotbelger@8854:         final Object       old
gernotbelger@8854:     ) {
gernotbelger@8854:     	// FIXME: why is this necessary?
gernotbelger@8854:         if (artifact instanceof ChartArtifact) {
gernotbelger@8854:             facets.add(new EmptyFacet());
gernotbelger@8854:             return null;
gernotbelger@8854:         }
gernotbelger@8854:         return compute((SINFOArtifact) artifact, context, hash, facets, old);
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8854:     @Override
gernotbelger@8854:     public Object computeAdvance(
gernotbelger@8854:     	final D4EArtifact artifact,
gernotbelger@8854:     	final String       hash,
gernotbelger@8854:     	final CallContext  context,
gernotbelger@8854:     	final List<Facet>  facets,
gernotbelger@8854:     	final Object       old
gernotbelger@8854:     ) {
gernotbelger@8854:         if (artifact instanceof ChartArtifact) {
gernotbelger@8854:             facets.add(new EmptyFacet());
gernotbelger@8854:             return null;
gernotbelger@8854:         }
gernotbelger@8854:         return compute((SINFOArtifact) artifact, context, hash, facets, old);
gernotbelger@8854:     }
gernotbelger@8854:     
gernotbelger@8854:     /**
gernotbelger@8854:      * Compute result or returned object from cache, create facets.
gernotbelger@8854:      * @param old Object that was cached.
gernotbelger@8854:      */
gernotbelger@8854:     private Object compute(
gernotbelger@8854:     	final SINFOArtifact sinfo,
gernotbelger@8854:         final CallContext   context,
gernotbelger@8854:         final String        hash,
gernotbelger@8854:         final List<Facet>   facets,
gernotbelger@8854:         final Object        old
gernotbelger@8854:     ) {
gernotbelger@8854:         final CalculationResult res;
gernotbelger@8854: 		if (old instanceof CalculationResult)
gernotbelger@8854: 			res = (CalculationResult) old;
gernotbelger@8854: 		else
gernotbelger@8854: 			res = new FlowDepthCalculation(context).calculate(sinfo);
gernotbelger@8854: 
gernotbelger@8854:         if (facets == null) {
gernotbelger@8854:             return res;
gernotbelger@8854:         }
gernotbelger@8854: 
gernotbelger@8854:         final FlowDepthCalculationResults results =  (FlowDepthCalculationResults) res.getData();
gernotbelger@8854: 
gernotbelger@8854:         /* add themes for chart, for each result */
gernotbelger@8854:         final List<FlowDepthCalculationResult> resultList = results.getResults();
gernotbelger@8854:         for (int index = 0; index < resultList.size(); index++) {
gernotbelger@8854: 
gernotbelger@8854: 			final FlowDepthCalculationResult result = resultList.get(index);
gernotbelger@8854: 			
gernotbelger@8854: 			/* filtered (zoom dependent mean) flow depth */
gernotbelger@8877: 			final String facetFlowDepthFilteredDescription = Resources.getMsg( context.getMeta(), I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION, I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION, result.getLabel() );
gernotbelger@8854: 			facets.add(new FlowDepthFilterFacet(
gernotbelger@8854: 			        index,
gernotbelger@8854: 			        FlowDepthProcessor.FACET_FLOW_DEPTH_FILTERED,
gernotbelger@8854: 			        facetFlowDepthFilteredDescription,
gernotbelger@8854: 			        ComputeType.ADVANCE,
gernotbelger@8854: 			        id,
gernotbelger@8854: 			        hash
gernotbelger@8854: 			    ));
gernotbelger@8854: 			
gernotbelger@8854: 			// FIXME: add other themes
gernotbelger@8854: 		}
gernotbelger@8854: 
gernotbelger@8854:         if (!resultList.isEmpty() ) {
gernotbelger@8854:             Facet csv = new DataFacet(
gernotbelger@8854:                 FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, id);
gernotbelger@8854:             Facet pdf = new DataFacet(
gernotbelger@8854:             		FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, id);
gernotbelger@8854: 
gernotbelger@8854:             facets.add(csv);
gernotbelger@8854:             facets.add(pdf);
gernotbelger@8854:         }
gernotbelger@8854: 
gernotbelger@8854:         final Calculation report = res.getReport();
gernotbelger@8854: 
gernotbelger@8854:         if (report.hasProblems()) {
gernotbelger@8854:             facets.add(new ReportFacet(ComputeType.ADVANCE, hash, id));
gernotbelger@8854:         }
gernotbelger@8854: 
gernotbelger@8854:         return res;
gernotbelger@8854:     }
gernotbelger@8854: }