org.apache.lucene.search.payloads

Class PayloadTermQuery.PayloadTermWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.spans.SpanWeight

org.apache.lucene.search.payloads.PayloadTermQuery.PayloadTermWeight

Enclosing class:

PayloadTermQuery

protected class PayloadTermQuery.PayloadTermWeight
extends SpanWeight

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer

Field Summary

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

query, similarity, stats, termContexts

Constructor Summary

Constructors

Constructor and Description
PayloadTermQuery.PayloadTermWeight(PayloadTermQuery query, IndexSearcher searcher)

Method Summary

Methods

Modifier and Type	Method and Description
Explanation	explain(AtomicReaderContext context, int doc) An explanation of the score computation for the named document.
Scorer	scorer(AtomicReaderContext context, 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

bulkScorer, scoresDocsOutOfOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadTermQuery.PayloadTermWeight

public PayloadTermQuery.PayloadTermWeight(PayloadTermQuery query,
                                  IndexSearcher searcher)
                                   throws IOException

Throws:

IOException

Method Detail

scorer

public Scorer scorer(AtomicReaderContext context,
            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.

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