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.
TermQuerys, PhraseQuerys or other BooleanQuerys.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA builder for boolean queries. -
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.booleanCompares the specified object with this boolean query for equality.getClauses(BooleanClause.Occur occur) Return the collection of queries for the givenBooleanClause.Occur.intGets the minimum number of the optional BooleanClauses which must be satisfied.inthashCode()Override and implement query hash code properly in a subclass.final Iterator<BooleanClause> iterator()Returns an iterator on the clauses in this query.rewrite(IndexSearcher indexSearcher) Expert: called to re-write queries into primitive queries.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, sameClassAs, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
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. -
getClauses
Return the collection of queries for the givenBooleanClause.Occur. -
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 classQuery- Parameters:
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: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.
- Overrides:
rewritein classQuery- Throws:
IOException- See Also:
-
visit
Description copied from class:QueryRecurse 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.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
- 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.
-