Ticket #607: 0001-Add-support-for-3-arg-version-of-StringValueRangePro.patch

search-xapian/XS/StringValueRangeProcessor.xs

@@ -3 +3 @@
 PROTOTYPES: ENABLE
 
 StringValueRangeProcessor *
-StringValueRangeProcessor::new(valueno valno)
+StringValueRangeProcessor::new(valno, str="", prefix = TRUE)
+    valueno valno
+    string str
+    bool prefix
     CODE:
-        RETVAL = new StringValueRangeProcessor(valno);
+        switch (items) { /* items includes the hidden this pointer */
+        case 2:
+            RETVAL = new StringValueRangeProcessor(valno);
+            break;
+        case 4: {
+            RETVAL = new StringValueRangeProcessor(valno, str, prefix);
+            break;
+        }
+        default:
+            croak("Bad parameter count for new");
+        }
     OUTPUT:
         RETVAL
 

xapian-core/docs/valueranges.rst

@@ -60 +60 @@
 The ``VALUE_RANGE`` subquery will only match documents where value 4 is
 >= asimov and <= bradbury (using a string comparison).
 
+``StringValueRangeProcessor`` also supports supplying a prefix or
+suffix, so the user is able to filter queries to a range within a
+specified value:
+
+    prose country:chile..denmark
+
+This is done by providing the string to ``StringValueRangeProcessor``,
+like this:
+
+    Xapian::QueryParser qp;
+    Xapian::StringValueRangeProcessor country_proc(7, "country:", TRUE);
+    qp.add_valuerangeprocessor(&country_proc);
+
+The parsed query will include ``(VALUE_RANGE 7 chile denmark)`` in
+this case.
+
+The last argument determines whether the string is a prefix or a
+suffix (like perhaps a currency indicator: 10..100$).
+
 DateValueRangeProcessor
 =======================