Merge pull request #205 from justb4/master

fix for gxp #191 - allow automatic wildcard attachment in LIKE Filters
planetfederal · Jul 22, 2013 · 4d16c22 · 4d16c22
2 parents df41c90 + 6d7929c
commit 4d16c22
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 1 deletion.
diff --git a/src/script/widgets/FilterBuilder.js b/src/script/widgets/FilterBuilder.js
@@ -331,7 +331,7 @@ gxp.FilterBuilder = Ext.extend(Ext.Container, {
         }
         return filter;
     },
-    
+
     createDefaultFilter: function() {
         return new OpenLayers.Filter.Comparison({
                             matchCase: !this.caseInsensitiveMatch});

diff --git a/src/script/widgets/QueryPanel.js b/src/script/widgets/QueryPanel.js
@@ -77,6 +77,19 @@ gxp.QueryPanel = Ext.extend(Ext.Panel, {
      */
     caseInsensitiveMatch: false,
 
+    /** api: config[likeSubstring]
+     *  ``Boolean``
+     *  Allow substrings to be entered with LIKE comparisons? These strings will be wrapped in wildcards.
+     *  Default is ``"false"``.
+     */
+    likeSubstring: false,
+
+    /** api: config[wildCardString]
+     *  ``String``
+     *  String to be pre- and postfixed for substrings in LIKE Comparison Filters.
+     */
+    wildCardString: '.*',
+
     /** private: property[selectedLayer]
      *  ``Ext.data.Record``
      *  The currently selected record in the layers combo.
@@ -325,6 +338,12 @@ gxp.QueryPanel = Ext.extend(Ext.Panel, {
      */
     getFilter: function() {
         var attributeFilter = this.attributeQuery && this.filterBuilder.getFilter();
+
+        // If LIKE comparison substrings are enabled, wrap their string literals in wildcards
+        if (attributeFilter && this.likeSubstring) {
+            attributeFilter = this.wrapWildCards(attributeFilter);
+        }
+
         var spatialFilter = this.spatialQuery && new OpenLayers.Filter.Spatial({
             type: OpenLayers.Filter.Spatial.BBOX,
             value: this.map.getExtent()
@@ -341,6 +360,27 @@ gxp.QueryPanel = Ext.extend(Ext.Panel, {
         return filter;
     },
 
+    /** private: method[wrapWildCards]
+     *  :return: ``OpenLayers.Filter``
+     *
+     *  Returns the same (Composite) Filter with string literals wrapped with wildcard symbols
+     *  for all Comparison LIKE Filters.
+     */
+    wrapWildCards: function (filter) {
+
+        if (filter instanceof OpenLayers.Filter.Logical) {
+            // Go recursively through composite filter
+            for (var i = 0, len = filter.filters.length; i < len; ++i) {
+                filter = this.wrapWildCards(filter.filters[i]);
+            }
+        } else if (filter.type === OpenLayers.Filter.Comparison.LIKE) {
+            // Wrap the value in Wildcard strings.
+            filter.value = this.wildCardString + filter.value + this.wildCardString;
+        }
+
+        return filter;
+    },
+
     /** private: method[getFieldType]
      *  :arg attrType: ``String`` Attribute type.
      *  :returns: ``String`` Field type