LUCENE-9031: Implement MatchesIterator.getQuery().

lucene/CHANGES.txt

@@ -66,6 +66,8 @@ Bug Fixes
 
 * LUCENE-9054: Fix reproduceJenkinsFailures.py to not overwrite junit XML files when retrying (hossman)
 
+* LUCENE-9031: UnsupportedOperationException on MatchesIterator.getQuery() (Alan Woodward, Mikhail Khludnev)
+
 Other
 
 * LUCENE-8979: Code Cleanup: Use entryset for map iteration wherever possible. - Part 2 (Koen De Groote)

lucene/queries/src/java/org/apache/lucene/queries/intervals/CachingMatchesIterator.java

@@ -27,7 +27,8 @@ import org.apache.lucene.util.ArrayUtil;
 class CachingMatchesIterator extends FilterMatchesIterator {
 
   private boolean positioned = false;
-  private int[] posAndOffsets = new int[16];
+  private int[] posAndOffsets = new int[4*4];
+  private Query[] matchingQueries = new Query[4];
   private int count = 0; 
 
   CachingMatchesIterator(MatchesIterator in) {
@@ -43,16 +44,19 @@ class CachingMatchesIterator extends FilterMatchesIterator {
       posAndOffsets[1] = in.endPosition();
       posAndOffsets[2] = in.startOffset();
       posAndOffsets[3] = in.endOffset();
+      matchingQueries [0] = in.getQuery();
     }
     else {
       while (mi.next()) {
         if (count * 4 >= posAndOffsets.length) {
           posAndOffsets = ArrayUtil.grow(posAndOffsets, (count + 1) * 4);
+          matchingQueries = ArrayUtil.grow(matchingQueries, (count + 1));
         }
         posAndOffsets[count * 4] = mi.startPosition();
         posAndOffsets[count * 4 + 1] = mi.endPosition();
         posAndOffsets[count * 4 + 2] = mi.startOffset();
         posAndOffsets[count * 4 + 3] = mi.endOffset();
+        matchingQueries[count] = mi.getQuery();
         count++;
       }
     }
@@ -124,7 +128,7 @@ class CachingMatchesIterator extends FilterMatchesIterator {
 
       @Override
       public Query getQuery() {
-        throw new UnsupportedOperationException();
+        return matchingQueries[upto];
       }
     };
   }

lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalMatches.java

@@ -74,7 +74,7 @@ final class IntervalMatches {
 
       @Override
       public Query getQuery() {
-        throw new UnsupportedOperationException();
+        return source.getQuery();
       }
     };
   }

lucene/queries/src/java/org/apache/lucene/queries/intervals/MultiTermIntervalsSource.java

@@ -83,7 +83,7 @@ class MultiTermIntervalsSource extends IntervalsSource {
     BytesRef term;
     int count = 0;
     while ((term = te.next()) != null) {
-      MatchesIterator mi = TermIntervalsSource.matches(te, doc);
+      MatchesIterator mi = TermIntervalsSource.matches(te, doc, field);
       if (mi != null) {
         subMatches.add(mi);
         if (count++ > maxExpansions) {

lucene/queries/src/java/org/apache/lucene/queries/intervals/TermIntervalsSource.java

@@ -34,6 +34,7 @@ import org.apache.lucene.search.DocIdSetIterator;
 import org.apache.lucene.search.MatchesIterator;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.search.QueryVisitor;
+import org.apache.lucene.search.TermQuery;
 import org.apache.lucene.search.TwoPhaseIterator;
 import org.apache.lucene.util.BytesRef;
 
@@ -149,10 +150,11 @@ class TermIntervalsSource extends IntervalsSource {
     if (te.seekExact(term) == false) {
       return null;
     }
-    return matches(te, doc);
+    return matches(te, doc, field);
   }
 
-  static MatchesIterator matches(TermsEnum te, int doc) throws IOException {
+  static MatchesIterator matches(TermsEnum te, int doc, String field) throws IOException {
+    TermQuery query = new TermQuery(new Term(field, te.term()));
     PostingsEnum pe = te.postings(null, PostingsEnum.OFFSETS);
     if (pe.advance(doc) != doc) {
       return null;
@@ -200,7 +202,7 @@ class TermIntervalsSource extends IntervalsSource {
 
       @Override
       public Query getQuery() {
-        throw new UnsupportedOperationException();
+        return query;
       }
     };
   }

lucene/queries/src/test/org/apache/lucene/queries/intervals/TestIntervals.java

@@ -46,6 +46,7 @@ import org.apache.lucene.search.MatchesIterator;
 import org.apache.lucene.search.PrefixQuery;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.search.QueryVisitor;
+import org.apache.lucene.search.TermQuery;
 import org.apache.lucene.store.Directory;
 import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.IOUtils;
@@ -228,8 +229,12 @@ public class TestIntervals extends LuceneTestCase {
     assertNull(getMatches(source, 2, "no_such_field"));
     MatchesIterator mi = getMatches(source, 2, "field1");
     assertMatch(mi, 1, 1, 6, 14);
+    final TermQuery porridge = new TermQuery(new Term("field1","porridge"));
+    assertEquals(porridge, mi.getQuery());
     assertMatch(mi, 4, 4, 27, 35);
+    assertEquals(porridge, mi.getQuery());
     assertMatch(mi, 7, 7, 47, 55);
+    assertEquals(porridge, mi.getQuery());
     assertFalse(mi.next());
 
     assertEquals(1, source.minExtent());
@@ -282,9 +287,18 @@ public class TestIntervals extends LuceneTestCase {
     assertMatch(mi, 3, 4, 20, 34);
     MatchesIterator sub = mi.getSubMatches();
     assertMatch(sub, 3, 3, 20, 25);
+    assertEquals(new TermQuery( new Term("field1", "pease")), sub.getQuery());
     assertMatch(sub, 4, 4, 26, 34);
+    assertEquals(new TermQuery( new Term("field1", "porridge")), sub.getQuery());
     assertFalse(sub.next());
+    
     assertMatch(mi, 6, 7, 41, 55);
+    sub = mi.getSubMatches();
+    assertTrue(sub.next());
+    assertEquals(new TermQuery( new Term("field1", "pease")), sub.getQuery());
+    assertTrue(sub.next());
+    assertEquals(new TermQuery( new Term("field1", "porridge")), sub.getQuery());
+    assertFalse(sub.next());
 
     assertEquals(2, source.minExtent());
 
@@ -334,8 +348,10 @@ public class TestIntervals extends LuceneTestCase {
     assertNull(getMatches(source, 0, "field1"));
     MatchesIterator mi = getMatches(source, 3, "field1");
     assertMatch(mi, 3, 3, 15, 18);
+    assertEquals(new TermQuery(new Term("field1","hot")), mi.getQuery());
     assertNull(mi.getSubMatches());
     assertMatch(mi, 7, 7, 31, 36);
+    assertEquals(new TermQuery(new Term("field1","pease")), mi.getQuery());
     assertNull(mi.getSubMatches());
     assertFalse(mi.next());
 
@@ -354,7 +370,6 @@ public class TestIntervals extends LuceneTestCase {
         { 3, 8 },
         {}, {}, {}, {}
     });
-
     assertEquals(2, source.minExtent());
 
     checkVisits(source, 5, "alph", "sacred", "measureless");
@@ -448,9 +463,13 @@ public class TestIntervals extends LuceneTestCase {
     assertMatch(it, 6, 21, 41, 118);
     MatchesIterator sub = it.getSubMatches();
     assertMatch(sub, 6, 6, 41, 46);
+    assertEquals(new TermQuery(new Term("field1", "pease")), sub.getQuery());
     assertMatch(sub, 19, 19, 106, 110);
+    assertEquals(new TermQuery(new Term("field1", "like")), sub.getQuery());
     assertMatch(sub, 20, 20, 111, 113);
+    assertEquals(new TermQuery(new Term("field1", "it")),sub.getQuery());
     assertMatch(sub, 21, 21, 114, 118);
+    assertEquals(new TermQuery(new Term("field1", "cold")),sub.getQuery());
     assertFalse(sub.next());
     assertFalse(it.next());
     assertEquals(4, source.minExtent());