Module org.apache.lucene.highlighter

Package org.apache.lucene.search.highlight

Class QueryTermExtractor.BoostedTermExtractor

java.lang.Object

org.apache.lucene.search.QueryVisitor

org.apache.lucene.search.highlight.QueryTermExtractor.BoostedTermExtractor

Enclosing class:

QueryTermExtractor

private static class QueryTermExtractor.BoostedTermExtractor
extends QueryVisitor

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final float	boost
(package private) final Predicate<String>	fieldSelector
(package private) final boolean	includeProhibited
(package private) final Set<WeightedTerm>	terms

Fields inherited from class org.apache.lucene.search.QueryVisitor

EMPTY_VISITOR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BoostedTermExtractor(float boost, Set<WeightedTerm> terms, boolean includeProhibited, Predicate<String> fieldSelector)

Method Summary

Modifier and Type	Method	Description
boolean	acceptField(String field)	Whether or not this field is of interest to the visitor
void	consumeTerms(Query query, Term... terms)	Called by leaf queries that match on specific terms
QueryVisitor	getSubVisitor(BooleanClause.Occur occur, Query parent)	Pulls a visitor instance for visiting child clauses of a query

Methods inherited from class org.apache.lucene.search.QueryVisitor

consumeTermsMatching, termCollector, visitLeaf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

boost

final float boost

terms

final Set<WeightedTerm> terms

includeProhibited

final boolean includeProhibited

fieldSelector

final Predicate<String> fieldSelector

Constructor Details

BoostedTermExtractor

private BoostedTermExtractor(float boost,
 Set<WeightedTerm> terms,
 boolean includeProhibited,
 Predicate<String> fieldSelector)

Method Details

acceptField

public boolean acceptField(String field)

Description copied from class: QueryVisitor

Whether or not this field is of interest to the visitor

Implement this to avoid collecting terms from heavy queries such as TermInSetQuery that are not running on fields of interest

Overrides:

acceptField in class QueryVisitor

consumeTerms

public void consumeTerms(Query query,
 Term... terms)

Description copied from class: QueryVisitor

Called by leaf queries that match on specific terms

Overrides:

consumeTerms in class QueryVisitor

Parameters:

query - the leaf query

terms - the terms the query will match on

getSubVisitor

public QueryVisitor getSubVisitor(BooleanClause.Occur occur,
 Query parent)

Description copied from class: QueryVisitor

Pulls a visitor instance for visiting child clauses of a query

The default implementation returns this, unless occur is equal to BooleanClause.Occur.MUST_NOT in which case it returns QueryVisitor.EMPTY_VISITOR

Overrides:

getSubVisitor in class QueryVisitor

Parameters:

occur - the relationship between the parent and its children

parent - the query visited