Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve javadoc 

PR:30685
Submitted by: Paul Elschot


git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150619 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Naber 2004-10-19 19:51:35 +00:00
parent 8a37ed97d9
commit 5869962cf0
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/java/org/apache/lucene/search/BooleanQuery.java
View File

@ -25,9 +25,14 @@ import org.apache.lucene.index.IndexReader;
*/
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
* {@link 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 @@ public class BooleanQuery extends Query {
/** Return the maximum number of clauses permitted, 1024 by default.
* Attempts to add more than the permitted number of clauses cause {@link
* TooManyClauses} to be thrown.*/
* TooManyClauses} to be thrown.
* @see #maxClauseCount
*/
public static int getMaxClauseCount() { return maxClauseCount; }
/** Set the maximum number of clauses permitted. */