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>
A Query that matches documents matching boolean combinations of other queries, e.g.
TermQuery
s, PhraseQuery
s or other BooleanQuerys.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A builder for boolean queries.static class
Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionclauses()
Return a list of the clauses of thisBooleanQuery
.createWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Compares the specified object with this boolean query for equality.static int
Deprecated.int
Gets the minimum number of the optional BooleanClauses which must be satisfied.int
hashCode()
Override and implement query hash code properly in a subclass.final Iterator<BooleanClause>
iterator()
Returns an iterator on the clauses in this query.rewrite
(IndexReader reader) Expert: called to re-write queries into primitive queries.static void
setMaxClauseCount
(int maxClauseCount) Deprecated.Prints a user-readable version of this query.void
visit
(QueryVisitor visitor) Recurse through the query tree, visiting any child queriesMethods inherited from class org.apache.lucene.search.Query
classHash, 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 Details
-
getMaxClauseCount
Deprecated.Return the maximum number of clauses permitted, 1024 by default. Attempts to add more than the permitted number of clauses causeBooleanQuery.TooManyClauses
to be thrown.- See Also:
-
setMaxClauseCount
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
Return a list of the clauses of thisBooleanQuery
. -
iterator
Returns an iterator on the clauses in this query. It implements theIterable
interface to make it possible to do:for (BooleanClause clause : booleanQuery) {}
- Specified by:
iterator
in interfaceIterable<BooleanClause>
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-
rewrite
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.- Overrides:
rewrite
in classQuery
- Throws:
IOException
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries -
toString
Prints a user-readable version of this query. -
equals
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.SHOULD
clauses, regardless of the order - has the same
BooleanClause.Occur.MUST
clauses, regardless of the order - has the same set of
BooleanClause.Occur.FILTER
clauses, regardless of the order and regardless of duplicates - has the same set of
BooleanClause.Occur.MUST_NOT
clauses, regardless of the order and regardless of duplicates
- is also a
-
hashCode
public int hashCode()Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.
-
IndexSearcher.TooManyClauses