teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5994:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5994:  * documentation coming with Dive4Elements River for details.
teichmann@5863:  */
teichmann@5863: 
teichmann@5831: package org.dive4elements.river.artifacts.states.fixation;
sascha@3412: 
raimund@3610: import java.text.DateFormat;
teichmann@6844: import java.util.Collection;
raimund@3610: import java.util.Date;
raimund@3610: import java.util.List;
raimund@3610: 
raimund@3610: import org.apache.log4j.Logger;
teichmann@5831: import org.dive4elements.artifactdatabase.state.Facet;
teichmann@5831: import org.dive4elements.artifactdatabase.state.FacetActivity;
teichmann@5831: import org.dive4elements.artifacts.Artifact;
teichmann@5831: import org.dive4elements.artifacts.CallContext;
teichmann@5867: import org.dive4elements.river.artifacts.D4EArtifact;
teichmann@5831: import org.dive4elements.river.artifacts.access.FixAnalysisAccess;
teichmann@5831: import org.dive4elements.river.artifacts.model.CalculationResult;
teichmann@5831: import org.dive4elements.river.artifacts.model.DataFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.DateRange;
teichmann@5831: import org.dive4elements.river.artifacts.model.FacetTypes;
teichmann@5831: import org.dive4elements.river.artifacts.model.ReportFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixAnalysisCalculation;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixAnalysisEventsFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixAnalysisPeriodsFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixAnalysisResult;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixAvSectorFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixDerivateFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixDeviationFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixLongitudinalAnalysisFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixLongitudinalAvSectorFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixLongitudinalDeviationFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixLongitudinalReferenceFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixOutlierFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixReferenceEventsFacet;
teichmann@5831: import org.dive4elements.river.artifacts.model.fixings.FixWQCurveFacet;
teichmann@5831: import org.dive4elements.river.artifacts.resources.Resources;
teichmann@5831: import org.dive4elements.river.artifacts.states.DefaultState;
teichmann@6844: import org.dive4elements.river.utils.Formatter;
teichmann@5831: import org.dive4elements.river.utils.IdGenerator;
teichmann@6865: import org.dive4elements.river.utils.UniqueDateFormatter;
sascha@3412: 
sascha@3412: /**
sascha@3412:  * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
sascha@3412:  */
gernotbelger@9082: public class FixAnalysisCompute extends DefaultState implements FacetTypes {
sascha@3412:     /** The log used in this class. */
sascha@3412:     private static Logger log = Logger.getLogger(FixAnalysisCompute.class);
sascha@3412: 
gernotbelger@9082:     private static final String I18N_REFERENCEPERIOD_SHORT = "fix.reference.period.event.short";
sascha@3412: 
sascha@3412:     private static final String I18N_ANALYSISPERIODS = "fix.analysis.periods";
sascha@3412: 
sascha@3412:     private static final String I18N_DERIVATIVE = "fix.derivative";
sascha@3412: 
sascha@3412:     private static final String I18N_OUTLIER = "fix.outlier";
sascha@3412: 
raimund@3610:     private static final String I18N_ANALYSIS = "fix.analysis.short";
sascha@3412: 
sascha@3412:     private static final String I18N_DEVIATION = "fix.deviation";
sascha@3412: 
gernotbelger@9082:     private static final String I18N_REFERENCEDEVIATION = "fix.reference.deviation";
christian@3907: 
gernotbelger@9082:     private static final String I18N_REFERENCEPERIOD = "state.fix.analysis.referenceperiod";
gernotbelger@9082: 
gernotbelger@9082:     public static final String[] SECTOR_LABELS = { "fix.mnq", "fix.mq", "fix.mhq", "fix.hq5" };
sascha@3412: 
ingo@3785:     static {
ingo@3785:         // Active/deactivate facets.
gernotbelger@9082:         FacetActivity.Registry.getInstance().register("fixanalysis", new FacetActivity() {
gernotbelger@9082:             @Override
gernotbelger@9082:             public Boolean isInitialActive(final Artifact artifact, final Facet facet, final String output) {
gernotbelger@9082:                 if (output.contains(FacetTypes.ChartType.FLSC.toString())) {
gernotbelger@9082:                     // Longitudinal section chart
gernotbelger@9082:                     final String name = facet.getName();
ingo@3785: 
gernotbelger@9082:                     if (name.contains(FacetTypes.FIX_ANALYSIS_EVENTS_DWT) || name.contains(FacetTypes.FIX_ANALYSIS_EVENTS_LS)
gernotbelger@9082:                             || name.contains(FacetTypes.FIX_ANALYSIS_EVENTS_WQ) || name.contains(FacetTypes.FIX_REFERENCE_EVENTS_DWT)
gernotbelger@9082:                             || name.contains(FacetTypes.FIX_REFERENCE_EVENTS_LS) || name.contains(FacetTypes.FIX_REFERENCE_EVENTS_WQ)) {
felix@4166:                         return Boolean.FALSE;
felix@4166:                     }
ingo@3785:                 }
gernotbelger@9082:                 if (output.contains(FacetTypes.ChartType.FDWC.toString()) && facet.getName().contains(FacetTypes.FIX_SECTOR_AVERAGE_DWT)) {
gernotbelger@9082:                     return Boolean.FALSE;
gernotbelger@9082:                 }
gernotbelger@9082: 
gernotbelger@9082:                 return Boolean.TRUE;
gernotbelger@9082:             }
gernotbelger@9082:         });
ingo@3785:     }
ingo@3785: 
sascha@3412:     /**
sascha@3412:      * The default constructor that initializes an empty State object.
sascha@3412:      */
sascha@3412:     public FixAnalysisCompute() {
sascha@3412:     }
sascha@3412: 
sascha@3412:     @Override
gernotbelger@9082:     public Object computeAdvance(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
sascha@3412:         log.debug("FixAnalysisCompute.computeAdvance");
sascha@3412: 
sascha@3412:         CalculationResult res;
sascha@3412: 
gernotbelger@9082:         final FixAnalysisAccess access = new FixAnalysisAccess(artifact);
sascha@3412: 
sascha@3412:         if (old instanceof CalculationResult) {
gernotbelger@9082:             res = (CalculationResult) old;
gernotbelger@9082:         } else {
gernotbelger@9082:             final FixAnalysisCalculation calc = new FixAnalysisCalculation(access);
sascha@3412:             res = calc.calculate();
sascha@3412:         }
sascha@3412: 
sascha@3412:         if (facets == null) {
sascha@3412:             return res;
sascha@3412:         }
sascha@3412: 
sascha@3412:         if (res.getReport().hasProblems()) {
gernotbelger@9082:             facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
sascha@3412:         }
sascha@3412: 
gernotbelger@9082:         final FixAnalysisResult fr = (FixAnalysisResult) res.getData();
sascha@3412:         if (fr == null) {
sascha@3412:             return res;
sascha@3412:         }
sascha@3412: 
gernotbelger@9082:         facets.add(new DataFacet(CSV, "CSV data", ComputeType.ADVANCE, hash, this.id));
gernotbelger@9082:         facets.add(new DataFacet(FIX_PARAMETERS, "parameters", ComputeType.ADVANCE, hash, this.id));
gernotbelger@9082:         facets.add(new DataFacet(AT, "AT data", ComputeType.ADVANCE, hash, this.id));
gernotbelger@9082:         facets.add(new DataFacet(PDF, "PDF data", ComputeType.ADVANCE, hash, this.id));
sascha@3412: 
sascha@3412:         int maxId = -100;
sascha@3412: 
gernotbelger@9082:         final int sectorMask = fr.getUsedSectorsInAnalysisPeriods();
sascha@3412: 
gernotbelger@9082:         final int qsS = access.getQSectorStart();
gernotbelger@9082:         final int qsE = access.getQSectorEnd();
sascha@3412: 
gernotbelger@9082:         final DateFormat df = Formatter.getDateFormatter(context.getMeta(), "dd.MM.yyyy");
gernotbelger@9082:         final DateFormat lf = Formatter.getDateFormatter(context.getMeta(), "dd.MM.yyyy'T'HH:mm");
gernotbelger@9082: 
gernotbelger@9082:         final DateRange[] periods = access.getAnalysisPeriods();
sascha@3412: 
sascha@3412:         for (int i = 0; i < periods.length; i++) {
gernotbelger@9082:             final DateRange period = periods[i];
gernotbelger@9082:             final String startDate = df.format(period.getFrom());
gernotbelger@9082:             final String endDate = df.format(period.getTo());
sascha@3412: 
sascha@3412:             for (int j = qsS; j <= qsE; j++) {
sascha@3412: 
sascha@3412:                 // Only emit facets for sectors that really have data.
sascha@3412:                 if ((sectorMask & (1 << j)) == 0) {
sascha@3412:                     continue;
sascha@3412:                 }
sascha@3412: 
gernotbelger@9082:                 final String sector = SECTOR_LABELS[j];
gernotbelger@9082:                 final String description = "\u0394W (" + Resources.getMsg(context.getMeta(), sector, sector) + ")";
sascha@3412: 
gernotbelger@9082:                 final int sectorNdx = j - qsS;
sascha@3412:                 int facetNdx = i << 2;
sascha@3412:                 facetNdx = facetNdx | j;
sascha@3412: 
sascha@3412:                 if (facetNdx > maxId) {
sascha@3412:                     maxId = facetNdx;
sascha@3412:                 }
sascha@3412: 
gernotbelger@9082:                 facets.add(new FixAvSectorFacet(facetNdx, FIX_SECTOR_AVERAGE_DWT + "_" + sectorNdx, description));
sascha@3412:                 facets.add(
gernotbelger@9082:                         new FixLongitudinalAvSectorFacet(facetNdx, FIX_SECTOR_AVERAGE_LS + "_" + sectorNdx, description + ":" + startDate + " - " + endDate));
sascha@3412:                 // TODO: i18n
gernotbelger@9082:                 final String dev = "Abweichung: " + description;
gernotbelger@9082:                 facets.add(new FixLongitudinalAvSectorFacet(facetNdx, FIX_SECTOR_AVERAGE_LS_DEVIATION + "_" + sectorNdx, dev));
gernotbelger@9082:                 facets.add(new FixAvSectorFacet(facetNdx, FIX_SECTOR_AVERAGE_WQ + "_" + sectorNdx, description));
sascha@3412: 
sascha@3412:             }
sascha@3412: 
gernotbelger@9082:             final String eventDesc = Resources.getMsg(context.getMeta(), I18N_ANALYSIS, I18N_ANALYSIS);
raimund@3610: 
gernotbelger@9082:             final Collection<Date> aeds = fr.getAnalysisEventsDates(i);
gernotbelger@9082:             final UniqueDateFormatter cf = new UniqueDateFormatter(df, lf, aeds);
teichmann@6844: 
raimund@3610:             int k = 0;
gernotbelger@9082:             for (final Date d : aeds) {
raimund@3610:                 int anaNdx = i << 8;
raimund@3610:                 anaNdx = anaNdx | k;
gernotbelger@9082:                 facets.add(new FixAnalysisEventsFacet(anaNdx, FIX_ANALYSIS_EVENTS_DWT, eventDesc + (i + 1) + " - " + cf.format(d)));
gernotbelger@9082:                 facets.add(new FixLongitudinalAnalysisFacet(anaNdx, FIX_ANALYSIS_EVENTS_LS, eventDesc + (i + 1) + " - " + cf.format(d)));
gernotbelger@9082:                 facets.add(new FixAnalysisEventsFacet(anaNdx, FIX_ANALYSIS_EVENTS_WQ, eventDesc + (i + 1) + " - " + cf.format(d)));
raimund@3610:                 k++;
raimund@3610:             }
sascha@3412:         }
sascha@3412: 
gernotbelger@9082:         final IdGenerator idg = new IdGenerator(maxId + 1);
sascha@3412: 
gernotbelger@9082:         final String i18n_ref = Resources.getMsg(context.getMeta(), I18N_REFERENCEPERIOD_SHORT, I18N_REFERENCEPERIOD_SHORT);
gernotbelger@9082:         final String i18n_dev = Resources.getMsg(context.getMeta(), I18N_REFERENCEDEVIATION, I18N_REFERENCEDEVIATION);
sascha@3412: 
gernotbelger@9082:         final Collection<Date> reds = fr.getReferenceEventsDates();
gernotbelger@9082:         final UniqueDateFormatter cf = new UniqueDateFormatter(df, lf, reds);
teichmann@6844: 
raimund@3610:         int i = 0;
gernotbelger@9082:         for (final Date d : reds) {
raimund@3610:             int refNdx = idg.next() << 8;
gernotbelger@9082:             refNdx |= i;
gernotbelger@9082:             facets.add(new FixReferenceEventsFacet(refNdx, FIX_REFERENCE_EVENTS_DWT, i18n_ref + " - " + cf.format(d)));
raimund@3610:             refNdx = idg.next() << 8;
raimund@3610:             refNdx = refNdx | i;
gernotbelger@9082:             facets.add(new FixLongitudinalReferenceFacet(refNdx, FIX_REFERENCE_EVENTS_LS, i18n_ref + " - " + cf.format(d)));
raimund@3610:             refNdx = idg.next() << 8;
raimund@3610:             refNdx |= i;
gernotbelger@9082:             facets.add(new FixReferenceEventsFacet(refNdx, FIX_REFERENCE_EVENTS_WQ, i18n_ref + " - " + cf.format(d)));
raimund@3610:             i++;
raimund@3610:         }
sascha@3412: 
gernotbelger@9082:         facets.add(new FixLongitudinalDeviationFacet(idg.next(), FIX_DEVIATION_LS, i18n_dev));
sascha@3412: 
gernotbelger@9082:         final String i18n_ana = Resources.getMsg(context.getMeta(), I18N_ANALYSISPERIODS, I18N_ANALYSISPERIODS);
gernotbelger@9082:         facets.add(new FixAnalysisPeriodsFacet(idg.next(), FIX_ANALYSIS_PERIODS_DWT, i18n_ana));
gernotbelger@9082:         facets.add(new FixAnalysisPeriodsFacet(idg.next(), FIX_ANALYSIS_PERIODS_LS, i18n_ana));
gernotbelger@9082:         facets.add(new FixAnalysisPeriodsFacet(idg.next(), FIX_ANALYSIS_PERIODS_WQ, i18n_ana));
sascha@3412: 
gernotbelger@9082:         final String i18n_refp = Resources.getMsg(context.getMeta(), I18N_REFERENCEPERIOD, I18N_REFERENCEPERIOD);
gernotbelger@9082:         facets.add(new DataFacet(idg.next(), FIX_REFERENCE_PERIOD_DWT, i18n_refp, ComputeType.ADVANCE, null, null));
sascha@3412: 
sascha@3412:         facets.add(new FixWQCurveFacet(idg.next(), "W/Q"));
sascha@3412: 
gernotbelger@9082:         final Boolean preprocessing = access.getPreprocessing();
sascha@3412: 
sascha@3412:         if (preprocessing != null && preprocessing) {
gernotbelger@9082:             facets.add(new FixOutlierFacet(idg.next(), FIX_OUTLIER, Resources.getMsg(context.getMeta(), I18N_OUTLIER, I18N_OUTLIER)));
sascha@3412:         }
sascha@3412: 
gernotbelger@9082:         facets.add(new FixDerivateFacet(idg.next(), FIX_DERIVATE_CURVE, Resources.getMsg(context.getMeta(), I18N_DERIVATIVE, I18N_DERIVATIVE)));
sascha@3412: 
gernotbelger@9082:         facets.add(new FixDeviationFacet(idg.next(), FIX_DEVIATION_DWT, Resources.getMsg(context.getMeta(), I18N_DEVIATION, I18N_DEVIATION)));
sascha@3412:         return res;
sascha@3412:     }
sascha@3412: }
sascha@3412: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :