Package org.apache.lucene.search
Class QueryVisitor
java.lang.Object
org.apache.lucene.search.QueryVisitor
Allows recursion through a query tree
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final QueryVisitorA QueryVisitor implementation that does nothing -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanacceptField(String field) Whether or not this field is of interest to the visitorvoidconsumeTerms(Query query, Term... terms) Called by leaf queries that match on specific termsvoidconsumeTermsMatching(Query query, String field, Supplier<ByteRunAutomaton> automaton) Called by leaf queries that match on a class of termsgetSubVisitor(BooleanClause.Occur occur, Query parent) Pulls a visitor instance for visiting child clauses of a querystatic QueryVisitortermCollector(Set<Term> termSet) Builds aQueryVisitorinstance that collects all terms that may match a queryvoidCalled by leaf queries that do not match on terms
-
Field Details
-
EMPTY_VISITOR
A QueryVisitor implementation that does nothing
-
-
Constructor Details
-
QueryVisitor
public QueryVisitor()
-
-
Method Details
-
consumeTerms
Called by leaf queries that match on specific terms- Parameters:
query- the leaf queryterms- the terms the query will match on
-
consumeTermsMatching
Called by leaf queries that match on a class of terms- Parameters:
query- the leaf queryfield- the field queried againstautomaton- a supplier for an automaton defining which terms match- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
visitLeaf
Called by leaf queries that do not match on terms- Parameters:
query- the query
-
acceptField
Whether or not this field is of interest to the visitorImplement this to avoid collecting terms from heavy queries such as
TermInSetQuerythat are not running on fields of interest -
getSubVisitor
Pulls a visitor instance for visiting child clauses of a queryThe default implementation returns
this, unlessoccuris equal toBooleanClause.Occur.MUST_NOTin which case it returnsEMPTY_VISITOR- Parameters:
occur- the relationship between the parent and its childrenparent- the query visited
-
termCollector
Builds aQueryVisitorinstance that collects all terms that may match a query- Parameters:
termSet- aSetto add collected terms to
-