org.apache.lucene.search.spans

Class AssertingSpanWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.spans.SpanWeight

org.apache.lucene.search.spans.AssertingSpanWeight

public class AssertingSpanWeight
extends SpanWeight

Wraps a SpanWeight with additional asserts

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

field, similarity, simWeight

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

parentQuery

Constructor Summary

Constructors

Constructor and Description
AssertingSpanWeight(IndexSearcher searcher, SpanWeight in) Create an AssertingSpanWeight

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	extractTermContexts(Map<Term,TermContext> contexts) Collect all TermContexts used by this Weight
void	extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
Spans	getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings) Expert: Return a Spans object iterating over matches from this Weight
float	getValueForNormalization() The value for normalization of contained query clauses (e.g.
void	normalize(float queryNorm, float topLevelBoost) Assigns the query normalization factor and boost from parent queries to this.
Scorer	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

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

bulkScorer, getQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

AssertingSpanWeight

public AssertingSpanWeight(IndexSearcher searcher,
                           SpanWeight in)
                    throws IOException

Create an AssertingSpanWeight

Parameters:

in - the SpanWeight to wrap

Throws:

IOException - on error

Method Detail

extractTermContexts

public void extractTermContexts(Map<Term,TermContext> contexts)

Description copied from class: SpanWeight

Collect all TermContexts used by this Weight

Specified by:

extractTermContexts in class SpanWeight

Parameters:

contexts - a map to add the TermContexts to

getSpans

public Spans getSpans(LeafReaderContext context,
                      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:

context - a LeafReaderContext for this Spans

requiredPostings - the postings information required

Returns:

a Spans

Throws:

IOException - on error

extractTerms

public void extractTerms(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

getValueForNormalization

public float getValueForNormalization()
                               throws IOException

Description copied from class: Weight

The value for normalization of contained query clauses (e.g. sum of squared weights).

Overrides:

getValueForNormalization in class SpanWeight

Throws:

IOException

normalize

public void normalize(float queryNorm,
                      float topLevelBoost)

Description copied from class: Weight

Assigns the query normalization factor and boost from parent queries to this.

Overrides:

normalize in class SpanWeight

scorer

public Scorer scorer(LeafReaderContext context)
              throws 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:

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

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