Added MultiReader, an IndexReader that combines multiple other IndexReaders.

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150205 13f79535-47bb-0310-9956-ffa450edef68

CHANGES.txt

@@ -51,6 +51,8 @@ $Id$
     one that delegates through that of the Searcher.  (Julien Nioche
     via Cutting)
 
+ 9. Added MultiReader, an IndexReader that combines multiple other
+    IndexReaders.  (Cutting)
 
 1.3 final
 

src/java/org/apache/lucene/index/FilterIndexReader.java

@@ -128,6 +128,9 @@ public class FilterIndexReader extends IndexReader {
   public void undeleteAll() throws IOException { in.undeleteAll(); }
 
   public byte[] norms(String f) throws IOException { return in.norms(f); }
+  public void norms(String f, byte[] bytes, int offset) throws IOException {
+    in.norms(f, bytes, offset);
+  }
   public void setNorm(int d, String f, byte b) throws IOException {
     in.setNorm(d,f,b);
   }

src/java/org/apache/lucene/index/IndexReader.java

@@ -117,10 +117,10 @@ public abstract class IndexReader {
             if (infos.size() == 1) {		  // index is optimized
               return new SegmentReader(infos, infos.info(0), true);
             } else {
-                SegmentReader[] readers = new SegmentReader[infos.size()];
+                IndexReader[] readers = new IndexReader[infos.size()];
                 for (int i = 0; i < infos.size(); i++)
                   readers[i] = new SegmentReader(infos, infos.info(i), i==infos.size()-1);
-                return new SegmentsReader(infos, directory, readers);
+                return new MultiReader(directory, readers);
             }
           }
         }.run();
@@ -272,6 +272,14 @@ public abstract class IndexReader {
    */
   public abstract byte[] norms(String field) throws IOException;
 
+  /** Reads the byte-encoded normalization factor for the named field of every
+   *  document.  This is used by the search code to score documents.
+   *
+   * @see Field#setBoost(float)
+   */
+  public abstract void norms(String field, byte[] bytes, int offset)
+    throws IOException;
+
   /** Expert: Resets the normalization factor for the named field of the named
    * document.  The norm represents the product of the field's {@link
    * Field#setBoost(float) boost} and its {@link Similarity#lengthNorm(String,

src/java/org/apache/lucene/index/MultiReader.java

@@ -64,24 +64,28 @@ import java.util.Set;
 import org.apache.lucene.document.Document;
 import org.apache.lucene.store.Directory;
 
-/**
+/** An IndexReader which reads multiple indexes, appending their content.
- * FIXME: Describe class <code>SegmentsReader</code> here.
  *
  * @version $Id$
  */
-final class SegmentsReader extends IndexReader
+public class MultiReader extends IndexReader {
-{
+  private IndexReader[] readers;
-  protected SegmentReader[] readers;
+  private int[] starts;                           // 1st docno for each segment
-  protected int[] starts;			  // 1st docno for each segment
   private Hashtable normsCache = new Hashtable();
   private int maxDoc = 0;
   private int numDocs = -1;
   private boolean hasDeletions = false;
   
-  SegmentsReader(SegmentInfos sis, Directory directory, SegmentReader[] r) throws IOException {
+  /** Construct reading the named set of readers. */
+  public MultiReader(IndexReader[] readers) throws IOException {
+    this(readers.length == 0 ? null : readers[0].directory(), readers);
+  }
+
+  /** Construct reading the named set of readers. */
+  public MultiReader(Directory directory, IndexReader[] readers)
+    throws IOException {
     super(directory);
-    segmentInfos = sis;
+    this.readers = readers;
-    readers = r;
     starts = new int[readers.length + 1];	  // build starts array
     for (int i = 0; i < readers.length; i++) {
       starts[i] = maxDoc;
@@ -93,7 +97,7 @@ final class SegmentsReader extends IndexReader
     starts[readers.length] = maxDoc;
   }
 
-  public final synchronized int numDocs() {
+  public synchronized int numDocs() {
     if (numDocs == -1) {			  // check cache
       int n = 0;				  // cache miss--recompute
       for (int i = 0; i < readers.length; i++)
@@ -103,23 +107,23 @@ final class SegmentsReader extends IndexReader
     return numDocs;
   }
 
-  public final int maxDoc() {
+  public int maxDoc() {
     return maxDoc;
   }
 
-  public final Document document(int n) throws IOException {
+  public Document document(int n) throws IOException {
     int i = readerIndex(n);			  // find segment num
     return readers[i].document(n - starts[i]);	  // dispatch to segment reader
   }
 
-  public final boolean isDeleted(int n) {
+  public boolean isDeleted(int n) {
     int i = readerIndex(n);			  // find segment num
     return readers[i].isDeleted(n - starts[i]);	  // dispatch to segment reader
   }
 
   public boolean hasDeletions() { return hasDeletions; }
 
-  protected final synchronized void doDelete(int n) throws IOException {
+  protected synchronized void doDelete(int n) throws IOException {
     numDocs = -1;				  // invalidate cache
     int i = readerIndex(n);			  // find segment num
     readers[i].doDelete(n - starts[i]);		  // dispatch to segment reader
@@ -132,7 +136,7 @@ final class SegmentsReader extends IndexReader
     hasDeletions = false;
   }
 
-  private final int readerIndex(int n) {	  // find reader for doc n:
+  private int readerIndex(int n) {	  // find reader for doc n:
     int lo = 0;					  // search starts array
     int hi = readers.length - 1;                  // for first element less
 
@@ -153,7 +157,7 @@ final class SegmentsReader extends IndexReader
     return hi;
   }
 
-  public final synchronized byte[] norms(String field) throws IOException {
+  public synchronized byte[] norms(String field) throws IOException {
     byte[] bytes = (byte[])normsCache.get(field);
     if (bytes != null)
       return bytes;				  // cache hit
@@ -165,6 +169,16 @@ final class SegmentsReader extends IndexReader
     return bytes;
   }
 
+  public synchronized void norms(String field, byte[] result, int offset)
+    throws IOException {
+    byte[] bytes = (byte[])normsCache.get(field);
+    if (bytes != null)                            // cache hit
+      System.arraycopy(bytes, 0, result, offset, maxDoc());
+
+    for (int i = 0; i < readers.length; i++)      // read from segments
+      readers[i].norms(field, result, offset + starts[i]);
+  }
+
   public synchronized void setNorm(int n, String field, byte value)
     throws IOException {
     normsCache.remove(field);                     // clear cache
@@ -172,30 +186,30 @@ final class SegmentsReader extends IndexReader
     readers[i].setNorm(n-starts[i], field, value); // dispatch
   }
 
-  public final TermEnum terms() throws IOException {
+  public TermEnum terms() throws IOException {
-    return new SegmentsTermEnum(readers, starts, null);
+    return new MultiTermEnum(readers, starts, null);
   }
 
-  public final TermEnum terms(Term term) throws IOException {
+  public TermEnum terms(Term term) throws IOException {
-    return new SegmentsTermEnum(readers, starts, term);
+    return new MultiTermEnum(readers, starts, term);
   }
 
-  public final int docFreq(Term t) throws IOException {
+  public int docFreq(Term t) throws IOException {
     int total = 0;				  // sum freqs in segments
     for (int i = 0; i < readers.length; i++)
       total += readers[i].docFreq(t);
     return total;
   }
 
-  public final TermDocs termDocs() throws IOException {
+  public TermDocs termDocs() throws IOException {
-    return new SegmentsTermDocs(readers, starts);
+    return new MultiTermDocs(readers, starts);
   }
 
-  public final TermPositions termPositions() throws IOException {
+  public TermPositions termPositions() throws IOException {
-    return new SegmentsTermPositions(readers, starts);
+    return new MultiTermPositions(readers, starts);
   }
 
-  protected final synchronized void doClose() throws IOException {
+  protected synchronized void doClose() throws IOException {
     for (int i = 0; i < readers.length; i++)
       readers[i].close();
   }
@@ -207,7 +221,7 @@ final class SegmentsReader extends IndexReader
     // maintain a unique set of field names
     Set fieldSet = new HashSet();
     for (int i = 0; i < readers.length; i++) {
-        SegmentReader reader = readers[i];
+      IndexReader reader = readers[i];
       Collection names = reader.getFieldNames();
       // iterate through the field names and add them to the set
       for (Iterator iterator = names.iterator(); iterator.hasNext();) {
@@ -225,7 +239,7 @@ final class SegmentsReader extends IndexReader
     // maintain a unique set of field names
     Set fieldSet = new HashSet();
     for (int i = 0; i < readers.length; i++) {
-        SegmentReader reader = readers[i];
+      IndexReader reader = readers[i];
       Collection names = reader.getFieldNames(indexed);
       fieldSet.addAll(names);
     }
@@ -233,17 +247,17 @@ final class SegmentsReader extends IndexReader
   }
 }
 
-class SegmentsTermEnum extends TermEnum {
+class MultiTermEnum extends TermEnum {
   private SegmentMergeQueue queue;
 
   private Term term;
   private int docFreq;
 
-  SegmentsTermEnum(SegmentReader[] readers, int[] starts, Term t)
+  public MultiTermEnum(IndexReader[] readers, int[] starts, Term t)
     throws IOException {
     queue = new SegmentMergeQueue(readers.length);
     for (int i = 0; i < readers.length; i++) {
-      SegmentReader reader = readers[i];
+      IndexReader reader = readers[i];
       SegmentTermEnum termEnum;
 
       if (t != null) {
@@ -263,7 +277,7 @@ class SegmentsTermEnum extends TermEnum {
     }
   }
 
-  public final boolean next() throws IOException {
+  public boolean next() throws IOException {
     SegmentMergeInfo top = (SegmentMergeInfo)queue.top();
     if (top == null) {
       term = null;
@@ -285,21 +299,21 @@ class SegmentsTermEnum extends TermEnum {
     return true;
   }
 
-  public final Term term() {
+  public Term term() {
     return term;
   }
 
-  public final int docFreq() {
+  public int docFreq() {
     return docFreq;
   }
 
-  public final void close() throws IOException {
+  public void close() throws IOException {
     queue.close();
   }
 }
 
-class SegmentsTermDocs implements TermDocs {
+class MultiTermDocs implements TermDocs {
-  protected SegmentReader[] readers;
+  protected IndexReader[] readers;
   protected int[] starts;
   protected Term term;
 
@@ -309,21 +323,21 @@ class SegmentsTermDocs implements TermDocs {
   private SegmentTermDocs[] segTermDocs;
   protected SegmentTermDocs current;              // == segTermDocs[pointer]
 
-  SegmentsTermDocs(SegmentReader[] r, int[] s) {
+  public MultiTermDocs(IndexReader[] r, int[] s) {
     readers = r;
     starts = s;
 
     segTermDocs = new SegmentTermDocs[r.length];
   }
 
-  public final int doc() {
+  public int doc() {
     return base + current.doc;
   }
-  public final int freq() {
+  public int freq() {
     return current.freq;
   }
 
-  public final void seek(Term term) {
+  public void seek(Term term) {
     this.term = term;
     this.base = 0;
     this.pointer = 0;
@@ -334,7 +348,7 @@ class SegmentsTermDocs implements TermDocs {
     seek(termEnum.term());
   }
 
-  public final boolean next() throws IOException {
+  public boolean next() throws IOException {
     if (current != null && current.next()) {
       return true;
     } else if (pointer < readers.length) {
@@ -346,7 +360,7 @@ class SegmentsTermDocs implements TermDocs {
   }
 
   /** Optimized implementation. */
-  public final int read(final int[] docs, final int[] freqs)
+  public int read(final int[] docs, final int[] freqs)
       throws IOException {
     while (true) {
       while (current == null) {
@@ -388,12 +402,12 @@ class SegmentsTermDocs implements TermDocs {
     return result;
   }
 
-  protected SegmentTermDocs termDocs(SegmentReader reader)
+  protected SegmentTermDocs termDocs(IndexReader reader)
     throws IOException {
     return (SegmentTermDocs)reader.termDocs();
   }
 
-  public final void close() throws IOException {
+  public void close() throws IOException {
     for (int i = 0; i < segTermDocs.length; i++) {
       if (segTermDocs[i] != null)
         segTermDocs[i].close();
@@ -401,17 +415,17 @@ class SegmentsTermDocs implements TermDocs {
   }
 }
 
-class SegmentsTermPositions extends SegmentsTermDocs implements TermPositions {
+class MultiTermPositions extends MultiTermDocs implements TermPositions {
-  SegmentsTermPositions(SegmentReader[] r, int[] s) {
+  public MultiTermPositions(IndexReader[] r, int[] s) {
     super(r,s);
   }
 
-  protected final SegmentTermDocs termDocs(SegmentReader reader)
+  protected SegmentTermDocs termDocs(IndexReader reader)
        throws IOException {
     return (SegmentTermDocs)reader.termPositions();
   }
 
-  public final int nextPosition() throws IOException {
+  public int nextPosition() throws IOException {
     return ((SegmentTermPositions)current).nextPosition();
   }
 

src/java/org/apache/lucene/index/SegmentReader.java

@@ -357,7 +357,7 @@ final class SegmentReader extends IndexReader {
   }
 
   /** Read norms into a pre-allocated array. */
-  synchronized void norms(String field, byte[] bytes, int offset)
+  public synchronized void norms(String field, byte[] bytes, int offset)
     throws IOException {
 
     Norm norm = (Norm)norms.get(field);