dnaber 2004/10/19 12:51:36
Modified: src/java/org/apache/lucene/search BooleanQuery.java
Log:
improve javadoc
PR:30685
Submitted by: Paul Elschot
Revision Changes Path
1.26 +11 -4
jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java
Index: BooleanQuery.java
===================================================================
RCS file:
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- BooleanQuery.java 27 Aug 2004 20:09:12 -0000 1.25
+++ BooleanQuery.java 19 Oct 2004 19:51:35 -0000 1.26
@@ -25,9 +25,14 @@
*/
public class BooleanQuery extends Query {
- /**
- * Default value is 1024. Use <code>org.apache.lucene.maxClauseCount</code>
- * system property to override.
+ /** The maximum number of clauses permitted. Default value is 1024.
+ * Use the <code>org.apache.lucene.maxClauseCount</code> system property to
override.
+ * <p>TermQuery clauses are generated from for example prefix queries and fuzzy
queries.
+ * Each TermQuery needs some buffer space during search, so this parameter
indirectly
+ * controls the maximum buffer requirements for query search. Normally the buffers
+ * are allocated by the JVM. When using for example
+ * [EMAIL PROTECTED] org.apache.lucene.store.MMapDirectory} the buffering is left
to the
+ * operating system.</p>
*/
public static int maxClauseCount =
Integer.parseInt(System.getProperty("org.apache.lucene.maxClauseCount",
@@ -39,7 +44,9 @@
/** Return the maximum number of clauses permitted, 1024 by default.
* Attempts to add more than the permitted number of clauses cause [EMAIL
PROTECTED]
- * TooManyClauses} to be thrown.*/
+ * TooManyClauses} to be thrown.
+ * @see #maxClauseCount
+ */
public static int getMaxClauseCount() { return maxClauseCount; }
/** Set the maximum number of clauses permitted. */
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
