lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r825116 - /lucene/java/branches/lucene_2_9/src/java/org/apache/lucene/index/IndexWriter.java
Date Wed, 14 Oct 2009 12:54:19 GMT
Author: mikemccand
Date: Wed Oct 14 12:54:19 2009
New Revision: 825116

URL: http://svn.apache.org/viewvc?rev=825116&view=rev
Log:
back port javadoc improvements for IndexWriter.getReader

Modified:
    lucene/java/branches/lucene_2_9/src/java/org/apache/lucene/index/IndexWriter.java

Modified: lucene/java/branches/lucene_2_9/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/lucene_2_9/src/java/org/apache/lucene/index/IndexWriter.java?rev=825116&r1=825115&r2=825116&view=diff
==============================================================================
--- lucene/java/branches/lucene_2_9/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/branches/lucene_2_9/src/java/org/apache/lucene/index/IndexWriter.java Wed
Oct 14 12:54:19 2009
@@ -385,13 +385,20 @@
   private volatile boolean poolReaders;
   
   /**
-   * Expert: returns a readonly reader containing all
-   * current updates.  Flush is called automatically.  This
-   * provides "near real-time" searching, in that changes
-   * made during an IndexWriter session can be made
-   * available for searching without closing the writer.
+   * Expert: returns a readonly reader, covering all
+   * committed as well as un-committed changes to the index.
+   * This provides "near real-time" searching, in that
+   * changes made during an IndexWriter session can be
+   * quickly made available for searching without closing
+   * the writer nor calling {@link #commit}.
+   *
+   * <p>Note that this is functionally equivalent to calling
+   * {#commit} and then using {@link IndexReader#open} to
+   * open a new reader.  But the turarnound time of this
+   * method should be faster since it avoids the potentially
+   * costly {@link #commit}.<p>
    *
-   * <p>It's near real-time because there is no hard
+   * <p>It's <i>near</i> real-time because there is no hard
    * guarantee on how quickly you can get a new reader after
    * making changes with IndexWriter.  You'll have to
    * experiment in your situation to determine if it's



Mime
View raw message