Package org.apache.lucene.search.payloads

Class PayloadNearQuery.PayloadNearSpanWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.spans.SpanWeight

org.apache.lucene.search.payloads.PayloadNearQuery.PayloadNearSpanWeight

Enclosing class:

PayloadNearQuery

public class PayloadNearQuery.PayloadNearSpanWeight
extends SpanWeight

Constructor Summary

Constructors

Constructor	Description
PayloadNearSpanWeight(SpanQuery query, IndexSearcher searcher)

Method Summary

Modifier and Type	Method	Description
Explanation	explain(AtomicReaderContext context, int doc)	An explanation of the score computation for the named document.
Scorer	scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)	Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

Methods inherited from class org.apache.lucene.search.spans.SpanWeight

getQuery, getValueForNormalization, normalize

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

scoresDocsOutOfOrder

Methods inherited from class java.lang.Object

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

Constructor Details

PayloadNearSpanWeight

public PayloadNearSpanWeight(SpanQuery query,
 IndexSearcher searcher)
                      throws IOException

Throws:

IOException

Method Details

scorer

public Scorer scorer(AtomicReaderContext context,
 boolean scoreDocsInOrder,
 boolean topScorer,
 Bits acceptDocs)
              throws IOException

Description copied from class: Weight

Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call Weight.scoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.

Overrides:

scorer in class SpanWeight

Parameters:

context - the AtomicReaderContext for which to return the Scorer.

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 support DocIdSetIterator.nextDoc() and/or DocIdSetIterator.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/or DocIdSetIterator.advance(int) will be called.

acceptDocs - Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)

Returns:

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

Throws:

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

explain

public Explanation explain(AtomicReaderContext context,
 int doc)
                    throws IOException

Description copied from class: Weight

An explanation of the score computation for the named document.

Overrides:

explain in class SpanWeight

Parameters:

context - the readers context to create the Explanation for.

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

Returns:

an Explanation for the score

Throws:

IOException - if an IOException occurs