Package org.apache.lucene.search
Class BooleanQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.BooleanQuery
-
- All Implemented Interfaces:
Iterable<BooleanClause>
public class BooleanQuery extends Query implements Iterable<BooleanClause>
A Query that matches documents matching boolean combinations of other queries, e.g.TermQuerys,PhraseQuerys or other BooleanQuerys.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBooleanQuery.BuilderA builder for boolean queries.static classBooleanQuery.TooManyClausesDeprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description List<BooleanClause>clauses()Return a list of the clauses of thisBooleanQuery.WeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)Expert: Constructs an appropriate Weight implementation for this query.booleanequals(Object o)Compares the specified object with this boolean query for equality.static intgetMaxClauseCount()Deprecated.intgetMinimumNumberShouldMatch()Gets the minimum number of the optional BooleanClauses which must be satisfied.inthashCode()Override and implement query hash code properly in a subclass.Iterator<BooleanClause>iterator()Returns an iterator on the clauses in this query.Queryrewrite(IndexSearcher indexSearcher)Expert: called to re-write queries into primitive queries.static voidsetMaxClauseCount(int maxClauseCount)Deprecated.StringtoString(String field)Prints a user-readable version of this query.voidvisit(QueryVisitor visitor)Recurse through the query tree, visiting any child queries.-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
getMaxClauseCount
@Deprecated public static int getMaxClauseCount()
Deprecated.Return the maximum number of clauses permitted, 1024 by default. Attempts to add more than the permitted number of clauses causeBooleanQuery.TooManyClausesto be thrown.- See Also:
IndexSearcher.setMaxClauseCount(int)
-
setMaxClauseCount
@Deprecated public static void setMaxClauseCount(int maxClauseCount)
Deprecated.Set the maximum number of clauses permitted per BooleanQuery. Default value is 1024.
-
getMinimumNumberShouldMatch
public int getMinimumNumberShouldMatch()
Gets the minimum number of the optional BooleanClauses which must be satisfied.
-
clauses
public List<BooleanClause> clauses()
Return a list of the clauses of thisBooleanQuery.
-
iterator
public final Iterator<BooleanClause> iterator()
Returns an iterator on the clauses in this query. It implements theIterableinterface to make it possible to do:for (BooleanClause clause : booleanQuery) {}- Specified by:
iteratorin interfaceIterable<BooleanClause>
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
Description copied from class:QueryExpert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeightin classQueryscoreMode- How the produced scorers will be consumed.boost- The boost that is propagated by the parent queries.- Throws:
IOException
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
Description copied from class:QueryExpert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.Callers are expected to call
rewritemultiple times if necessary, until the rewritten query is the same as the original query.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.
- Overrides:
rewritein classQuery- Throws:
IOException- See Also:
IndexSearcher.rewrite(Query)
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:QueryRecurse through the query tree, visiting any child queries.
-
equals
public boolean equals(Object o)
Compares the specified object with this boolean query for equality. Returns true if and only if the provided object- is also a
BooleanQuery, - has the same value of
getMinimumNumberShouldMatch() - has the same
BooleanClause.Occur.SHOULDclauses, regardless of the order - has the same
BooleanClause.Occur.MUSTclauses, regardless of the order - has the same set of
BooleanClause.Occur.FILTERclauses, regardless of the order and regardless of duplicates - has the same set of
BooleanClause.Occur.MUST_NOTclauses, regardless of the order and regardless of duplicates
- Specified by:
equalsin classQuery- See Also:
Query.sameClassAs(Object),Query.classHash()
- is also a
-
hashCode
public int hashCode()
Description copied from class:QueryOverride and implement query hash code properly in a subclass. This is required so thatQueryCacheworks properly.- Specified by:
hashCodein classQuery- See Also:
Query.equals(Object)
-
-