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;
teichmann@6844: import java.util.HashMap;
raimund@3610: import java.util.List;
teichmann@6844: import java.util.Map;
raimund@3610: 
raimund@3610: import org.apache.log4j.Logger;
raimund@3610: 
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;
sascha@3412: 
sascha@3412: /**
sascha@3412:  * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
sascha@3412:  */
sascha@3412: public class FixAnalysisCompute
sascha@3412: extends      DefaultState
sascha@3412: implements   FacetTypes
sascha@3412: {
sascha@3412:     /** The log used in this class. */
sascha@3412:     private static Logger log = Logger.getLogger(FixAnalysisCompute.class);
sascha@3412: 
christian@3907:     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: 
sascha@3412:     private static final String I18N_REFERENCEDEVIATION = "fix.reference.deviation";
sascha@3412: 
christian@3907:     private static final String I18N_REFERENCEPERIOD = "state.fix.analysis.referenceperiod";
christian@3907: 
sascha@3412:     public static final String [] SECTOR_LABELS = {
rrenkert@5380:         "fix.mnq",
rrenkert@5380:         "fix.mq",
rrenkert@5380:         "fix.mhq",
rrenkert@5380:         "fix.hq5"
sascha@3412:     };
sascha@3412: 
ingo@3785:     static {
ingo@3785:         // Active/deactivate facets.
ingo@3785:         FacetActivity.Registry.getInstance().register(
ingo@3785:             "fixanalysis",
ingo@3785:             new FacetActivity() {
ingo@3785:                 @Override
ingo@3785:                 public Boolean isInitialActive(
ingo@3785:                     Artifact artifact,
ingo@3785:                     Facet    facet,
ingo@3785:                     String   output
ingo@3785:                 ) {
felix@4166:                     if (output.contains(FacetTypes.ChartType.FLSC.toString())) {
felix@4166:                         // Longitudinal section chart
christian@3913:                         String name = facet.getName();
ingo@3785: 
christian@3913:                         if (name.contains(FacetTypes.FIX_ANALYSIS_EVENTS_DWT)
christian@3913:                          || name.contains(FacetTypes.FIX_ANALYSIS_EVENTS_LS)
christian@3913:                          || name.contains(FacetTypes.FIX_ANALYSIS_EVENTS_WQ)
christian@3913:                          || name.contains(FacetTypes.FIX_REFERENCE_EVENTS_DWT)
christian@3913:                          || name.contains(FacetTypes.FIX_REFERENCE_EVENTS_LS)
christian@3913:                          || name.contains(FacetTypes.FIX_REFERENCE_EVENTS_WQ)
christian@3913:                         ) {
christian@3913:                             return Boolean.FALSE;
christian@3913:                         }
ingo@3785:                     }
felix@4433:                     if (output.contains(FacetTypes.ChartType.FDWC.toString())
felix@4166:                         && facet.getName().contains(FacetTypes.FIX_SECTOR_AVERAGE_DWT)) {
felix@4166:                         return Boolean.FALSE;
felix@4166:                     }
ingo@3785: 
ingo@3785:                     return Boolean.TRUE;
ingo@3785:                 }
ingo@3785:             });
ingo@3785:     }
ingo@3785: 
felix@5646: 
sascha@3412:     /**
sascha@3412:      * The default constructor that initializes an empty State object.
sascha@3412:      */
sascha@3412:     public FixAnalysisCompute() {
sascha@3412:     }
sascha@3412: 
felix@5646: 
sascha@3412:     @Override
sascha@3412:     public Object computeAdvance(
teichmann@5867:         D4EArtifact artifact,
sascha@3412:         String       hash,
sascha@3412:         CallContext  context,
sascha@3412:         List<Facet>  facets,
sascha@3412:         Object       old
sascha@3412:     ) {
sascha@3412:         log.debug("FixAnalysisCompute.computeAdvance");
sascha@3412: 
sascha@3412:         CalculationResult res;
sascha@3412: 
teichmann@6101:         FixAnalysisAccess access = new FixAnalysisAccess(artifact);
sascha@3412: 
sascha@3412:         if (old instanceof CalculationResult) {
sascha@3412:             res = (CalculationResult)old;
sascha@3412:         }
sascha@3412:         else {
sascha@3412:             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()) {
sascha@3412:             facets.add(new ReportFacet(ComputeType.ADVANCE, hash, id));
sascha@3412:         }
sascha@3412: 
sascha@3415:         FixAnalysisResult fr = (FixAnalysisResult)res.getData();
sascha@3412:         if (fr == null) {
sascha@3412:             return res;
sascha@3412:         }
sascha@3412: 
sascha@3412:         facets.add(
sascha@3412:             new DataFacet(CSV, "CSV data", ComputeType.ADVANCE, hash, id));
sascha@3412:         facets.add(
sascha@3412:             new DataFacet(
sascha@3412:                 FIX_PARAMETERS, "parameters", ComputeType.ADVANCE, hash, id));
raimund@3599:         facets.add(
raimund@3599:             new DataFacet(AT, "AT data", ComputeType.ADVANCE, hash, id));
sascha@3412: 
sascha@3412:         int maxId = -100;
sascha@3412: 
sascha@3412:         int sectorMask = fr.getUsedSectorsInAnalysisPeriods();
sascha@3412: 
sascha@3412:         int qsS = access.getQSectorStart();
sascha@3412:         int qsE = access.getQSectorEnd();
sascha@3412: 
teichmann@6844:         DateFormat df = Formatter.getDateFormatter(context.getMeta(), "dd.MM.yyyy");
teichmann@6844:         DateFormat lf = Formatter.getDateFormatter(context.getMeta(), "dd.MM.yyy'T'HH:mm");
sascha@3412: 
sascha@3412:         DateRange [] periods = access.getAnalysisPeriods();
sascha@3412: 
sascha@3412:         for (int i = 0; i < periods.length; i++) {
sascha@3412:             DateRange period = periods[i];
sascha@3412:             String startDate = df.format(period.getFrom());
teichmann@6844:             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: 
sascha@3412:                 String sector = SECTOR_LABELS[j];
rrenkert@5380:                 String description = "\u0394W (" +
rrenkert@5380:                     Resources.getMsg(context.getMeta(),
rrenkert@5380:                         sector,
rrenkert@5380:                         sector) +
rrenkert@5380:                         ")";
sascha@3412: 
sascha@3412:                 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: 
sascha@3412:                 facets.add(
sascha@3412:                     new FixAvSectorFacet(
sascha@3412:                         facetNdx,
sascha@3412:                         FIX_SECTOR_AVERAGE_DWT + "_" + sectorNdx,
sascha@3412:                         description));
sascha@3412:                 facets.add(
raimund@3610:                     new FixLongitudinalAvSectorFacet(
sascha@3412:                         facetNdx,
sascha@3412:                         FIX_SECTOR_AVERAGE_LS + "_" + sectorNdx,
rrenkert@5380:                         description + ":" + startDate + " - " + endDate));
sascha@3412:                 // TODO: i18n
sascha@3412:                 String dev = "Abweichung: " + description;
sascha@3412:                 facets.add(
raimund@3610:                     new FixLongitudinalAvSectorFacet(
sascha@3412:                         facetNdx,
sascha@3412:                         FIX_SECTOR_AVERAGE_LS_DEVIATION + "_" + sectorNdx,
sascha@3412:                         dev));
sascha@3412:                 facets.add(
sascha@3412:                     new FixAvSectorFacet(
sascha@3412:                         facetNdx,
sascha@3412:                         FIX_SECTOR_AVERAGE_WQ + "_" + sectorNdx,
sascha@3412:                         description));
sascha@3412: 
sascha@3412:             }
sascha@3412: 
sascha@3412:             String eventDesc =
sascha@3412:                 Resources.getMsg(context.getMeta(),
sascha@3412:                                  I18N_ANALYSIS,
raimund@3610:                                  I18N_ANALYSIS);
raimund@3610: 
teichmann@6844:             Collection<Date> aeds = fr.getAnalysisEventsDates(i);
teichmann@6844:             UniqueDateFormatter cf = new UniqueDateFormatter(df, lf, aeds);
teichmann@6844: 
raimund@3610:             int k = 0;
teichmann@6844:             for (Date d: aeds) {
raimund@3610:                 int anaNdx = i << 8;
raimund@3610:                 anaNdx = anaNdx | k;
raimund@3610:                 facets.add(new FixAnalysisEventsFacet(anaNdx,
raimund@3610:                     FIX_ANALYSIS_EVENTS_DWT,
teichmann@6844:                     eventDesc + (i+1) + " - " + cf.format(d)));
raimund@3610:                 facets.add(new FixLongitudinalAnalysisFacet(anaNdx,
raimund@3610:                     FIX_ANALYSIS_EVENTS_LS,
teichmann@6844:                     eventDesc + (i+1) + " - " + cf.format(d)));
raimund@3610:                 facets.add(new FixAnalysisEventsFacet(anaNdx,
raimund@3610:                     FIX_ANALYSIS_EVENTS_WQ,
teichmann@6844:                     eventDesc + (i+1) +" - " + cf.format(d)));
raimund@3610:                 k++;
raimund@3610:             }
sascha@3412:         }
sascha@3412: 
sascha@3412:         IdGenerator idg = new IdGenerator(maxId + 1);
sascha@3412: 
sascha@3412:         String i18n_ref = Resources.getMsg(context.getMeta(),
christian@3907:                 I18N_REFERENCEPERIOD_SHORT,
christian@3907:                 I18N_REFERENCEPERIOD_SHORT);
sascha@3412:         String i18n_dev = Resources.getMsg(context.getMeta(),
sascha@3412:                 I18N_REFERENCEDEVIATION,
sascha@3412:                 I18N_REFERENCEDEVIATION);
sascha@3412: 
teichmann@6844:         Collection<Date> reds = fr.getReferenceEventsDates();
teichmann@6844:         UniqueDateFormatter cf = new UniqueDateFormatter(df, lf, reds);
teichmann@6844: 
raimund@3610:         int i = 0;
teichmann@6844:         for (Date d: reds) {
raimund@3610:             int refNdx = idg.next() << 8;
raimund@3610:             refNdx |=  i;
raimund@3610:             facets.add(new FixReferenceEventsFacet(refNdx,
raimund@3610:                 FIX_REFERENCE_EVENTS_DWT,
teichmann@6844:                 i18n_ref + " - " + cf.format(d)));
raimund@3610:             refNdx = idg.next() << 8;
raimund@3610:             refNdx = refNdx | i;
raimund@3610:             facets.add(new FixLongitudinalReferenceFacet(refNdx,
raimund@3610:                 FIX_REFERENCE_EVENTS_LS,
teichmann@6844:                 i18n_ref + " - " + cf.format(d)));
raimund@3610:             refNdx = idg.next() << 8;
raimund@3610:             refNdx |= i;
raimund@3610:             facets.add(new FixReferenceEventsFacet(refNdx,
raimund@3610:                 FIX_REFERENCE_EVENTS_WQ,
teichmann@6844:                 i18n_ref + " - " + cf.format(d)));
raimund@3610:             i++;
raimund@3610:         }
sascha@3412: 
sascha@3412:         facets.add(new FixLongitudinalDeviationFacet(idg.next(),
sascha@3412:             FIX_DEVIATION_LS,
sascha@3412:             i18n_dev));
sascha@3412: 
sascha@3412:         String i18n_ana = Resources.getMsg(context.getMeta(),
sascha@3412:                 I18N_ANALYSISPERIODS,
sascha@3412:                 I18N_ANALYSISPERIODS);
sascha@3412:         facets.add(new FixAnalysisPeriodsFacet(idg.next(),
sascha@3412:             FIX_ANALYSIS_PERIODS_DWT,
sascha@3412:             i18n_ana));
sascha@3412:         facets.add(new FixAnalysisPeriodsFacet(idg.next(),
sascha@3412:             FIX_ANALYSIS_PERIODS_LS,
sascha@3412:             i18n_ana));
sascha@3412:         facets.add(new FixAnalysisPeriodsFacet(idg.next(),
sascha@3412:             FIX_ANALYSIS_PERIODS_WQ,
sascha@3412:             i18n_ana));
sascha@3412: 
christian@3907:         String i18n_refp = Resources.getMsg(context.getMeta(),
christian@3907:                 I18N_REFERENCEPERIOD,
christian@3907:                 I18N_REFERENCEPERIOD);
christian@3907:         facets.add(new DataFacet(idg.next(),
christian@3907:             FIX_REFERENCE_PERIOD_DWT,
christian@3907:             i18n_refp,
christian@3907:             ComputeType.ADVANCE, null, null));
sascha@3412: 
sascha@3412:         facets.add(new FixWQCurveFacet(idg.next(), "W/Q"));
sascha@3412: 
sascha@3412:         Boolean preprocessing = access.getPreprocessing();
sascha@3412: 
sascha@3412:         if (preprocessing != null && preprocessing) {
sascha@3412:             facets.add(new FixOutlierFacet(
sascha@3412:                 idg.next(),
sascha@3412:                 FIX_OUTLIER,
sascha@3412:                 Resources.getMsg(
sascha@3412:                     context.getMeta(), I18N_OUTLIER, I18N_OUTLIER)));
sascha@3412:         }
sascha@3412: 
sascha@3412:         facets.add(new FixDerivateFacet(
sascha@3412:             idg.next(),
christian@3917:             FIX_DERIVATE_CURVE,
sascha@3412:             Resources.getMsg(
sascha@3412:                 context.getMeta(),
sascha@3412:                 I18N_DERIVATIVE,
sascha@3412:                 I18N_DERIVATIVE)));
sascha@3412: 
sascha@3412:         facets.add(new FixDeviationFacet(
sascha@3412:             idg.next(),
sascha@3412:             FIX_DEVIATION_DWT,
sascha@3412:             Resources.getMsg(context.getMeta(),
sascha@3412:                 I18N_DEVIATION,
sascha@3412:                 I18N_DEVIATION)));
sascha@3412:         return res;
sascha@3412:     }
teichmann@6844: 
teichmann@6844:     /** Little hack to format dates unique if they collide. */
teichmann@6844:     private static class UniqueDateFormatter {
teichmann@6844: 
teichmann@6844:         private DateFormat df;
teichmann@6844:         private DateFormat lf;
teichmann@6844:         private Map<String, int[]> collisions;
teichmann@6844: 
teichmann@6844:         UniqueDateFormatter(
teichmann@6844:             DateFormat df,
teichmann@6844:             DateFormat lf,
teichmann@6844:             Collection<Date> dates
teichmann@6844:         ) {
teichmann@6844:             this.df = df;
teichmann@6844:             this.lf = lf;
teichmann@6844:             collisions = build(dates);
teichmann@6844:         }
teichmann@6844: 
teichmann@6844:         private Map<String, int []> build(Collection<Date> dates) {
teichmann@6844:             Map<String, int []> collisions = new HashMap<String, int[]>();
teichmann@6844:             for (Date d: dates) {
teichmann@6844:                 String s = df.format(d);
teichmann@6844:                 int [] count = collisions.get(s);
teichmann@6844:                 if (count == null) {
teichmann@6844:                     collisions.put(s, count = new int[1]);
teichmann@6844:                 }
teichmann@6844:                 if (++count[0] > 1) {
teichmann@6844:                     log.debug("date collsion found: " + d);
teichmann@6844:                 }
teichmann@6844:             }
teichmann@6844:             return collisions;
teichmann@6844:         }
teichmann@6844: 
teichmann@6844:         String format(Date date) {
teichmann@6844:             String s = df.format(date);
teichmann@6844:             int [] count = collisions.get(s);
teichmann@6844:             return count == null || count[0] < 2
teichmann@6844:                 ? s
teichmann@6844:                 : lf.format(date);
teichmann@6844:         }
teichmann@6844:     } // class UniqueDateFormatter
sascha@3412: }
sascha@3412: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :