lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r824498 - /lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
Date Mon, 12 Oct 2009 21:06:21 GMT
Author: mikemccand
Date: Mon Oct 12 21:06:21 2009
New Revision: 824498

URL: http://svn.apache.org/viewvc?rev=824498&view=rev
Log:
improve NRT javadocs

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java

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=824498&r1=824497&r2=824498&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 Mon Oct 12 21:06:21
2009
@@ -312,13 +312,20 @@
   private volatile boolean poolReaders;
   
   /**
-   * Returns a readonly reader containing all
-   * current updates.  Flush is called automatically.  This
+   * 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 made
-   * available for searching without closing the writer.
+   * 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