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

- Made Javadoc for add method more clear (Leonid Portnoy) 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150342 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Otis Gospodnetic 2004-05-14 12:56:29 +00:00
parent b48c75c33c
commit b72f93d1b5
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -53,19 +53,20 @@ public class BooleanQuery extends Query {
public BooleanQuery() {}
/** Adds a clause to a boolean query. Clauses may be:
<ul>
<li><code>required</code> which means that documents which <i>do not</i>
match this sub-query will <i>not</i> match the boolean query;
<li><code>prohibited</code> which means that documents which <i>do</i>
match this sub-query will <i>not</i> match the boolean query; or
<li>neither, in which case matched documents are neither prohibited from
nor required to match the sub-query.
</ul>
It is an error to specify a clause as both <code>required</code> and
<code>prohibited</code>.
*
* @see #getMaxClauseCount()
*/
* <ul>
* <li><code>required</code> which means that documents which <i>do not</i>
* match this sub-query will <i>not</i> match the boolean query;
* <li><code>prohibited</code> which means that documents which <i>do</i>
* match this sub-query will <i>not</i> match the boolean query; or
* <li>neither, in which case matched documents are neither prohibited from
* nor required to match the sub-query. However, a document must match at
* least 1 sub-query to match the boolean query.
* </ul>
* It is an error to specify a clause as both <code>required</code> and
* <code>prohibited</code>.
*
* @see #getMaxClauseCount()
*/
public void add(Query query, boolean required, boolean prohibited) {
add(new BooleanClause(query, required, prohibited));
}