You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by mi...@apache.org on 2007/06/09 16:35:02 UTC
svn commit: r545754 -
/lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/IndexWriter.java
Author: mikemccand
Date: Sat Jun 9 07:35:01 2007
New Revision: 545754
URL: http://svn.apache.org/viewvc?view=rev&rev=545754
Log:
LUCENE-924: small improvements to IndexWriter's javadocs
Modified:
lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/IndexWriter.java
Modified: lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/IndexWriter.java?view=diff&rev=545754&r1=545753&r2=545754
==============================================================================
--- lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/branches/lucene_2_2/src/java/org/apache/lucene/index/IndexWriter.java Sat Jun 9 07:35:01 2007
@@ -252,7 +252,10 @@
private boolean closed;
/**
- * @throws AlreadyClosedException if this IndexWriter is closed
+ * Used internally to throw an {@link
+ * AlreadyClosedException} if this IndexWriter has been
+ * closed.
+ * @throws AlreadyClosedException if this IndexWriter is
*/
protected final void ensureOpen() throws AlreadyClosedException {
if (closed) {
@@ -644,6 +647,8 @@
}
/**
+ * Returns the largest number of documents allowed in a
+ * single segment.
* @see #setMaxMergeDocs
*/
public int getMaxMergeDocs() {
@@ -669,6 +674,8 @@
}
/**
+ * Returns the maximum number of terms that will be
+ * indexed for a single field in a document.
* @see #setMaxFieldLength
*/
public int getMaxFieldLength() {
@@ -694,6 +701,8 @@
}
/**
+ * Returns the number of buffered added documents that will
+ * trigger a flush.
* @see #setMaxBufferedDocs
*/
public int getMaxBufferedDocs() {
@@ -718,6 +727,8 @@
}
/**
+ * Returns the number of buffered deleted terms that will
+ * trigger a flush.
* @see #setMaxBufferedDeleteTerms
*/
public int getMaxBufferedDeleteTerms() {
@@ -743,6 +754,9 @@
}
/**
+ * Returns the number of segments that are merged at once
+ * and also controls the total number of segments allowed
+ * to accumulate in the index.
* @see #setMergeFactor
*/
public int getMergeFactor() {
@@ -759,6 +773,8 @@
}
/**
+ * Returns the current default infoStream for newly
+ * instantiated IndexWriters.
* @see #setDefaultInfoStream
*/
public static PrintStream getDefaultInfoStream() {
@@ -776,6 +792,7 @@
}
/**
+ * Returns the current infoStream in use by this writer.
* @see #setInfoStream
*/
public PrintStream getInfoStream() {
@@ -793,6 +810,7 @@
}
/**
+ * Returns allowed timeout when acquiring the write lock.
* @see #setWriteLockTimeout
*/
public long getWriteLockTimeout() {
@@ -809,6 +827,8 @@
}
/**
+ * Returns default write lock timeout for newly
+ * instantiated IndexWriters.
* @see #setDefaultWriteLockTimeout
*/
public static long getDefaultWriteLockTimeout() {
@@ -1695,6 +1715,11 @@
throws IOException {
}
+ /**
+ * Used internally to trigger a flush if the number of
+ * buffered added documents or buffered deleted terms are
+ * large enough.
+ */
protected final void maybeFlushRamSegments() throws CorruptIndexException, IOException {
// A flush is triggered if enough new documents are buffered or
// if enough delete terms are buffered