Refactor SpanListener

Author: glorieux-f

common/src/java/com/github/oeuvres/alix/lucene/HtmlResults.java

@@ -8,13 +8,14 @@
 import org.apache.lucene.index.StoredFields;
 
 import com.github.oeuvres.alix.lucene.spans.OffsetsCollector;
+import com.github.oeuvres.alix.lucene.spans.SpanListener;
 import com.github.oeuvres.alix.util.Detagger;
 import com.github.oeuvres.alix.util.Markup;
 
 import static com.github.oeuvres.alix.common.Names.*;
 
 /**
- * A {@link ResultsListener} that writes span search results as an HTML fragment.
+ * A {@link SpanListener} that writes span search results as an HTML fragment.
  *
  * <p>Each matching document becomes an {@code <article>} element containing an
  * ordered list of span concordance lines. Each line shows a left context, one or
@@ -28,7 +29,7 @@
  * ({@link #lastDocId} + 1). The caller is responsible for turning that into a
  * full URL.</p>
  */
-public class HtmlResults extends ResultsListener
+public class HtmlResults extends SpanListener
 {
     private final Writer writer;
     private final StoredFields storedFields;

…oeuvres/alix/lucene/ResultsListener.java …vres/alix/lucene/spans/SpanListener.javacommon/src/java/com/github/oeuvres/alix/lucene/ResultsListener.java renamed to common/src/java/com/github/oeuvres/alix/lucene/spans/SpanListener.java common/src/java/com/github/oeuvres/alix/lucene/ResultsListener.java renamed to common/src/java/com/github/oeuvres/alix/lucene/spans/SpanListener.java

@@ -1,12 +1,10 @@
-package com.github.oeuvres.alix.lucene;
+package com.github.oeuvres.alix.lucene.spans;
 
 import java.io.IOException;
 
 import org.apache.lucene.queries.spans.SpanQuery;
 import org.apache.lucene.search.Query;
 
-import com.github.oeuvres.alix.lucene.spans.OffsetsCollector;
-
 
 /**
  * Receives streamed query results from a walker.
@@ -30,7 +28,7 @@
  *       exhausted, {@code false} if {@link #wantsMoreDocs()} cut traversal short</li>
  * </ol>
  */
-public abstract class ResultsListener
+public abstract class SpanListener
 {
 
 

common/src/java/com/github/oeuvres/alix/lucene/spans/SpanVisitor.java

@@ -11,14 +11,13 @@
 import org.apache.lucene.search.IndexSearcher;
 import org.apache.lucene.search.ScoreMode;
 
-import com.github.oeuvres.alix.lucene.ResultsListener;
 import com.github.oeuvres.alix.lucene.terms.FieldStats;
 import com.github.oeuvres.alix.lucene.terms.TermRail;
 import com.github.oeuvres.alix.util.TopSlot;
 
 /**
  * Visits individual documents for a {@link SpanQuery}, scores spans by passage
- * informativeness, and streams the top spans to a {@link ResultsListener}.
+ * informativeness, and streams the top spans to a {@link SpanListener}.
  *
  * <p>The caller controls the outer loop — typically over a {@code ScoreDoc[]}
  * returned by {@link org.apache.lucene.search.IndexSearcher#search}:</p>
@@ -55,7 +54,7 @@ public final class SpanVisitor {
 
     private final IndexSearcher searcher;
     private final SpanQuery spanQuery;
-    private final ResultsListener listener;
+    private final SpanListener listener;
     private final FieldStats fieldStats;
     private final TermRail termRail;
 
@@ -116,7 +115,7 @@ public final class SpanVisitor {
     public SpanVisitor(
             final IndexSearcher searcher,
             final SpanQuery spanQuery,
-            final ResultsListener listener,
+            final SpanListener listener,
             final FieldStats fieldStats,
             final TermRail termRail,
             final int topSpans,
@@ -145,7 +144,7 @@ public SpanVisitor(
     /**
      * Returns the total number of spans found in the most recently visited document,
      * including those not emitted. Useful for the caller to pass to
-     * {@link ResultsListener#endDoc(int)}.
+     * {@link SpanListener#endDoc(int)}.
      *
      * @return total span count for the last {@link #visit} call
      */
@@ -157,8 +156,8 @@ public int spanTotal() {
      * Visits one document: enumerates all its spans, scores them by passage
      * informativeness, and emits the top spans to the listener.
      *
-     * <p>The caller must have already called {@link ResultsListener#startDoc}
-     * before this method, and must call {@link ResultsListener#endDoc} after.</p>
+     * <p>The caller must have already called {@link SpanListener#startDoc}
+     * before this method, and must call {@link SpanListener#endDoc} after.</p>
      *
      * @param docId global Lucene doc id
      * @throws IOException if index access or listener output fails

common/src/java/com/github/oeuvres/alix/lucene/spans/SpanWalker.java

@@ -16,11 +16,9 @@
 import org.apache.lucene.search.Scorer;
 import org.apache.lucene.search.Weight;
 
-import com.github.oeuvres.alix.lucene.ResultsListener;
-
 /**
  * Walks a {@link SpanQuery} in natural/index order, optionally intersected with a
- * non-scoring filter query (dates, tags…), and streams results to a {@link ResultsListener}.
+ * non-scoring filter query (dates, tags…), and streams results to a {@link SpanListener}.
  *
  * <p>Traversal is streaming: no results are retained in memory. If the index was built
  * with an index sort, natural order is that sort order.</p>
@@ -32,7 +30,7 @@
  * the last docId it wrote; the next page passes {@code lastDocId + 1} as {@code docStart}.</p>
  *
  * <p>Whether a page ended by natural exhaustion or by the listener is reported via
- * {@link ResultsListener#end(boolean)}: {@code true} means the index is fully exhausted and
+ * {@link SpanListener#end(boolean)}: {@code true} means the index is fully exhausted and
  * no further pages exist; {@code false} means more results are available.</p>
  *
  * <h2>Exact document count</h2>
@@ -52,7 +50,7 @@ public final class SpanWalker {
     private final IndexSearcher searcher;
     private final SpanQuery spanQuery;
     private final Query filterQuery; // nullable
-    private final ResultsListener listener;
+    private final SpanListener listener;
 
     /**
      * Creates a natural-order span walker.
@@ -67,7 +65,7 @@ public SpanWalker(
             final IndexSearcher searcher,
             final SpanQuery spanQuery,
             final Query filterQuery,
-            final ResultsListener listener) throws IOException {
+            final SpanListener listener) throws IOException {
         this.searcher    = Objects.requireNonNull(searcher,  "searcher");
         Objects.requireNonNull(spanQuery, "spanQuery");
         this.spanQuery = (SpanQuery) searcher.rewrite(spanQuery);