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;
ingo@2709: 
rrenkert@7823: import java.text.NumberFormat;
ingo@2712: import java.util.ArrayList;
ingo@2712: import java.util.List;
ingo@2712: 
ingo@2709: import org.apache.log4j.Logger;
ingo@2709: 
teichmann@5831: import org.dive4elements.artifacts.Artifact;
teichmann@5831: import org.dive4elements.artifacts.CallContext;
ingo@2709: 
teichmann@5831: import org.dive4elements.artifacts.common.model.KVP;
rrenkert@7823: import org.dive4elements.artifacts.common.utils.XMLUtils;
rrenkert@7823: import org.dive4elements.artifacts.common.utils.XMLUtils.ElementCreator;
ingo@2712: 
teichmann@5831: import org.dive4elements.river.model.BedHeightEpoch;
teichmann@5831: import org.dive4elements.river.model.BedHeightSingle;
teichmann@5831: import org.dive4elements.river.model.River;
teichmann@5831: 
teichmann@5867: import org.dive4elements.river.artifacts.D4EArtifact;
rrenkert@7823: import org.dive4elements.river.artifacts.resources.Resources;
rrenkert@7823: import org.dive4elements.river.utils.Formatter;
teichmann@5865: import org.dive4elements.river.utils.RiverUtils;
rrenkert@7823: import org.w3c.dom.Element;
ingo@2712: 
ingo@2709: 
rrenkert@7823: public class SoundingsSelect extends DefaultState {
ingo@2709: 
felix@3931:     public static final String SOUNDINGS = "soundings";
ingo@2709: 
ingo@2712:     public static final String PREFIX_SINGLE = "single-";
ingo@2712: 
felix@3931:     public static final String PREFIX_EPOCH = "epoch-";
ingo@2712: 
felix@3931:     /** Private logger. */
ingo@2709:     private static final Logger logger = Logger.getLogger(SoundingsSelect.class);
ingo@2709: 
ingo@2709: 
ingo@2709:     @Override
ingo@2709:     public String getUIProvider() {
ingo@2709:         return "parameter-matrix";
ingo@2709:     }
ingo@2709: 
rrenkert@7823:     @Override
rrenkert@7823:     protected void appendItems(
rrenkert@7823:         Artifact       artifact,
rrenkert@7823:         ElementCreator creator,
rrenkert@7823:         String         name,
rrenkert@7823:         CallContext    context,
rrenkert@7823:         Element        select
rrenkert@7823:     ) {
rrenkert@7823:         try {
rrenkert@7823:             creator.addAttr(select, "type", "multiattribute", true);
ingo@2709: 
rrenkert@7823:             getOptions(artifact, name, context, creator, select);
rrenkert@7823:         }
rrenkert@7823:         catch (IllegalArgumentException iae) {
rrenkert@7823:             logger.warn("Illegal argument", iae);
rrenkert@7823:         }
rrenkert@7823:     }
rrenkert@7823: 
ingo@2709:     protected KVP<String, String>[] getOptions(
ingo@2709:         Artifact artifact,
ingo@3649:         String   parameterName,
rrenkert@7823:         CallContext context,
rrenkert@7823:         ElementCreator creator,
rrenkert@7823:         Element select
ingo@2709:     )
ingo@2709:     throws IllegalArgumentException
ingo@2709:     {
ingo@2709:         logger.debug("Get options for parameter: '" + parameterName + "'");
ingo@2709: 
ingo@2709:         if (!testParameterName(parameterName)) {
ingo@2709:             throw new IllegalArgumentException(
ingo@2709:                 "Invalid parameter for state: '" + parameterName + "'");
ingo@2709:         }
ingo@2709: 
teichmann@5867:         River river = RiverUtils.getRiver((D4EArtifact) artifact);
teichmann@5867:         double lo = ((D4EArtifact) artifact).getDataAsDouble("ld_from");
teichmann@5867:         double hi = ((D4EArtifact) artifact).getDataAsDouble("ld_to");
ingo@2716: 
ingo@2716:         double kmLo = Math.min(lo, hi);
ingo@2716:         double kmHi = Math.max(lo, hi);
ingo@2709: 
ingo@2712:         List<KVP<String, String>> kvp = new ArrayList<KVP<String, String>>();
ingo@2709: 
rrenkert@7823:         appendSingles(river, kmLo, kmHi, creator, select, context);
rrenkert@7823:         appendEpochs(river, kmLo, kmHi, creator, select, context);
ingo@2712: 
sascha@3452:         return kvp.toArray(new KVP[kvp.size()]);
ingo@2712:     }
ingo@2712: 
ingo@2712: 
ingo@2716:     protected void appendSingles(
ingo@2716:         River river,
ingo@2716:         double kmLo,
ingo@2716:         double kmHi,
rrenkert@7823:         ElementCreator creator,
rrenkert@7823:         Element select,
rrenkert@7823:         CallContext context
ingo@2716:     ) {
ingo@2712:         List<BedHeightSingle> singles =
ingo@2716:             BedHeightSingle.getBedHeightSingles(river, kmLo, kmHi);
ingo@3785: 
ingo@2712:         if (singles != null) {
ingo@3782:             int size = singles.size();
ingo@3785: 
ingo@3782:             logger.debug("Found " + size + " singles.");
ingo@3785: 
rrenkert@7823:             NumberFormat nf = Formatter.getCalculationKm(context.getMeta());
ingo@3782:             for (int i = 0; i < size; i++) {
ingo@2712:                 BedHeightSingle s = singles.get(i);
ingo@2712: 
ingo@2712:                 String id    = PREFIX_SINGLE + s.getId();
ingo@2712:                 String value = s.getDescription();
ingo@2712: 
rrenkert@7823:                 Element item = creator.create("item");
rrenkert@7823:                 creator.addAttr(item, "label", value, true);
rrenkert@7823:                 creator.addAttr(item, "value", id, true);
rrenkert@7823:                 creator.addAttr(item, "year", s.getYear().toString());
rrenkert@7823:                 creator.addAttr(item, "type", s.getType().getName());
rrenkert@7823:                 creator.addAttr(item, "range",
rrenkert@7823:                     nf.format(s.getRange().getA()) +
rrenkert@7823:                     " - " +
rrenkert@7823:                     nf.format(s.getRange().getB()));
rrenkert@7823:                 select.appendChild(item);
ingo@2712:             }
ingo@2709:         }
rrenkert@7823:         logger.debug("appended singles");
rrenkert@7823:         logger.debug(XMLUtils.toString(select));
ingo@2712:     }
ingo@2709: 
ingo@2712: 
ingo@2716:     protected void appendEpochs(
ingo@2716:         River river,
ingo@2716:         double kmLo,
ingo@2716:         double kmHi,
rrenkert@7823:         ElementCreator creator,
rrenkert@7823:         Element select,
rrenkert@7823:         CallContext context
ingo@2716:     ) {
ingo@2712:         List<BedHeightEpoch> epochs =
ingo@2716:             BedHeightEpoch.getBedHeightEpochs(river, kmLo, kmHi);
ingo@2712: 
ingo@2712:         if (epochs != null) {
ingo@3782:             int size = epochs.size();
ingo@3785: 
ingo@3782:             logger.debug("Found " + size + " epochs.");
ingo@3785: 
rrenkert@7823:             NumberFormat nf = Formatter.getCalculationKm(context.getMeta());
ingo@3782:             for (int i = 0; i < size; i++) {
ingo@2712:                 BedHeightEpoch e = epochs.get(i);
ingo@2712: 
ingo@2712:                 String id    = PREFIX_EPOCH + e.getId();
ingo@2712:                 String value = e.getDescription();
ingo@2712: 
rrenkert@7823:                 Element item = creator.create("item");
rrenkert@7823:                 creator.addAttr(item, "label", value, true);
rrenkert@7823:                 creator.addAttr(item, "value", id, true);
rrenkert@7823:                 creator.addAttr(item, "year", e.getTimeInterval().getStartTime().toString());
rrenkert@7823:                 creator.addAttr(item, "range",
rrenkert@7823:                     nf.format(e.getRange().getA()) +
rrenkert@7823:                     " - " +
rrenkert@7823:                     nf.format(e.getRange().getB()));
rrenkert@7823:                 select.appendChild(item);
ingo@2712:             }
ingo@2712:         }
rrenkert@7823:         logger.debug("appended epochs");
ingo@2709:     }
ingo@2709: 
rrenkert@7823:     @Override
rrenkert@7823:     protected Element createStaticData(
rrenkert@7823:         D4EArtifact   flys,
rrenkert@7823:         ElementCreator creator,
rrenkert@7823:         CallContext    cc,
rrenkert@7823:         String         name,
rrenkert@7823:         String         value,
rrenkert@7823:         String         type
rrenkert@7823:     ) {
rrenkert@7823:         Element data = creator.create("data");
rrenkert@7823:         creator.addAttr(data, "name",  name, true);
rrenkert@7823:         creator.addAttr(data, "type",  type, true);
rrenkert@7823:         creator.addAttr(data, "label",
rrenkert@7823:             Resources.getMsg(cc.getMeta(), name, name), true);
ingo@2709: 
rrenkert@7823:         String[] values = value.split(";");
rrenkert@7823: 
rrenkert@7823:         for (String val: values) {
rrenkert@7823:             Element item = creator.create("item");
rrenkert@7823:             creator.addAttr(item, "value", val, true);
rrenkert@7823:             creator.addAttr(item, "label", getLabelFor(cc, name, val), true);
rrenkert@7823: 
rrenkert@7823:             data.appendChild(item);
rrenkert@7823:         }
rrenkert@7823: 
rrenkert@7823:         return data;
rrenkert@7823:     }
rrenkert@7823: 
ingo@2709:     protected String getLabelFor(
ingo@2709:         CallContext cc,
ingo@2709:         String      parameterName,
ingo@2709:         String      value
ingo@2709:     ) throws IllegalArgumentException
ingo@2709:     {
ingo@2709:         if (!testParameterName(parameterName)) {
ingo@2709:             throw new IllegalArgumentException(
ingo@2709:                 "Invalid parameter for state: '" + parameterName + "'");
ingo@2709:         }
ingo@2709: 
ingo@2712:         if (value.indexOf(PREFIX_SINGLE) >= 0) {
ingo@2712:             return getLabelForSingle(cc, value);
ingo@2712:         }
ingo@2712:         else if (value.indexOf(PREFIX_EPOCH) >= 0) {
ingo@2712:             return getLabelForEpoch(cc, value);
ingo@2712:         }
ingo@2712: 
ingo@2712:         return value;
ingo@2712:     }
ingo@2712: 
ingo@2712: 
ingo@2712:     protected String getLabelForSingle(CallContext cc, String value) {
ingo@2712:         String id = value.replace(PREFIX_SINGLE, "");
ingo@2712:         try {
ingo@2712:             BedHeightSingle s = BedHeightSingle.getBedHeightSingleById(
ingo@2712:                 Integer.parseInt(id));
ingo@2712: 
ingo@2712:             if (s != null) {
ingo@2712:                 return s.getDescription();
ingo@2712:             }
ingo@2712:             else {
ingo@2712:                 return "no value for '" + id + "'";
ingo@2712:             }
ingo@2712:         }
ingo@2712:         catch (NumberFormatException nfe) {
ingo@2712:             logger.warn("Could not parse id from string '" + id + "'", nfe);
ingo@2712:         }
ingo@2712: 
ingo@2712:         return "n.A.";
ingo@2712:     }
ingo@2712: 
ingo@2712: 
ingo@2712:     protected String getLabelForEpoch(CallContext cc, String value) {
ingo@2712:         String id = value.replace(PREFIX_EPOCH, "");
ingo@2712:         try {
ingo@2712:             BedHeightEpoch e = BedHeightEpoch.getBedHeightEpochById(
ingo@2712:                 Integer.parseInt(id));
ingo@2712: 
ingo@2712:             if (e != null) {
ingo@2712:                 return e.getDescription();
ingo@2712:             }
ingo@2712:             else {
ingo@2712:                 return "no value for '" + id + "'";
ingo@2712:             }
ingo@2712:         }
ingo@2712:         catch (NumberFormatException nfe) {
ingo@2712:             logger.warn("Could not parse id from string '" + id + "'", nfe);
ingo@2712:         }
ingo@2712: 
ingo@2712:         return "n.A.";
ingo@2709:     }
ingo@2709: 
ingo@2709: 
ingo@2709:     /**
ingo@2709:      * This method might be used to test, if a parameter name is handled by this
ingo@2709:      * state.
ingo@2709:      *
ingo@2709:      * @param parameterName The name of a parameter.
ingo@2709:      *
ingo@2709:      * @return true, if parameterName is one of <i>MAIN_CHANNEL</i> or
ingo@2709:      * <i>TOTAL_CHANNEL</i>. Otherwise false.
ingo@2709:      */
ingo@2709:     protected boolean testParameterName(String parameterName) {
ingo@2709:         if (parameterName == null || parameterName.length() == 0) {
ingo@2709:             return false;
ingo@2709:         }
ingo@2709:         else if (parameterName.equals(SOUNDINGS)) {
ingo@2709:             return true;
ingo@2709:         }
ingo@2709:         else {
ingo@2709:             return false;
ingo@2709:         }
ingo@2709:     }
ingo@2709: }
sascha@3083: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :