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

BooleanClause javadoc update: LUCENE-615 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@416951 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yonik Seeley 2006-06-24 20:42:37 +00:00
parent daee07ee37
commit 6e86efb527
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/java/org/apache/lucene/search/BooleanClause.java
View File

@ -21,7 +21,7 @@ import org.apache.lucene.util.Parameter;
/** A clause in a BooleanQuery. */ /** A clause in a BooleanQuery. */
public class BooleanClause implements java.io.Serializable { public class BooleanClause implements java.io.Serializable {
/** Specifies how terms may occur in matching documents. */ /** Specifies how clauses are to occur in matching documents. */
public static final class Occur extends Parameter implements java.io.Serializable { public static final class Occur extends Parameter implements java.io.Serializable {
private Occur(String name) { private Occur(String name) {
@ -35,24 +35,24 @@ public class BooleanClause implements java.io.Serializable {
return ""; return "";
} }
/** Use this operator for terms that <i>must</i> appear in the matching documents. */ /** Use this operator for clauses that <i>must</i> appear in the matching documents. */
public static final Occur MUST = new Occur("MUST"); public static final Occur MUST = new Occur("MUST");
/** Use this operator for terms that <i>should</i> appear in the /** Use this operator for clauses that <i>should</i> appear in the
* matching documents. For a BooleanQuery with two <code>SHOULD</code> * matching documents. For a BooleanQuery with two <code>SHOULD</code>
* subqueries, at least one of the queries must appear in the matching documents. */ * subqueries, at least one of the clauses must appear in the matching documents. */
public static final Occur SHOULD = new Occur("SHOULD"); public static final Occur SHOULD = new Occur("SHOULD");
/** Use this operator for terms that <i>must not</i> appear in the matching documents. /** Use this operator for clauses that <i>must not</i> appear in the matching documents.
* Note that it is not possible to search for queries that only consist * Note that it is not possible to search for queries that only consist
* of a <code>MUST_NOT</code> query. */ * of a <code>MUST_NOT</code> clause. */
public static final Occur MUST_NOT = new Occur("MUST_NOT"); public static final Occur MUST_NOT = new Occur("MUST_NOT");
} }
/** The query whose matching documents are combined by the boolean query. /** The query whose matching documents are combined by the boolean query.
*/ */
private Query query; // TODO: decrease visibility for Lucene 2.0 private Query query;
private Occur occur = Occur.SHOULD; private Occur occur;
/** Constructs a BooleanClause. /** Constructs a BooleanClause.