# HG changeset patch
# User Raimund Renkert <rrenkert@intevation.de>
# Date 1351512803 -3600
# Node ID 1f98a3a89e130f632bc4ed2706d2f731b54de5c8
# Parent  6d44914b2dd4ee80138d30fec0f48b9e29400333
New client side  service for sediment load infos.

The service requests an sediment load overview and creates info objects for the
received data.

diff -r 6d44914b2dd4 -r 1f98a3a89e13 flys-client/src/main/java/de/intevation/flys/client/client/services/SedimentLoadInfoService.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/client/services/SedimentLoadInfoService.java	Mon Oct 29 13:13:23 2012 +0100
@@ -0,0 +1,30 @@
+package de.intevation.flys.client.client.services;
+
+import com.google.gwt.user.client.rpc.RemoteService;
+import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
+
+import de.intevation.flys.client.shared.exceptions.ServerException;
+import de.intevation.flys.client.shared.model.DischargeInfoObject;
+import de.intevation.flys.client.shared.model.SedimentLoadInfoObject;
+
+/**
+ * This service is used to fetch a list of SedimentLoadInfoObjects from artifact
+ * server for a specific river.
+ *
+ * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
+ */
+@RemoteServiceRelativePath("sedimentloadinfo")
+public interface SedimentLoadInfoService extends RemoteService {
+
+    /**
+     * This method returns a list of SedimentLoadInfoObjects for a specific river.
+     */
+    SedimentLoadInfoObject[] getSedimentLoadInfo(
+        String locale,
+        String river,
+        String type,
+        double startKm,
+        double endKm)
+    throws ServerException;
+}
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
diff -r 6d44914b2dd4 -r 1f98a3a89e13 flys-client/src/main/java/de/intevation/flys/client/client/services/SedimentLoadInfoServiceAsync.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/client/services/SedimentLoadInfoServiceAsync.java	Mon Oct 29 13:13:23 2012 +0100
@@ -0,0 +1,20 @@
+package de.intevation.flys.client.client.services;
+
+import com.google.gwt.user.client.rpc.AsyncCallback;
+
+import de.intevation.flys.client.shared.model.SedimentLoadInfoObject;
+
+/**
+ * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
+ */
+public interface SedimentLoadInfoServiceAsync {
+
+    void getSedimentLoadInfo(
+        String locale,
+        String river,
+        String type,
+        double startKm,
+        double endKm,
+        AsyncCallback<SedimentLoadInfoObject[]> cb);
+}
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
diff -r 6d44914b2dd4 -r 1f98a3a89e13 flys-client/src/main/java/de/intevation/flys/client/server/SedimentLoadInfoServiceImpl.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/server/SedimentLoadInfoServiceImpl.java	Mon Oct 29 13:13:23 2012 +0100
@@ -0,0 +1,152 @@
+package de.intevation.flys.client.server;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.log4j.Logger;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
+
+import com.google.gwt.user.server.rpc.RemoteServiceServlet;
+
+import de.intevation.artifacts.common.ArtifactNamespaceContext;
+import de.intevation.artifacts.common.utils.XMLUtils;
+import de.intevation.artifacts.httpclient.exceptions.ConnectionException;
+import de.intevation.artifacts.httpclient.http.HttpClient;
+import de.intevation.artifacts.httpclient.http.HttpClientImpl;
+import de.intevation.flys.client.client.services.SedimentLoadInfoService;
+import de.intevation.flys.client.shared.exceptions.ServerException;
+import de.intevation.flys.client.shared.model.SedimentLoadInfoObject;
+import de.intevation.flys.client.shared.model.SedimentLoadInfoObjectImpl;
+
+
+public class SedimentLoadInfoServiceImpl
+extends RemoteServiceServlet
+implements SedimentLoadInfoService
+{
+    private static final Logger logger =
+        Logger.getLogger(SedimentLoadInfoServiceImpl.class);
+
+    public static final String ERROR_NO_SEDIMENTLOADINFO_FOUND =
+        "error_no_sedimentloadinfo_found";
+
+    @Override
+    public SedimentLoadInfoObject[] getSedimentLoadInfo(
+        String locale,
+        String river,
+        String type,
+        double startKm,
+        double endKm)
+    throws ServerException
+    {
+        logger.info("SedimentLoadInfoServiceImpl.getSedimentLoadInfo");
+
+        String url  = getServletContext().getInitParameter("server-url");
+
+        Document doc = XMLUtils.newDocument();
+
+        XMLUtils.ElementCreator ec = new XMLUtils.ElementCreator(
+            doc,
+            ArtifactNamespaceContext.NAMESPACE_URI,
+            ArtifactNamespaceContext.NAMESPACE_PREFIX);
+
+        Element riverEl = ec.create("river");
+        Element location = ec.create("location");
+        Element from = ec.create("from");
+        Element to = ec.create("to");
+        Element typeEl = ec.create("type");
+        riverEl.setTextContent(river);
+        from.setTextContent(String.valueOf(startKm));
+        to.setTextContent(String.valueOf(endKm));
+        typeEl.setTextContent(type);
+
+        location.appendChild(from);
+        location.appendChild(to);
+        riverEl.appendChild(location);
+        riverEl.appendChild(typeEl);
+        doc.appendChild(riverEl);
+
+        HttpClient client = new HttpClientImpl(url, locale);
+
+        try {
+            Document result = client.callService(url, "sedimentloadinfo", doc);
+
+            logger.debug("Extract sedimentload info objects now.");
+            SedimentLoadInfoObject[] objects =
+                extractSedimentLoadInfoObjects(result);
+
+            if (objects != null && objects.length > 0) {
+                return objects;
+            }
+        }
+        catch (ConnectionException ce) {
+            logger.error(ce, ce);
+        }
+
+        throw new ServerException(ERROR_NO_SEDIMENTLOADINFO_FOUND);
+    }
+
+
+    /**
+     * Extracts all distance info objects from <i>result</i> document.
+     *
+     * @param result The document retrieved by the server.
+     *
+     * @return a list of DistanceInfoObjects.
+     */
+    protected SedimentLoadInfoObject[] extractSedimentLoadInfoObjects(
+        Document result)
+    throws ServerException
+    {
+        NodeList list = result.getElementsByTagName("sedimentload");
+
+        if (list == null || list.getLength() == 0) {
+            logger.warn("No sedimentload info found.");
+            throw new ServerException(ERROR_NO_SEDIMENTLOADINFO_FOUND);
+        }
+
+        int num = list.getLength();
+        logger.debug("Response contains " + num + " objects.");
+
+        List<SedimentLoadInfoObject> objects =
+            new ArrayList<SedimentLoadInfoObject>(num);
+
+        for (int i = 0; i < num; i++) {
+            SedimentLoadInfoObject obj = buildSedimentLoadInfoObject(
+                (Element)list.item(i));
+
+            if (obj != null) {
+                objects.add(obj);
+            }
+        }
+
+        logger.debug("Retrieved " + objects.size() + " sediment loads.");
+
+        return (SedimentLoadInfoObject[])
+            objects.toArray(new SedimentLoadInfoObject[num]);
+    }
+
+
+    /**
+     * Extracts information for a single distance info object and intializes an
+     * DistanceInfoObject with them.
+     *
+     * @param node The node that contains the information.
+     *
+     * @return a valid DistanceInfoObject.
+     */
+    protected SedimentLoadInfoObject buildSedimentLoadInfoObject(Element node) {
+
+        String desc      = node.getAttribute("description").trim();
+        String date      = node.getAttribute("date").trim();
+
+        if (desc.length() > 0 && date.length() > 0) {
+            return new SedimentLoadInfoObjectImpl(desc, date);
+        }
+
+        logger.warn("Invalid sediment load info object found.");
+
+        return null;
+    }
+}
diff -r 6d44914b2dd4 -r 1f98a3a89e13 flys-client/src/main/java/de/intevation/flys/client/shared/model/SedimentLoadInfoObject.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/shared/model/SedimentLoadInfoObject.java	Mon Oct 29 13:13:23 2012 +0100
@@ -0,0 +1,15 @@
+package de.intevation.flys.client.shared.model;
+
+import java.io.Serializable;
+
+
+/**
+ * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
+ */
+public interface SedimentLoadInfoObject extends Serializable {
+
+    String getDescription();
+
+    String getDate();
+}
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file
diff -r 6d44914b2dd4 -r 1f98a3a89e13 flys-client/src/main/java/de/intevation/flys/client/shared/model/SedimentLoadInfoObjectImpl.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/shared/model/SedimentLoadInfoObjectImpl.java	Mon Oct 29 13:13:23 2012 +0100
@@ -0,0 +1,31 @@
+package de.intevation.flys.client.shared.model;
+
+
+/**
+ * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
+ */
+public class SedimentLoadInfoObjectImpl implements SedimentLoadInfoObject {
+
+    protected String description;
+    protected String dateString;
+
+    public SedimentLoadInfoObjectImpl() {
+    }
+
+    public SedimentLoadInfoObjectImpl(
+        String description,
+        String dateString
+    ) {
+        this.description = description;
+        this.dateString = dateString;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public String getDate() {
+        return this.dateString;
+    }
+}
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file
diff -r 6d44914b2dd4 -r 1f98a3a89e13 flys-client/src/main/webapp/WEB-INF/web.xml
--- a/flys-client/src/main/webapp/WEB-INF/web.xml	Mon Oct 29 13:09:16 2012 +0100
+++ b/flys-client/src/main/webapp/WEB-INF/web.xml	Mon Oct 29 13:13:23 2012 +0100
@@ -533,6 +533,16 @@
   </servlet-mapping>
 
   <servlet>
+    <servlet-name>SedimentLoadInfo</servlet-name>
+    <servlet-class>de.intevation.flys.client.server.SedimentLoadInfoServiceImpl</servlet-class>
+  </servlet>
+
+  <servlet-mapping>
+    <servlet-name>SedimentLoadInfo</servlet-name>
+    <url-pattern>/flys/sedimentloadinfo</url-pattern>
+  </servlet-mapping>
+
+  <servlet>
     <servlet-name>login</servlet-name>
     <servlet-class>de.intevation.flys.client.server.LoginServlet</servlet-class>
   </servlet>