Module org.apache.lucene.highlighter

Package org.apache.lucene.search.uhighlight

Class MultiTermHighlighting.AutomataCollector

java.lang.Object

org.apache.lucene.search.QueryVisitor

org.apache.lucene.search.uhighlight.MultiTermHighlighting.AutomataCollector

Enclosing class:

MultiTermHighlighting

private static class MultiTermHighlighting.AutomataCollector
extends QueryVisitor

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Predicate<String>	fieldMatcher
(package private) final boolean	lookInSpan
(package private) List<LabelledCharArrayMatcher>	runAutomata

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

EMPTY_VISITOR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AutomataCollector(boolean lookInSpan, Predicate<String> fieldMatcher)

Method Summary

Modifier and Type	Method	Description
boolean	acceptField(String field)	Whether or not this field is of interest to the visitor
void	consumeTermsMatching(Query query, String field, Supplier<ByteRunAutomaton> automaton)	Called by leaf queries that match on a class of 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

consumeTerms, termCollector, visitLeaf

Methods inherited from class java.lang.Object

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

Field Details

runAutomata

List<LabelledCharArrayMatcher> runAutomata

lookInSpan

final boolean lookInSpan

fieldMatcher

final Predicate<String> fieldMatcher

Constructor Details

AutomataCollector

private AutomataCollector(boolean lookInSpan,
 Predicate<String> fieldMatcher)

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

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

consumeTermsMatching

public void consumeTermsMatching(Query query,
 String field,
 Supplier<ByteRunAutomaton> automaton)

Description copied from class: QueryVisitor

Called by leaf queries that match on a class of terms

Overrides:

consumeTermsMatching in class QueryVisitor

Parameters:

query - the leaf query

field - the field queried against

automaton - a supplier for an automaton defining which terms match