Package org.apache.lucene.monitor
Class TermFilteredPresearcher
- java.lang.Object
-
- org.apache.lucene.monitor.Presearcher
-
- org.apache.lucene.monitor.TermFilteredPresearcher
-
- Direct Known Subclasses:
MultipassTermFilteredPresearcher
public class TermFilteredPresearcher extends Presearcher
Presearcher implementation that uses terms extracted from queries to index them in the Monitor, and builds a disjunction from terms in a document to match them.Handling of queries that do not support term extraction through the
QueryVisitorAPI can be configured by passing a list ofCustomQueryHandlerimplementations.Filtering by additional fields can be configured by passing a set of field names. Documents that contain values in those fields will only be checked against
MonitorQueryinstances that have the same fieldname-value mapping in their metadata.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classTermFilteredPresearcher.BytesRefHashIteratorImplements aBytesRefIteratorover aBytesRefHashprotected static interfaceTermFilteredPresearcher.DocumentQueryBuilderConstructs a document disjunction from a set of terms
-
Field Summary
Fields Modifier and Type Field Description static StringANYTOKENstatic StringANYTOKEN_FIELDstatic TermWeightorDEFAULT_WEIGHTORThe default TermWeightor, weighting by token length-
Fields inherited from class org.apache.lucene.monitor.Presearcher
NO_FILTERING
-
-
Constructor Summary
Constructors Constructor Description TermFilteredPresearcher()Creates a new TermFilteredPresearcher using the default term weightingTermFilteredPresearcher(TermWeightor weightor, List<CustomQueryHandler> customQueryHandlers, Set<String> filterFields)Creates a new TermFilteredPresearcher
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QuerybuildQuery(LeafReader reader, BiPredicate<String,BytesRef> termAcceptor)Build a query for a Monitor's queryindex from a LeafReader over a set of documents to monitor.protected DocumentbuildQueryDocument(QueryTree querytree)Builds aDocumentfrom the terms extracted from a queryprotected Map<String,BytesRefHash>collectTerms(QueryTree querytree)Collects terms from aQueryTreeand maps them per-fieldprotected TermFilteredPresearcher.DocumentQueryBuildergetQueryBuilder()Returns aTermFilteredPresearcher.DocumentQueryBuilderfor this presearcherDocumentindexQuery(Query query, Map<String,String> metadata)Build a lucene Document to index the query in a Monitor's queryindex
-
-
-
Field Detail
-
DEFAULT_WEIGHTOR
public static final TermWeightor DEFAULT_WEIGHTOR
The default TermWeightor, weighting by token length
-
ANYTOKEN_FIELD
public static final String ANYTOKEN_FIELD
- See Also:
- Constant Field Values
-
ANYTOKEN
public static final String ANYTOKEN
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TermFilteredPresearcher
public TermFilteredPresearcher()
Creates a new TermFilteredPresearcher using the default term weighting
-
TermFilteredPresearcher
public TermFilteredPresearcher(TermWeightor weightor, List<CustomQueryHandler> customQueryHandlers, Set<String> filterFields)
Creates a new TermFilteredPresearcher- Parameters:
weightor- the TermWeightorcustomQueryHandlers- A list of custom query handlers to extract terms from non-core queriesfilterFields- A set of fields to filter on
-
-
Method Detail
-
buildQuery
public final Query buildQuery(LeafReader reader, BiPredicate<String,BytesRef> termAcceptor)
Description copied from class:PresearcherBuild a query for a Monitor's queryindex from a LeafReader over a set of documents to monitor.- Specified by:
buildQueryin classPresearcher- Parameters:
reader- aLeafReaderover the input documentstermAcceptor- a predicate indicating if a term should be added to the query- Returns:
- a Query to run over a Monitor's queryindex
-
getQueryBuilder
protected TermFilteredPresearcher.DocumentQueryBuilder getQueryBuilder()
Returns aTermFilteredPresearcher.DocumentQueryBuilderfor this presearcher
-
indexQuery
public final Document indexQuery(Query query, Map<String,String> metadata)
Description copied from class:PresearcherBuild a lucene Document to index the query in a Monitor's queryindex- Specified by:
indexQueryin classPresearcher- Parameters:
query- the Query to indexmetadata- a Map of arbitrary query metadata- Returns:
- a lucene Document to add to the queryindex
-
buildQueryDocument
protected Document buildQueryDocument(QueryTree querytree)
Builds aDocumentfrom the terms extracted from a query
-
collectTerms
protected Map<String,BytesRefHash> collectTerms(QueryTree querytree)
Collects terms from aQueryTreeand maps them per-field
-
-