teichmann@5861: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5861:  * Software engineering by Intevation GmbH
teichmann@5861:  *
teichmann@5993:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5861:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5993:  * documentation coming with Dive4Elements River for details.
teichmann@5861:  */
teichmann@5861: 
teichmann@5835: package org.dive4elements.river.client.server;
ingo@1571: 
teichmann@8071: import java.util.Collections;
rrenkert@7824: import java.util.HashMap;
teichmann@8071: import java.util.Map;
rrenkert@7824: 
ingo@1571: import javax.xml.xpath.XPathConstants;
ingo@1571: 
ingo@1571: import org.apache.log4j.Logger;
teichmann@5835: import org.dive4elements.artifacts.common.ArtifactNamespaceContext;
teichmann@5835: import org.dive4elements.artifacts.common.utils.XMLUtils;
teichmann@5835: import org.dive4elements.river.client.shared.model.Data;
teichmann@5835: import org.dive4elements.river.client.shared.model.DataItem;
teichmann@5835: import org.dive4elements.river.client.shared.model.DefaultData;
teichmann@5835: import org.dive4elements.river.client.shared.model.DefaultDataItem;
teichmann@5835: import org.dive4elements.river.client.shared.model.DoubleArrayData;
gernotbelger@9074: import org.dive4elements.river.client.shared.model.IntDataItem;
teichmann@5835: import org.dive4elements.river.client.shared.model.IntegerArrayData;
teichmann@5835: import org.dive4elements.river.client.shared.model.IntegerData;
teichmann@5835: import org.dive4elements.river.client.shared.model.IntegerOptionsData;
teichmann@5835: import org.dive4elements.river.client.shared.model.IntegerRangeData;
gernotbelger@9074: import org.dive4elements.river.client.shared.model.LongRangeData;
rrenkert@7824: import org.dive4elements.river.client.shared.model.MultiAttributeData;
rrenkert@7824: import org.dive4elements.river.client.shared.model.MultiDataItem;
teichmann@5835: import org.dive4elements.river.client.shared.model.StringData;
teichmann@5835: import org.dive4elements.river.client.shared.model.StringOptionsData;
gernotbelger@9074: import org.w3c.dom.Attr;
gernotbelger@9074: import org.w3c.dom.Element;
gernotbelger@9074: import org.w3c.dom.NamedNodeMap;
gernotbelger@9074: import org.w3c.dom.Node;
gernotbelger@9074: import org.w3c.dom.NodeList;
ingo@1571: 
ingo@1571: /**
ingo@1571:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@1571:  */
ingo@1571: public class DataFactory {
ingo@1571: 
teichmann@8203:     private static final Logger log = Logger.getLogger(DataFactory.class);
ingo@1571: 
ingo@1571:     public static final String NS_URI = ArtifactNamespaceContext.NAMESPACE_URI;
ingo@1571: 
ingo@1571:     /**
ingo@1571:      * Creates a new Data instance based on the <i>art:type</i> attribute of
ingo@1571:      * <i>element</i>.
ingo@1571:      *
gernotbelger@9074:      * @param element
gernotbelger@9074:      *            The Data element.
ingo@1571:      *
ingo@1571:      * @return a Data instance.
ingo@1571:      */
gernotbelger@9074:     public static Data createDataFromElement(final Element element) {
gernotbelger@9074:         final String name = element.getAttributeNS(NS_URI, "name");
gernotbelger@9074:         String type = element.getAttributeNS(NS_URI, "type");
ingo@2528:         String label = element.getAttributeNS(NS_URI, "label");
ingo@2528: 
ingo@2528:         label = label != null && label.length() > 0 ? label : name;
ingo@1571: 
ingo@1575:         try {
teichmann@8203:             log.debug("Create Data instance for: " + name + " | " + type);
ingo@1571: 
ingo@1575:             if (type == null || type.length() == 0) {
ingo@2528:                 return createDefaultData(element, name, label);
ingo@1575:             }
ingo@1575: 
ingo@1575:             type = type.toLowerCase();
ingo@1575: 
ingo@1575:             if (type.equals(StringData.TYPE)) {
ingo@2528:                 return createStringData(element, name, label);
gernotbelger@9074:             } else if (type.equals(IntegerData.TYPE)) {
ingo@2528:                 return createIntegerData(element, name, label);
gernotbelger@9074:             } else if (type.equals(StringOptionsData.TYPE)) {
ingo@2532:                 return createStringOptionsData(element, name, label);
gernotbelger@9074:             } else if (type.equals(IntegerOptionsData.TYPE)) {
ingo@2528:                 return createIntegerOptionsData(element, name, label);
gernotbelger@9074:             } else if (type.equals(IntegerRangeData.TYPE)) {
ingo@2528:                 return createIntegerRangeData(element, name, label);
gernotbelger@9074:             } else if (type.equals(IntegerArrayData.TYPE)) {
ingo@2528:                 return createIntegerArrayData(element, name, label);
gernotbelger@9074:             } else if (type.equals(DoubleArrayData.TYPE)) {
ingo@2528:                 return createDoubleArrayData(element, name, label);
gernotbelger@9074:             } else if (type.equals(LongRangeData.TYPE)) {
ingo@2528:                 return createLongRangeData(element, name, label);
gernotbelger@9074:             } else if (type.equals(MultiAttributeData.TYPE)) {
rrenkert@7824:                 return createMultiAttributeData(element, name, label);
gernotbelger@9074:             } else {
ingo@2528:                 return createDefaultData(element, name, label);
ingo@1575:             }
ingo@1571:         }
gernotbelger@9074:         catch (final Exception e) {
teichmann@8203:             log.error("Error while data creation for: " + name);
ingo@1571:         }
ingo@1575: 
ingo@1575:         return null;
ingo@1571:     }
ingo@1571: 
gernotbelger@9074:     public static Data createMultiAttributeData(final Element element, final String name, final String label) {
gernotbelger@9074:         return new MultiAttributeData(name, label, extractMultiDataItems(element), extractMeta(element));
teichmann@8071:     }
teichmann@8071: 
gernotbelger@9074:     private static Map<String, Map<String, String>> extractMeta(final Element element) {
gernotbelger@9074:         final NodeList nl = element.getElementsByTagName("art:meta");
gernotbelger@9074:         final int N = nl.getLength();
gernotbelger@9074:         if (N != 1) {
gernotbelger@9074:             log.debug("No or too much meta data found for multi attribute data");
teichmann@8071:             return Collections.<String, Map<String, String>>emptyMap();
teichmann@8071:         }
gernotbelger@9074:         final Map<String, Map<String, String>> map = new HashMap<String, Map<String, String>>();
teichmann@8071: 
gernotbelger@9074:         final Element metaElement = (Element) nl.item(0);
gernotbelger@9074:         final NodeList metaChildren = metaElement.getChildNodes();
gernotbelger@9074: 
gernotbelger@9074:         for (int i = 0; i < metaChildren.getLength(); ++i) {
gernotbelger@9074: 
gernotbelger@9074:             final Node childNode = metaChildren.item(i);
gernotbelger@9074:             if (childNode instanceof Element) {
gernotbelger@9074: 
gernotbelger@9074:                 final Element e = (Element) childNode;
gernotbelger@9074:                 final NamedNodeMap attrs = e.getAttributes();
gernotbelger@9074:                 final Map<String, String> kvs = new HashMap<String, String>();
gernotbelger@9074:                 for (int j = 0, A = attrs.getLength(); j < A; ++j) {
gernotbelger@9074:                     final Attr attr = (Attr) attrs.item(j);
gernotbelger@9074:                     kvs.put(attr.getName(), attr.getValue());
gernotbelger@9074:                 }
gernotbelger@9074:                 map.put(e.getLocalName(), kvs);
teichmann@8071:             }
teichmann@8071:         }
teichmann@8071: 
teichmann@8071:         return map;
rrenkert@7824:     }
rrenkert@7824: 
gernotbelger@9074:     protected static DataItem[] extractMultiDataItems(final Element element) {
gernotbelger@9074:         final NodeList itemList = (NodeList) XMLUtils.xpath(element, "art:item", XPathConstants.NODESET, ArtifactNamespaceContext.INSTANCE);
rrenkert@7824: 
rrenkert@7824:         if (itemList == null || itemList.getLength() == 0) {
teichmann@8203:             log.debug("No old data items found.");
rrenkert@7824:             return null;
rrenkert@7824:         }
rrenkert@7824: 
gernotbelger@9074:         final int count = itemList.getLength();
rrenkert@7824: 
gernotbelger@9074:         final MultiDataItem[] items = new MultiDataItem[count];
gernotbelger@9074: 
gernotbelger@9074:         for (int i = 0; i < count; i++) {
gernotbelger@9074:             final Element tmp = (Element) itemList.item(i);
gernotbelger@9074: 
gernotbelger@9074:             final HashMap<String, String> data = new HashMap<String, String>();
gernotbelger@9074:             final String label = tmp.getAttributeNS(NS_URI, "label");
gernotbelger@9074:             final NamedNodeMap attributes = tmp.getAttributes();
gernotbelger@9074:             for (int j = 0, L = attributes.getLength(); j < L; j++) {
gernotbelger@9074:                 final Node n = attributes.item(j);
gernotbelger@9074:                 if (n.getNodeName().equals("label")) {
gernotbelger@9074:                     continue;
gernotbelger@9074:                 }
gernotbelger@9074:                 data.put(n.getNodeName(), n.getNodeValue());
gernotbelger@9074:             }
gernotbelger@9074:             items[i] = new MultiDataItem(label, label, data);
gernotbelger@9074:         }
gernotbelger@9074:         return items;
rrenkert@7824:     }
rrenkert@7824: 
ingo@1571:     /**
ingo@1571:      * This method creates a new instance of DefaultData which has no real type
ingo@1571:      * set.
ingo@1571:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1571:      *
ingo@1571:      * @return an instance of DefaultData.
ingo@1571:      */
gernotbelger@9074:     protected static Data createDefaultData(final Element ele, final String name, final String label) {
teichmann@8203:         log.debug("Create new DefaultData");
ingo@2528:         return new DefaultData(name, label, "default", extractDataItems(ele));
ingo@1571:     }
ingo@1571: 
ingo@1571:     /**
ingo@1575:      * This method creates a new instance of StringData which has a type
ingo@1575:      * "string" set.
ingo@1575:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1575:      *
ingo@1575:      * @return an instance of StringData.
ingo@1575:      */
gernotbelger@9074:     protected static Data createStringData(final Element ele, final String name, final String label) {
ingo@2528:         return new StringData(name, label, extractDataItems(ele));
ingo@1575:     }
ingo@1575: 
ingo@1575:     /**
ingo@1575:      * This method creates a new instance of DefaultData which has a type
ingo@1575:      * "integer" set.
ingo@1575:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1575:      *
ingo@1575:      * @return an instance of IntegerData.
ingo@1575:      */
gernotbelger@9074:     protected static Data createIntegerData(final Element ele, final String name, final String label) {
ingo@2528:         return new IntegerData(name, label, extractDataItems(ele));
ingo@1575:     }
ingo@1575: 
ingo@1575:     /**
ingo@2532:      * This method creates a new instance of StringOptionsData which has a type
ingo@2532:      * "options" set.
ingo@2532:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@2532:      *
ingo@2532:      * @return an instance of StringOptionsData.
ingo@2532:      */
gernotbelger@9074:     protected static Data createStringOptionsData(final Element ele, final String name, final String label) {
ingo@2532:         return new StringOptionsData(name, label, extractDataItems(ele));
ingo@2532:     }
ingo@2532: 
ingo@2532:     /**
ingo@1575:      * This method creates a new instance of DefaultData which has a type
ingo@1575:      * "intoptions" set.
ingo@1575:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1575:      *
ingo@1575:      * @return an instance of IntegerOptionsData.
ingo@1575:      */
gernotbelger@9074:     protected static Data createIntegerOptionsData(final Element ele, final String name, final String label) {
ingo@2528:         return new IntegerOptionsData(name, label, extractDataItems(ele));
ingo@1575:     }
ingo@1575: 
ingo@1575:     /**
ingo@1575:      * This method creates a new instance of DefaultData which has a type
ingo@1575:      * "intrange" set.
ingo@1575:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1575:      *
ingo@1575:      * @return an instance of IntegerRangeData.
ingo@1575:      */
gernotbelger@9074:     protected static Data createIntegerRangeData(final Element ele, final String name, final String label) {
gernotbelger@9074:         final DataItem[] items = extractDataItems(ele);
gernotbelger@9074:         final String rawValue = items[0].getStringValue();
ingo@1575: 
gernotbelger@9074:         final String[] minmax = rawValue.split(";");
ingo@1575: 
gernotbelger@9074:         return new IntegerRangeData(name, label, Integer.valueOf(minmax[0]), Integer.valueOf(minmax[1]));
ingo@1575:     }
ingo@1575: 
ingo@1575:     /**
ingo@1575:      * This method creates a new instance of DefaultData which has a type
ingo@1575:      * "integerarray" set.
ingo@1575:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1575:      *
ingo@1575:      * @return an instance of IntegerArrayData.
ingo@1575:      */
gernotbelger@9074:     protected static Data createIntegerArrayData(final Element ele, final String name, final String label) {
gernotbelger@9074:         final IntDataItem[] items = extractIntDataItems(ele);
raimund@2535:         return new IntegerArrayData(name, label, items);
ingo@1575:     }
ingo@1575: 
ingo@1575:     /**
ingo@1575:      * This method creates a new instance of DefaultData which has a type
ingo@1575:      * "doublearray" set.
ingo@1575:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
ingo@1575:      *
ingo@1575:      * @return an instance of DoubleArrayData.
ingo@1575:      */
gernotbelger@9074:     protected static Data createDoubleArrayData(final Element ele, final String name, final String label) {
gernotbelger@9074:         final DataItem[] items = extractDataItems(ele);
gernotbelger@9074:         final String rawValue = items[0].getStringValue();
ingo@1595: 
gernotbelger@9074:         final String[] values = rawValue.split(";");
gernotbelger@9074:         final double[] doubles = new double[values.length];
ingo@1595: 
ingo@1595:         for (int i = 0; i < values.length; i++) {
ingo@1595:             try {
ingo@1595:                 doubles[i] = Double.valueOf(values[i]);
ingo@1595:             }
gernotbelger@9074:             catch (final NumberFormatException nfe) {
teichmann@8203:                 log.warn("Error while parsing DoubleArrayData: " + nfe);
ingo@1595:             }
ingo@1595:         }
ingo@1595: 
ingo@2528:         return new DoubleArrayData(name, label, doubles);
ingo@1575:     }
ingo@1575: 
ingo@1575:     /**
ingo@1571:      * This method extracts the art:item elements placed under <i>elements</i>.
ingo@1571:      *
gernotbelger@9074:      * @param element
gernotbelger@9074:      *            A data node that contains items.
ingo@1571:      *
ingo@1571:      * @return a list of DataItems.
ingo@1571:      */
gernotbelger@9074:     protected static DataItem[] extractDataItems(final Element element) {
gernotbelger@9074:         final NodeList itemList = (NodeList) XMLUtils.xpath(element, "art:item", XPathConstants.NODESET, ArtifactNamespaceContext.INSTANCE);
ingo@1571: 
ingo@1571:         if (itemList == null || itemList.getLength() == 0) {
teichmann@8203:             log.debug("No data items found.");
ingo@1571:             return null;
ingo@1571:         }
ingo@1571: 
gernotbelger@9074:         final int count = itemList.getLength();
ingo@1571: 
gernotbelger@9074:         final DataItem[] items = new DataItem[count];
ingo@1571: 
teichmann@8203:         log.debug("There are " + count + " data items in element.");
ingo@2532: 
ingo@1571:         for (int i = 0; i < count; i++) {
gernotbelger@9074:             final Element tmp = (Element) itemList.item(i);
ingo@1571: 
gernotbelger@9074:             final String value = tmp.getAttributeNS(NS_URI, "value");
gernotbelger@9074:             final String label = tmp.getAttributeNS(NS_URI, "label");
ingo@1571: 
teichmann@8203:             log.debug("Found data item:");
teichmann@8203:             log.debug("   label: " + label);
teichmann@8203:             log.debug("   value: " + value);
ingo@2532: 
ingo@1571:             items[i] = new DefaultDataItem(label, label, value);
ingo@1571:         }
ingo@1571: 
ingo@1571:         return items;
ingo@1571:     }
raimund@2468: 
raimund@2468:     /**
raimund@2535:      * This method extracts the art:item elements placed under <i>elements</i>.
raimund@2535:      *
gernotbelger@9074:      * @param element
gernotbelger@9074:      *            A data node that contains items.
raimund@2535:      *
raimund@2535:      * @return a list of DataItems.
raimund@2535:      */
gernotbelger@9074:     protected static IntDataItem[] extractIntDataItems(final Element element) {
gernotbelger@9074:         final NodeList itemList = (NodeList) XMLUtils.xpath(element, "art:item", XPathConstants.NODESET, ArtifactNamespaceContext.INSTANCE);
raimund@2535: 
raimund@2535:         if (itemList == null || itemList.getLength() == 0) {
teichmann@8203:             log.debug("No old data items found.");
raimund@2535:             return null;
raimund@2535:         }
raimund@2535: 
gernotbelger@9074:         final int count = itemList.getLength();
raimund@2535: 
gernotbelger@9074:         final IntDataItem[] items = new IntDataItem[count];
raimund@2535: 
gernotbelger@9074:         for (int i = 0; i < count; i++) {
gernotbelger@9074:             final Element tmp = (Element) itemList.item(i);
gernotbelger@9074: 
gernotbelger@9074:             final String value = tmp.getAttributeNS(NS_URI, "value");
gernotbelger@9074:             final String label = tmp.getAttributeNS(NS_URI, "label");
gernotbelger@9074: 
gernotbelger@9074:             try {
gernotbelger@9074:                 final int data = Integer.parseInt(value);
gernotbelger@9074:                 items[i] = new IntDataItem(label, label, data);
gernotbelger@9074:             }
gernotbelger@9074:             catch (final NumberFormatException nfe) {
gernotbelger@9074:                 log.debug(nfe, nfe);
gernotbelger@9074:             }
gernotbelger@9074:         }
gernotbelger@9074:         return items;
raimund@2535:     }
raimund@2535: 
raimund@2535:     /**
raimund@2468:      * This method creates a new instance of LongRangeData which has a type
raimund@2468:      * "longrange" set.
raimund@2468:      *
gernotbelger@9074:      * @param ele
gernotbelger@9074:      *            The Data element.
gernotbelger@9074:      * @param name
gernotbelger@9074:      *            The name of the Data instance.
raimund@2468:      *
raimund@2468:      * @return an instance of IntegerRangeData.
raimund@2468:      */
gernotbelger@9074:     protected static Data createLongRangeData(final Element ele, final String name, final String label) {
gernotbelger@9074:         final DataItem[] items = extractDataItems(ele);
gernotbelger@9074:         final String rawValue = items[0].getStringValue();
raimund@2468: 
gernotbelger@9074:         final String[] minmax = rawValue.split(";");
raimund@2468: 
gernotbelger@9074:         return new LongRangeData(name, label, Long.valueOf(minmax[0]), Long.valueOf(minmax[1]));
raimund@2468:     }
raimund@2468: 
ingo@1571: }
ingo@1571: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :