add doc and test

geosolutions-it · Nov 11, 2016 · bc26f15 · bc26f15
1 parent c3ebdf7
commit bc26f15
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 25 deletions.
diff --git a/web/client/utils/FilterUtils.jsx b/web/client/utils/FilterUtils.jsx
@@ -488,39 +488,52 @@ const FilterUtils = {
         ogc += this.ogcSpatialOperator[this.objFilter.spatialField.operation].endTag;
         return ogc;
     },
+    /**
+    *  processOGCCrossLayerFilter(object)
+    *  object should be in this form :
+    *    {
+    *    operation: "FILTER_OPERATION_TO_DO_WITH_GEOMETRY",
+    *       attribute: "GEOMETRY_NAME_OF_THE_FEATURE_TYPE_TO_FILTER",
+    *       collectGeometries: {queryCollection: {
+    *           typeName: "TYPE_NAME_TO_QUERY",
+    *           geometryName: "GEOMETRY_NAME_OF_THE_FEATURE_TYPE_TO_QUERY",
+    *           cqlFilter: "CQL_FITER_TO_APPLY_TO_THE_FEATURE_TYPE"
+    *       }
+    * }}
+    * Example: if I want to filter the featureType "roads", with the geometryName = "roads_geom"
+    * that intersect the polygons from the featureType "regions, with geometryName "regions_geom"
+    * where the attribute "area" of the region is >= 10 You will have the following
+    *    {
+    *   operation: "INTERSECTS"
+    *   attribute: "roads_geom",
+    *    collectGeometries: {queryCollection: {
+    *       typeName: "regions",
+    *       geometryName: "regions_geom",
+    *       cqlFilter: "area > 10"
+    *   }}
+    *   }
+    */
     processOGCCrossLayerFilter: function(crossLayerFilter) {
         let ogc = this.ogcSpatialOperator[crossLayerFilter.operation].startTag;
         ogc +=
             this.propertyTagReference[this.nsplaceholder].startTag +
                 crossLayerFilter.attribute +
             this.propertyTagReference[this.nsplaceholder].endTag;
-
-        switch (crossLayerFilter.operation) {
-            case "INTERSECTS":
-            case "DWITHIN":
-            case "WITHIN":
-            case "CONTAINS": {
-                if (crossLayerFilter.collectGeometries) {
-                    ogc += `<ogc:Function name="collectGeometries">
-                     <ogc:Function name="queryCollection">
-                       <ogc:Literal>${crossLayerFilter.collectGeometries.queryCollection.typeName}</ogc:Literal>
-                       <ogc:Literal>${crossLayerFilter.collectGeometries.queryCollection.geometryName}</ogc:Literal>
-                       <ogc:Literal>${crossLayerFilter.collectGeometries.queryCollection.cqlFilter}</ogc:Literal>
-                     </ogc:Function>
-                 </ogc:Function>`;
-                }
-
-                if (crossLayerFilter.operation === "DWITHIN") {
-                    ogc += '<' + this.nsplaceholder + ':Distance units="m">' + (crossLayerFilter.distance || 0) + '</' + this.nsplaceholder + ':Distance>';
-                }
-
-                break;
-            }
-            default:
-                break;
+        // only collectGeometries is supported now
+        if (crossLayerFilter.collectGeometries) {
+            ogc += `<ogc:Function name="collectGeometries">` +
+             `<ogc:Function name="queryCollection">` +
+               `<ogc:Literal>${crossLayerFilter.collectGeometries.queryCollection.typeName}</ogc:Literal>` +
+               `<ogc:Literal>${crossLayerFilter.collectGeometries.queryCollection.geometryName}</ogc:Literal>` +
+               `<ogc:Literal>${crossLayerFilter.collectGeometries.queryCollection.cqlFilter}</ogc:Literal>` +
+             `</ogc:Function>` +
+         `</ogc:Function>`;
+        }
+        if (crossLayerFilter.operation === "DWITHIN") {
+            ogc += '<' + this.nsplaceholder + ':Distance units="m">' + (crossLayerFilter.distance || 0) + '</' + this.nsplaceholder + ':Distance>';
         }
 
-        ogc += this.ogcSpatialOperator[this.objFilter.spatialField.operation].endTag;
+        ogc += this.ogcSpatialOperator[crossLayerFilter.operation].endTag;
         return ogc;
     },
     getGmlPointElement: function(coordinates, srsName, version) {

diff --git a/web/client/utils/__tests__/FilterUtils-test.js b/web/client/utils/__tests__/FilterUtils-test.js
@@ -461,4 +461,32 @@ describe('FilterUtils', () => {
         let filter = FilterUtils.toCQLFilter(filterObj);
         expect(filter).toEqual(expected);
     });
+    it('Check CrossLayerFilter segment generation', () => {
+        let crossLayerFilterObj = {
+           operation: "INTERSECTS",
+           attribute: "roads_geom",
+           collectGeometries: {queryCollection: {
+               typeName: "regions",
+               geometryName: "regions_geom",
+               cqlFilter: "area > 10"
+           }}
+        };
+        let expected = "<ogc:Intersects>"
+         + '<ogc:PropertyName>roads_geom</ogc:PropertyName>'
+         + '<ogc:Function name="collectGeometries">'
+         + '<ogc:Function name="queryCollection">'
+         + '<ogc:Literal>regions</ogc:Literal>'
+         + '<ogc:Literal>regions_geom</ogc:Literal>'
+         + '<ogc:Literal>area > 10</ogc:Literal>'
+         + '</ogc:Function></ogc:Function>'
+         + "</ogc:Intersects>";
+
+        // this is a workarround for this issue : https://github.com/geosolutions-it/MapStore2/issues/1263
+        // please remove when fixed
+        FilterUtils.nsplaceholder = "ogc";
+        FilterUtils.setOperatorsPlaceholders("{namespace}", "ogc");
+
+        let filter = FilterUtils.processOGCCrossLayerFilter(crossLayerFilterObj);
+        expect(filter).toEqual(expected);
+    });
 });