org.apache.lucene.queries.payloads

Class PayloadScoreQuery.PayloadSpanWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.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.search.spans.SpanWeight

SpanWeight.Postings

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

Weight.DefaultBulkScorer

Field Summary

Fields

Modifier and Type	Field and Description
private SpanWeight	innerWeight

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

field, similarity, simScorer

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

parentQuery

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Explanation	explain(LeafReaderContext context, int doc) An explanation of the score computation for the named document.
void	extractTerms(java.util.Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
void	extractTermStates(java.util.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)
SpanScorer	scorer(LeafReaderContext context) Returns a Scorer which can iterate in order over all matching documents and assign them a score.

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

getSimScorer, matches

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

bulkScorer, getQuery, scorerSupplier

Methods inherited from class java.lang.Object

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

Field Detail

innerWeight

private final SpanWeight innerWeight

Constructor Detail

PayloadSpanWeight

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

Throws:

java.io.IOException

Method Detail

extractTermStates

public void extractTermStates(java.util.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 java.io.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:

java.io.IOException - on error

scorer

public SpanScorer scorer(LeafReaderContext context)
                  throws java.io.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.

Overrides:

scorer in class SpanWeight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

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

Throws:

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

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf

extractTerms

public void extractTerms(java.util.Set<Term> terms)

Description copied from class: Weight

Expert: adds all terms occurring in this query to the terms set. If the Weight was created with needsScores == true then this method will only extract terms which are used for scoring, otherwise it will extract all terms which are used for matching.

Specified by:

extractTerms in class Weight

explain

public Explanation explain(LeafReaderContext context,
                           int doc)
                    throws java.io.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:

java.io.IOException - if an IOException occurs