Module org.apache.lucene.queries

Package org.apache.lucene.queries.payloads

Class PayloadScoreQuery.PayloadSpanWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.queries.spans.SpanWeight

org.apache.lucene.queries.payloads.PayloadScoreQuery.PayloadSpanWeight

All Implemented Interfaces:

SegmentCacheable

Enclosing class:

PayloadScoreQuery

private class PayloadScoreQuery.PayloadSpanWeight
extends SpanWeight

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.queries.spans.SpanWeight

SpanWeight.Postings

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

Weight.DefaultBulkScorer, Weight.DefaultScorerSupplier

Field Summary

Fields

Modifier and Type	Field	Description
private final SpanWeight	innerWeight

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

field, similarity, simScorer

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

parentQuery

Constructor Summary

Constructors

Constructor	Description
PayloadSpanWeight(IndexSearcher searcher, SpanWeight innerWeight, float boost)

Method Summary

Modifier and Type	Method	Description
Explanation	explain(LeafReaderContext context, int doc)	An explanation of the score computation for the named document.
void	extractTermStates(Map<Term,TermStates> contexts)	Collect all TermStates used by this Weight
Spans	getSpans(LeafReaderContext ctx, SpanWeight.Postings requiredPostings)	Expert: Return a Spans object iterating over matches from this Weight
boolean	isCacheable(LeafReaderContext ctx)
ScorerSupplier	scorerSupplier(LeafReaderContext context)	Get a ScorerSupplier, which allows knowing the cost of the Scorer before building it.

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

getSimScorer, matches

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

bulkScorer, count, getQuery, scorer

Methods inherited from class java.lang.Object

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

Field Details

innerWeight

private final SpanWeight innerWeight

Constructor Details

PayloadSpanWeight

public PayloadSpanWeight(IndexSearcher searcher,
 SpanWeight innerWeight,
 float boost)
                  throws IOException

Throws:

IOException

Method Details

extractTermStates

public void extractTermStates(Map<Term,TermStates> contexts)

Description copied from class: SpanWeight

Collect all TermStates used by this Weight

Specified by:

extractTermStates in class SpanWeight

Parameters:

contexts - a map to add the TermStates to

getSpans

public Spans getSpans(LeafReaderContext ctx,
 SpanWeight.Postings requiredPostings)
               throws IOException

Description copied from class: SpanWeight

Expert: Return a Spans object iterating over matches from this Weight

Specified by:

getSpans in class SpanWeight

Parameters:

ctx - a LeafReaderContext for this Spans

Returns:

a Spans

Throws:

IOException - on error

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf

explain

public Explanation explain(LeafReaderContext 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

scorerSupplier

public ScorerSupplier scorerSupplier(LeafReaderContext context)
                              throws IOException

Description copied from class: Weight

Get a ScorerSupplier, which allows knowing the cost of the Scorer before building it. A scorer supplier for the same LeafReaderContext instance may be requested multiple times as part of a single search call.

Note: It must return null if the scorer is null.

Overrides:

scorerSupplier in class SpanWeight

Parameters:

context - the leaf reader context

Returns:

a ScorerSupplier providing the scorer, or null if scorer is null

Throws:

IOException - if an IOException occurs

See Also:

• Scorer
• Weight.DefaultScorerSupplier