Mailing-List: contact java-commits-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r795537 - in /lucene/java/trunk: ./
 src/java/org/apache/lucene/index/
Date: Sun, 19 Jul 2009 13:29:39 -0000
To: java-commits@lucene.apache.org
From: mikemccand@apache.org
Message-Id: <20090719132939.E432123888D2@eris.apache.org>

Author: mikemccand
Date: Sun Jul 19 13:29:39 2009
New Revision: 795537

URL: http://svn.apache.org/viewvc?rev=795537&view=rev
Log:
LUCENE-1742: make SegmentReader, SegmentInfo, SegmentInfos public as 'expert' and 'subject-to-change-suddenly' APIs

Modified:
    lucene/java/trunk/CHANGES.txt
    lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
    lucene/java/trunk/src/java/org/apache/lucene/index/LogMergePolicy.java
    lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfo.java
    lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfos.java
    lucene/java/trunk/src/java/org/apache/lucene/index/SegmentReader.java

Modified: lucene/java/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/java/trunk/CHANGES.txt?rev=795537&r1=795536&r2=795537&view=diff
==============================================================================
--- lucene/java/trunk/CHANGES.txt (original)
+++ lucene/java/trunk/CHANGES.txt Sun Jul 19 13:29:39 2009
@@ -314,6 +314,10 @@
     StopAnalzyer and replace it with an immutable implementation of 
     CharArraySet.  (Simon Willnauer via Mark Miller)
 
+31. LUCENE-1742: SegmentInfos, SegmentInfo and SegmentReader have been
+    made public as expert, experimental APIs.  These APIs may suddenly
+    change from release to release (Jason Rutherglen via Mike
+    McCandless).
 
 Bug fixes
 

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java?rev=795537&r1=795536&r2=795537&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java Sun Jul 19 13:29:39 2009
@@ -493,14 +493,14 @@
     }
     
     // used only by asserts
-    synchronized boolean infoIsLive(SegmentInfo info) {
+    public synchronized boolean infoIsLive(SegmentInfo info) {
       int idx = segmentInfos.indexOf(info);
       assert idx != -1;
       assert segmentInfos.get(idx) == info;
       return true;
     }
 
-    synchronized SegmentInfo mapToLive(SegmentInfo info) {
+    public synchronized SegmentInfo mapToLive(SegmentInfo info) {
       int idx = segmentInfos.indexOf(info);
       if (idx != -1) {
         info = (SegmentInfo) segmentInfos.get(idx);
@@ -508,11 +508,23 @@
       return info;
     }
     
-    synchronized void release(SegmentReader sr) throws IOException {
+    /**
+     * Release the segment reader (i.e. decRef it and close if there
+     * are no more references.
+     * @param sr
+     * @throws IOException
+     */
+    public synchronized void release(SegmentReader sr) throws IOException {
       release(sr, false);
     }
-
-    synchronized void release(SegmentReader sr, boolean drop) throws IOException {
+    
+    /**
+     * Release the segment reader (i.e. decRef it and close if there
+     * are no more references.
+     * @param sr
+     * @throws IOException
+     */
+    public synchronized void release(SegmentReader sr, boolean drop) throws IOException {
 
       final boolean pooled = readerMap.containsKey(sr.getSegmentInfo());
 
@@ -552,7 +564,7 @@
     
     /** Remove all our references to readers, and commits
      *  any pending changes. */
-    public synchronized void close() throws IOException {
+    synchronized void close() throws IOException {
       Iterator iter = readerMap.entrySet().iterator();
       while (iter.hasNext()) {
         Map.Entry ent = (Map.Entry) iter.next();
@@ -582,7 +594,11 @@
       }
     }
     
-    public synchronized void commit() throws IOException {
+    /**
+     * Commit all segment reader in the pool.
+     * @throws IOException
+     */
+    synchronized void commit() throws IOException {
       Iterator iter = readerMap.entrySet().iterator();
       while (iter.hasNext()) {
         Map.Entry ent = (Map.Entry) iter.next();
@@ -604,9 +620,11 @@
       }
     }
     
-    // Returns a ref to a clone.  NOTE: this clone is not
-    // enrolled in the pool, so you should simply close()
-    // it when you're done (ie, do not call release()).
+    /**
+     * Returns a ref to a clone.  NOTE: this clone is not
+     * enrolled in the pool, so you should simply close()
+     * it when you're done (ie, do not call release()).
+     */
     public synchronized SegmentReader getReadOnlyClone(SegmentInfo info, boolean doOpenStores, int termInfosIndexDivisor) throws IOException {
       SegmentReader sr = get(info, doOpenStores, BufferedIndexInput.BUFFER_SIZE, termInfosIndexDivisor);
       try {
@@ -616,11 +634,30 @@
       }
     }
    
-    // Returns a ref
+    /**
+     * Obtain a SegmentReader from the readerPool.  The reader
+     * must be returned by calling {@link #release(SegmentReader)}
+     * @see #release(SegmentReader)
+     * @param info
+     * @param doOpenStores
+     * @return 
+     * @throws IOException
+     */
     public synchronized SegmentReader get(SegmentInfo info, boolean doOpenStores) throws IOException {
       return get(info, doOpenStores, BufferedIndexInput.BUFFER_SIZE, IndexReader.DEFAULT_TERMS_INDEX_DIVISOR);
     }
-
+    /**
+     * Obtain a SegmentReader from the readerPool.  The reader
+     * must be returned by calling {@link #release(SegmentReader)}
+     * 
+     * @see #release(SegmentReader)
+     * @param info
+     * @param doOpenStores
+     * @param readBufferSize
+     * @param termsIndexDivisor
+     * @return
+     * @throws IOException
+     */
     public synchronized SegmentReader get(SegmentInfo info, boolean doOpenStores, int readBufferSize, int termsIndexDivisor) throws IOException {
 
       if (poolReaders) {
@@ -664,6 +701,26 @@
     }
   }
   
+  /**
+   * Obtain the number of deleted docs for a pooled reader.
+   * If the reader isn't being pooled, the segmentInfo's 
+   * delCount is returned.
+   */
+  public int numDeletedDocs(SegmentInfo info) throws IOException {
+    SegmentReader reader = readerPool.getIfExists(info);
+    try {
+      if (reader != null) {
+        return reader.numDeletedDocs();
+      } else {
+        return info.getDelCount();
+      }
+    } finally {
+      if (reader != null) {
+        readerPool.release(reader);
+      }
+    }
+  }
+  
   synchronized void acquireWrite() {
     assert writeThread != Thread.currentThread();
     while(writeThread != null || readCount > 0)

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/LogMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/LogMergePolicy.java?rev=795537&r1=795536&r2=795537&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/LogMergePolicy.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/LogMergePolicy.java Sun Jul 19 13:29:39 2009
@@ -65,7 +65,7 @@
   
   private boolean useCompoundFile = true;
   private boolean useCompoundDocStore = true;
-  private IndexWriter writer;
+  protected IndexWriter writer;
 
   protected boolean verbose() {
     return writer != null && writer.verbose();
@@ -154,7 +154,8 @@
 
   protected long sizeDocs(SegmentInfo info) throws IOException {
     if (calibrateSizeByDeletes) {
-      return (info.docCount - (long)info.getDelCount());
+      int delCount = writer.numDeletedDocs(info);
+      return (info.docCount - (long)delCount);
     } else {
       return info.docCount;
     }
@@ -163,7 +164,8 @@
   protected long sizeBytes(SegmentInfo info) throws IOException {
     long byteSize = info.sizeInBytes();
     if (calibrateSizeByDeletes) {
-      float delRatio = (info.docCount <= 0 ? 0.0f : ((float)info.getDelCount() / (float)info.docCount));
+      int delCount = writer.numDeletedDocs(info);
+      float delRatio = (info.docCount <= 0 ? 0.0f : ((float)delCount / (float)info.docCount));
       return (info.docCount <= 0 ?  byteSize : (long)((float)byteSize * (1.0f - delRatio)));
     } else {
       return byteSize;
@@ -186,12 +188,13 @@
       (numToOptimize != 1 || isOptimized(writer, optimizeInfo));
   }
 
-  /** Returns true if this single nfo is optimized (has no
+  /** Returns true if this single info is optimized (has no
    *  pending norms or deletes, is in the same dir as the
    *  writer, and matches the current compound file setting */
   private boolean isOptimized(IndexWriter writer, SegmentInfo info)
     throws IOException {
-    return !info.hasDeletions() &&
+    boolean hasDeletions = writer.numDeletedDocs(info) > 0;
+    return !hasDeletions &&
       !info.hasSeparateNorms() &&
       info.dir == writer.getDirectory() &&
       info.getUseCompoundFile() == useCompoundFile;
@@ -303,16 +306,8 @@
     int firstSegmentWithDeletions = -1;
     for(int i=0;i<numSegments;i++) {
       final SegmentInfo info = segmentInfos.info(i);
-      boolean deletionsInRAM = false;
-      SegmentReader sr = writer.readerPool.getIfExists(info);
-      try {
-        deletionsInRAM = sr != null && sr.hasDeletions();
-      } finally {
-        if (sr != null) {
-          writer.readerPool.release(sr);
-        }
-      }
-      if (info.hasDeletions() || deletionsInRAM) {
+      int delCount = writer.numDeletedDocs(info);
+      if (delCount > 0) {
         if (verbose())
           message("  segment " + info.name + " has deletions");
         if (firstSegmentWithDeletions == -1)

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfo.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfo.java?rev=795537&r1=795536&r2=795537&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfo.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfo.java Sun Jul 19 13:29:39 2009
@@ -28,7 +28,14 @@
 import java.util.ArrayList;
 import java.util.Collections;
 
-final class SegmentInfo {
+/**
+ * Information about a segment such as it's name, directory, and files related
+ * to the segment.
+ * 
+ * * <p><b>NOTE:</b> This API is new and still experimental
+ * (subject to change suddenly in the next release)</p>
+ */
+public final class SegmentInfo {
 
   static final int NO = -1;          // e.g. no norms; no deletes;
   static final int YES = 1;          // e.g. have norms; have deletes;
@@ -150,7 +157,7 @@
   }
 
   // returns Map<String, String>
-  Map getDiagnostics() {
+  public Map getDiagnostics() {
     return diagnostics;
   }
 
@@ -251,7 +258,7 @@
 
   /** Returns total size in bytes of all of files used by
    *  this segment. */
-  long sizeInBytes() throws IOException {
+  public long sizeInBytes() throws IOException {
     if (sizeInBytes == -1) {
       List files = files();
       final int size = files.size();
@@ -267,7 +274,7 @@
     return sizeInBytes;
   }
 
-  boolean hasDeletions()
+  public boolean hasDeletions()
     throws IOException {
     // Cases:
     //
@@ -325,7 +332,7 @@
     return si;
   }
 
-  String getDelFileName() {
+  public String getDelFileName() {
     if (delGen == NO) {
       // In this case we know there is no deletion filename
       // against this segment
@@ -341,7 +348,7 @@
    *
    * @param fieldNumber the field index to check
    */
-  boolean hasSeparateNorms(int fieldNumber)
+  public boolean hasSeparateNorms(int fieldNumber)
     throws IOException {
     if ((normGen == null && preLockless) || (normGen != null && normGen[fieldNumber] == CHECK_DIR)) {
       // Must fallback to directory file exists check:
@@ -357,7 +364,7 @@
   /**
    * Returns true if any fields in this segment have separate norms.
    */
-  boolean hasSeparateNorms()
+  public boolean hasSeparateNorms()
     throws IOException {
     if (normGen == null) {
       if (!preLockless) {
@@ -424,7 +431,7 @@
    *
    * @param number field index
    */
-  String getNormFileName(int number) throws IOException {
+  public String getNormFileName(int number) throws IOException {
     String prefix;
 
     long gen;
@@ -470,7 +477,7 @@
    * Returns true if this segment is stored as a compound
    * file; else, false.
    */
-  boolean getUseCompoundFile() throws IOException {
+  public boolean getUseCompoundFile() throws IOException {
     if (isCompoundFile == NO) {
       return false;
     } else if (isCompoundFile == YES) {
@@ -480,7 +487,7 @@
     }
   }
 
-  int getDelCount() throws IOException {
+  public int getDelCount() throws IOException {
     if (delCount == -1) {
       if (hasDeletions()) {
         final String delFileName = getDelFileName();
@@ -497,11 +504,11 @@
     assert delCount <= docCount;
   }
 
-  int getDocStoreOffset() {
+  public int getDocStoreOffset() {
     return docStoreOffset;
   }
   
-  boolean getDocStoreIsCompoundFile() {
+  public boolean getDocStoreIsCompoundFile() {
     return docStoreIsCompoundFile;
   }
   
@@ -510,7 +517,7 @@
     clearFiles();
   }
   
-  String getDocStoreSegment() {
+  public String getDocStoreSegment() {
     return docStoreSegment;
   }
   
@@ -559,7 +566,7 @@
     clearFiles();
   }
 
-  boolean getHasProx() {
+  public boolean getHasProx() {
     return hasProx;
   }
 

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfos.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfos.java?rev=795537&r1=795536&r2=795537&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfos.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/SegmentInfos.java Sun Jul 19 13:29:39 2009
@@ -34,7 +34,14 @@
 import java.util.HashMap;
 import java.util.Map;
 
-final class SegmentInfos extends Vector {
+/**
+ * A collection of segmentInfo objects with methods for operating on
+ * those segments in relation to the file system.
+ * 
+ * <p><b>NOTE:</b> This API is new and still experimental
+ * (subject to change suddenly in the next release)</p>
+ */
+public final class SegmentInfos extends Vector {
 
   /** The file format version, a negative number. */
   /* Works since counter, the old 1st entry, is always >= 0 */
@@ -767,7 +774,7 @@
     version = other.version;
   }
 
-  public final void rollbackCommit(Directory dir) throws IOException {
+  final void rollbackCommit(Directory dir) throws IOException {
     if (pendingSegnOutput != null) {
       try {
         pendingSegnOutput.close();
@@ -796,7 +803,7 @@
    *  end, so that it is not visible to readers.  Once this
    *  is called you must call {@link #finishCommit} to complete
    *  the commit or {@link #rollbackCommit} to abort it. */
-  public final void prepareCommit(Directory dir) throws IOException {
+  final void prepareCommit(Directory dir) throws IOException {
     if (pendingSegnOutput != null)
       throw new IllegalStateException("prepareCommit was already called");
     write(dir);
@@ -822,7 +829,7 @@
     return files;
   }
 
-  public final void finishCommit(Directory dir) throws IOException {
+  final void finishCommit(Directory dir) throws IOException {
     if (pendingSegnOutput == null)
       throw new IllegalStateException("prepareCommit was not called");
     boolean success = false;
@@ -882,12 +889,12 @@
 
   /** Writes & syncs to the Directory dir, taking care to
    *  remove the segments file on exception */
-  public final void commit(Directory dir) throws IOException {
+  final void commit(Directory dir) throws IOException {
     prepareCommit(dir);
     finishCommit(dir);
   }
 
-  synchronized String segString(Directory directory) {
+  public synchronized String segString(Directory directory) {
     StringBuffer buffer = new StringBuffer();
     final int count = size();
     for(int i = 0; i < count; i++) {
@@ -906,7 +913,7 @@
     return userData;
   }
 
-  public void setUserData(Map data) {
+  void setUserData(Map data) {
     if (data == null) {
       userData = Collections.EMPTY_MAP;
     } else {
@@ -925,7 +932,7 @@
   }
 
   // Used only for testing
-  boolean hasExternalSegments(Directory dir) {
+  public boolean hasExternalSegments(Directory dir) {
     final int numSegments = size();
     for(int i=0;i<numSegments;i++)
       if (info(i).dir != dir)

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/SegmentReader.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/SegmentReader.java?rev=795537&r1=795536&r2=795537&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/SegmentReader.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/SegmentReader.java Sun Jul 19 13:29:39 2009
@@ -39,7 +39,11 @@
 import org.apache.lucene.util.CloseableThreadLocal;
 
 /** @version $Id */
-class SegmentReader extends IndexReader implements Cloneable {
+/**
+ * <p><b>NOTE:</b> This API is new and still experimental
+ * (subject to change suddenly in the next release)</p>
+ */
+public class SegmentReader extends IndexReader implements Cloneable {
   protected boolean readOnly;
 
   private SegmentInfo si;
@@ -676,7 +680,7 @@
   
   /**
    * Clones the norm bytes.  May be overridden by subclasses.  New and experimental.
-   * @param bv Byte array to clone
+   * @param bytes Byte array to clone
    * @return New BitVector
    */
   protected byte[] cloneNormBytes(byte[] bytes) {