Recalculate Bounding Boxes

src/main/java/it/geosolutions/geoserver/rest/GeoServerRESTPublisher.java

@@ -3206,4 +3206,110 @@ public void postImport(int i) throws Exception {
         importerManager.postImport(i);
     }
 
+    /**
+     * Defines multiple modes of recalculating bounding boxes.
+     * 
+     * @author Carl Schroedl - [email protected]
+     */
+    public enum BBoxRecalculationMode {
+        /**
+         * Recalculate the native bounding box, but do not recalculate the 
+         * lat/long bounding box.
+         */
+        NATIVE_BBOX("nativebbox"),
+
+        /**
+         * Recalculate both the native bounding box and the lat/long bounding 
+         * box.
+         */
+        NATIVE_AND_LAT_LON_BBOX("nativebbox,latlonbbox"),
+
+        /**
+         * Do not calculate any fields, regardless of the projection, projection
+         * policy, etc. This might be useful to avoid slow recalculation when 
+         * operating against large datasets.
+         */
+        NONE(""),
+        ;
+
+        private final String paramValue;
+
+        /**
+         * Associates the enum value with a URL query string parameter value
+         * @param paramValue 
+         */
+        BBoxRecalculationMode(String paramValue){
+            this.paramValue = paramValue;
+        }
+
+        /**
+         * Get the URL param value
+         * @return The query string parameter value
+         */
+        public String getParamValue(){
+            return paramValue;
+        }
+    }
+
+    /**
+     * 
+     * Recalculate the bounding box for a feature type or a coverage
+     * 
+     * @param type
+     * @param xmlElementName - either featureType or coverage
+     * @param workspace
+     * @param storeName
+     * @param layerName
+     * @param calculationMode
+     * @param enabled
+     * @return true if recalculation succeeded, false otherwise.
+     */
+    private boolean recalculateBBox(StoreType type, GSResourceEncoder renc, String workspace, String storeName, String layerName, BBoxRecalculationMode calculationMode){
+
+        String baseUrl = restURL + "/rest/workspaces/" + workspace + "/" +
+                type.getType().toLowerCase() +"s/" + storeName + "/" +
+                type.getTypeName().toLowerCase() + "/" +
+                layerName + "." + Format.XML.toString();
+
+        String sUrl = baseUrl + "?recalculate=" + calculationMode.getParamValue();
+        LOGGER.debug("Constructed the following url for bounding box recalculation: " + sUrl);
+
+        renc.recursivelyRemoveEmptyChildren();
+        String body = renc.toString();
+        String sendResult = HTTPUtils.putXml(sUrl, body, gsuser, gspass);
+        boolean success = sendResult != null;
+        return success;
+    }
+
+    /**
+     * Recalculate a bounding box for a feature type
+     * @param workspace
+     * @param storeName
+     * @param layerName
+     * @param calculationMode
+     * @param enabled
+     * @return true if successful, false otherwise
+     */
+    public boolean recalculateFeatureTypeBBox(String workspace, String storeName, String layerName, BBoxRecalculationMode calculationMode, boolean enabled){
+        GSFeatureTypeEncoder fenc = new GSFeatureTypeEncoder();
+        fenc.setName(layerName);
+        fenc.setEnabled(enabled);
+        return recalculateBBox(StoreType.DATASTORES, fenc, workspace, storeName, layerName, calculationMode);
+    }
+
+    /**
+     * Recalculate a bounding box for a coverage
+     * @param workspace
+     * @param storeName
+     * @param layerName
+     * @param calculationMode
+     * @param enabled
+     * @return true if successful, false otherwise
+     */
+    public boolean recalculateCoverageBBox(String workspace, String storeName, String layerName, BBoxRecalculationMode calculationMode, boolean enabled){
+        GSCoverageEncoder cenc = new GSCoverageEncoder();
+        cenc.setName(layerName);
+        cenc.setEnabled(enabled);
+        return recalculateBBox(StoreType.COVERAGESTORES, cenc, workspace, storeName, layerName, calculationMode);
+    }
 }

src/main/java/it/geosolutions/geoserver/rest/encoder/utils/XmlElement.java

@@ -26,6 +26,8 @@
 package it.geosolutions.geoserver.rest.encoder.utils;
 
 
+import java.util.ArrayList;
+import java.util.List;
 import org.jdom.Content;
 import org.jdom.Element;
 import org.jdom.Text;
@@ -122,6 +124,39 @@ public boolean remove(final String key){
 			return false;
 	}
 
+
+    /**
+     * Recursively removes all child nodes that have no contents.
+     */
+    public void recursivelyRemoveEmptyChildren(){
+        //must make a copy to avoid ConcurrentModificationException
+        List<Content> children = new ArrayList<Content>(this.root.getContent());
+
+        for(Content child : children){
+            if(child instanceof Element){
+                recursivelyRemoveEmptyChildren(this.root, (Element)child);
+            }
+        }
+    }
+    private void recursivelyRemoveEmptyChildren(Element grandparent, Element parent){
+        //must make a copy to avoid ConcurrentModificationException
+        List<Content> childrenPreRemoval;
+        childrenPreRemoval = new ArrayList<Content>(parent.getContent());
+
+        //base case: the parent has no children
+        for(Content child : childrenPreRemoval){
+            //recursive case: the parent has children
+            if(child instanceof Element){
+                recursivelyRemoveEmptyChildren(parent, (Element)child);
+            }
+        }
+
+        //if the parent node contains no children, remove it from the parent
+        List<Content> childrenPostRemoval = parent.getContent();
+        if(childrenPostRemoval.isEmpty()){
+            grandparent.removeContent(parent);
+        }
+    }
 	/**
      * @return an xml String 
      */

src/test/java/it/geosolutions/geoserver/rest/encoder/utils/XmlElementTest.java

@@ -0,0 +1,134 @@
+/*
+ *  GeoServer-Manager - Simple Manager Library for GeoServer
+ *
+ *  Copyright (C) 2007,2011 GeoSolutions S.A.S.
+ *  http://www.geo-solutions.it
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package it.geosolutions.geoserver.rest.encoder.utils;
+
+import java.io.IOException;
+import java.io.StringReader;
+import org.jdom.Document;
+import org.jdom.Element;
+import org.jdom.JDOMException;
+import org.jdom.input.SAXBuilder;
+import org.jdom.output.XMLOutputter;
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+/**
+ * Tests XmlElements
+ * @author Carl Schroedl - [email protected]
+ */
+public class XmlElementTest {
+
+    /**
+     * Creates an XmlElement from a String
+     * @param xmlString
+     * @return the specified String as an XmlElement
+     */
+    private XmlElement makeElement(String xmlString){
+        Document doc;
+        SAXBuilder builder = new SAXBuilder();
+        try {
+            doc = builder.build(new StringReader(xmlString));
+        } catch (JDOMException ex) {
+            throw new RuntimeException(ex);
+        } catch (IOException ex) {
+            throw new RuntimeException(ex);
+        }
+        Element root = doc.getRootElement();
+
+        return new XmlElement(root);
+    }
+
+    /**
+     * Asserts that the serializations of two XmlElements are the same.
+     * @param message
+     * @param expected
+     * @param actual 
+     */
+    private void assertEqualXml(String message, XmlElement expected, XmlElement actual){
+        XMLOutputter out = new XMLOutputter();
+        String expectedElementString = out.outputString(expected.getRoot());
+        String actualElementString = out.outputString(actual.getRoot());
+        assertEquals(message, expectedElementString, actualElementString);
+    }
+
+    @Test
+    public void testRecursiveRemovalOnChildlessParent(){
+        XmlElement root = makeElement("<parent/>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("no child elements expected", makeElement("<parent/>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfOneChild(){
+        XmlElement root = makeElement("<parent><child/></parent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("no child elements expected", makeElement("<parent/>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfOneChildWithOneKeeper(){
+        XmlElement root = makeElement("<parent><child/><keep>keep</keep></parent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("one child element expected", makeElement("<parent><keep>keep</keep></parent>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfOneParentAndOneChild() {
+        XmlElement root = makeElement("<grandparent><parent><child/></parent></grandparent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("no child elements expected", makeElement("<grandparent/>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfOneParentAndManyChildren() {
+        XmlElement root = makeElement("<grandparent><parent><child/><child/><child/></parent></grandparent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("no child elements expected", makeElement("<grandparent/>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfManyParentsWithOneChild() {
+        XmlElement root = makeElement("<grandparent><parent><child/></parent><parent><child/></parent><parent><child/></parent></grandparent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("no child elements expected", makeElement("<grandparent/>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfManyParentsAndManyChildren() {
+        XmlElement root = makeElement("<grandparent><parent><child/><child/><child/></parent><parent><child/><child/><child/></parent><parent><child/><child/><child/></parent></grandparent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("no child elements expected", makeElement("<grandparent/>"), root);
+    }
+
+    @Test
+    public void testRecursiveRemovalOfManyParentsAndManyChildrenWithSomeKeepers() {
+        XmlElement root = makeElement("<grandparent><keep>keep</keep><parent><keep>keep</keep><child/><child><keep>keep</keep></child><child/></parent><parent><child/><child/><child/></parent><parent><child/><child/><child><keep>keep</keep></child></parent></grandparent>");
+        root.recursivelyRemoveEmptyChildren();
+        assertEqualXml("only non-empty child elements should remain", makeElement("<grandparent><keep>keep</keep><parent><keep>keep</keep><child><keep>keep</keep></child></parent><parent><child><keep>keep</keep></child></parent></grandparent>"), root);
+    }
+
+
+}