Module org.apache.lucene.core

Package org.apache.lucene.search

Class AbstractMultiTermQueryConstantScoreWrapper.RewritingWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.ConstantScoreWeight

org.apache.lucene.search.AbstractMultiTermQueryConstantScoreWrapper.RewritingWeight

All Implemented Interfaces:

SegmentCacheable

Enclosing class:

AbstractMultiTermQueryConstantScoreWrapper<Q extends MultiTermQuery>

protected abstract static class AbstractMultiTermQueryConstantScoreWrapper.RewritingWeight
extends ConstantScoreWeight

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Weight

Weight.DefaultBulkScorer

Field Summary

Fields

Modifier and Type	Field	Description
private final MultiTermQuery	q
private final ScoreMode	scoreMode
private final IndexSearcher	searcher

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

parentQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RewritingWeight(MultiTermQuery q, float boost, ScoreMode scoreMode, IndexSearcher searcher)

Method Summary

Modifier and Type	Method	Description
BulkScorer	bulkScorer(LeafReaderContext context)	Optional method, to return a BulkScorer to score the query and send hits to a Collector.
private boolean	collectTerms(int fieldDocCount, TermsEnum termsEnum, List<AbstractMultiTermQueryConstantScoreWrapper.TermAndState> terms)
private static long	estimateCost(Terms terms, long queryTermsCount)
boolean	isCacheable(LeafReaderContext ctx)
Matches	matches(LeafReaderContext context, int doc)	Returns Matches for a specific document, or null if the document does not match the parent query
private AbstractMultiTermQueryConstantScoreWrapper.WeightOrDocIdSetIterator	rewrite(LeafReaderContext context, Terms terms)
protected abstract AbstractMultiTermQueryConstantScoreWrapper.WeightOrDocIdSetIterator	rewriteInner(LeafReaderContext context, int fieldDocCount, Terms terms, TermsEnum termsEnum, List<AbstractMultiTermQueryConstantScoreWrapper.TermAndState> collectedTerms)	Rewrite the query as either a Weight or a DocIdSetIterator wrapped in a AbstractMultiTermQueryConstantScoreWrapper.WeightOrDocIdSetIterator.
Scorer	scorer(LeafReaderContext context)	Returns a Scorer which can iterate in order over all matching documents and assign them a score.
private Scorer	scorerForIterator(DocIdSetIterator iterator)
ScorerSupplier	scorerSupplier(LeafReaderContext context)	Optional method.

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

explain, score

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

count, getQuery

Methods inherited from class java.lang.Object

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

Field Details

q

private final MultiTermQuery q

scoreMode

private final ScoreMode scoreMode

searcher

private final IndexSearcher searcher

Constructor Details

RewritingWeight

protected RewritingWeight(MultiTermQuery q,
 float boost,
 ScoreMode scoreMode,
 IndexSearcher searcher)

Method Details

rewriteInner

protected abstract AbstractMultiTermQueryConstantScoreWrapper.WeightOrDocIdSetIterator rewriteInner(LeafReaderContext context,
 int fieldDocCount,
 Terms terms,
 TermsEnum termsEnum,
 List<AbstractMultiTermQueryConstantScoreWrapper.TermAndState> collectedTerms)
                                                                                             throws IOException

Rewrite the query as either a Weight or a DocIdSetIterator wrapped in a AbstractMultiTermQueryConstantScoreWrapper.WeightOrDocIdSetIterator. Before this is called, the weight will attempt to "collect" found terms up to a threshold. If fewer terms than the threshold are found, the query will simply be rewritten into a BooleanQuery and this method will not be called. This will only be called if it is determined there are more found terms. At the point this method is invoked, termsEnum will be positioned on the next "uncollected" term. The terms that were already collected will be in collectedTerms.

Throws:

IOException

rewrite

private AbstractMultiTermQueryConstantScoreWrapper.WeightOrDocIdSetIterator rewrite(LeafReaderContext context,
 Terms terms)
                                                                             throws IOException

Throws:

IOException

collectTerms

private boolean collectTerms(int fieldDocCount,
 TermsEnum termsEnum,
 List<AbstractMultiTermQueryConstantScoreWrapper.TermAndState> terms)
                      throws IOException

Throws:

IOException

scorerForIterator

private Scorer scorerForIterator(DocIdSetIterator iterator)

bulkScorer

public BulkScorer bulkScorer(LeafReaderContext context)
                      throws IOException

Description copied from class: Weight

Optional method, to return a BulkScorer to score the query and send hits to a Collector. Only queries that have a different top-level approach need to override this; the default implementation pulls a normal Scorer and iterates and collects the resulting hits which are not marked as deleted.

Overrides:

bulkScorer in class Weight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

a BulkScorer which scores documents and passes them to a collector.

Throws:

IOException - if there is a low-level I/O error

scorer

public Scorer scorer(LeafReaderContext context)
              throws IOException

Description copied from class: Weight

Returns a Scorer which can iterate in order over all matching documents and assign them a score.

NOTE: null can be returned if no documents will be scored by this query.

NOTE: The returned Scorer does not have LeafReader.getLiveDocs() applied, they need to be checked on top.

Specified by:

scorer in class Weight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

a Scorer which scores documents in/out-of order.

Throws:

IOException - if there is a low-level I/O error

matches

public Matches matches(LeafReaderContext context,
 int doc)
                throws IOException

Description copied from class: Weight

Returns Matches for a specific document, or null if the document does not match the parent query

A query match that contains no position information (for example, a Point or DocValues query) will return MatchesUtils.MATCH_WITH_NO_TERMS

Overrides:

matches in class Weight

Parameters:

context - the reader's context to create the Matches for

doc - the document's id relative to the given context's reader

Throws:

IOException

scorerSupplier

public ScorerSupplier scorerSupplier(LeafReaderContext context)
                              throws IOException

Description copied from class: Weight

Optional method. Get a ScorerSupplier, which allows to know the cost of the Scorer before building it. The default implementation calls Weight.scorer(org.apache.lucene.index.LeafReaderContext) and builds a ScorerSupplier wrapper around it.

Overrides:

scorerSupplier in class Weight

Throws:

IOException

See Also:

• Weight.scorer(org.apache.lucene.index.LeafReaderContext)

estimateCost

private static long estimateCost(Terms terms,
 long queryTermsCount)
                          throws IOException

Throws:

IOException

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf