Class PayloadTermQuery.PayloadTermWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.spans.SpanWeight
-
- org.apache.lucene.search.payloads.PayloadTermQuery.PayloadTermWeight
-
- All Implemented Interfaces:
Serializable
- Enclosing class:
- PayloadTermQuery
protected class PayloadTermQuery.PayloadTermWeight extends SpanWeight
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.spans.SpanWeight
idf, query, queryNorm, queryWeight, similarity, terms, value
-
-
Constructor Summary
Constructors Constructor Description PayloadTermWeight(PayloadTermQuery query, Searcher searcher)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Explanation
explain(IndexReader reader, int doc)
An explanation of the score computation for the named document.Scorer
scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)
Returns aScorer
which scores documents in/out-of order according toscoreDocsInOrder
.-
Methods inherited from class org.apache.lucene.search.spans.SpanWeight
getQuery, getValue, normalize, sumOfSquaredWeights
-
Methods inherited from class org.apache.lucene.search.Weight
scoresDocsOutOfOrder
-
-
-
-
Constructor Detail
-
PayloadTermWeight
public PayloadTermWeight(PayloadTermQuery query, Searcher searcher) throws IOException
- Throws:
IOException
-
-
Method Detail
-
scorer
public Scorer scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer) throws IOException
Description copied from class:Weight
Returns aScorer
which scores documents in/out-of order according toscoreDocsInOrder
.NOTE: even if
scoreDocsInOrder
is false, it is recommended to check whether the returnedScorer
indeed scores documents out of order (i.e., callWeight.scoresDocsOutOfOrder()
), as someScorer
implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.- Overrides:
scorer
in classSpanWeight
- Parameters:
reader
- theIndexReader
for which to return theScorer
.scoreDocsInOrder
- specifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not supportDocIdSetIterator.nextDoc()
and/orDocIdSetIterator.advance(int)
, therefore it is recommended to request an in-order scorer if use of these methods is required.topScorer
- if true,Scorer.score(Collector)
will be called; if false,DocIdSetIterator.nextDoc()
and/orDocIdSetIterator.advance(int)
will be called.- Returns:
- a
Scorer
which scores documents in/out-of order. - Throws:
IOException
-
explain
public Explanation explain(IndexReader reader, int doc) throws IOException
Description copied from class:Weight
An explanation of the score computation for the named document.- Overrides:
explain
in classSpanWeight
- Parameters:
reader
- sub-reader containing the give doc- Returns:
- an Explanation for the score
- Throws:
IOException
-
-