Package org.apache.lucene.search.spans
Class SpanWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.spans.SpanWeight
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
PayloadNearQuery.PayloadNearSpanWeight,PayloadTermQuery.PayloadTermWeight
public class SpanWeight extends Weight
Expert-only. Public for use by other weight implementations- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected floatidfprotected SpanQueryqueryprotected floatqueryNormprotected floatqueryWeightprotected Similaritysimilarityprotected Set<Term>termsprotected floatvalue
-
Constructor Summary
Constructors Constructor Description SpanWeight(SpanQuery query, Searcher searcher)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Explanationexplain(IndexReader reader, int doc)An explanation of the score computation for the named document.QuerygetQuery()The query that this concerns.floatgetValue()The weight for this query.voidnormalize(float queryNorm)Assigns the query normalization factor to this.Scorerscorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)Returns aScorerwhich scores documents in/out-of order according toscoreDocsInOrder.floatsumOfSquaredWeights()The sum of squared weights of contained query clauses.-
Methods inherited from class org.apache.lucene.search.Weight
scoresDocsOutOfOrder
-
-
-
-
Field Detail
-
similarity
protected Similarity similarity
-
value
protected float value
-
idf
protected float idf
-
queryNorm
protected float queryNorm
-
queryWeight
protected float queryWeight
-
query
protected SpanQuery query
-
-
Constructor Detail
-
SpanWeight
public SpanWeight(SpanQuery query, Searcher searcher) throws IOException
- Throws:
IOException
-
-
Method Detail
-
getQuery
public Query getQuery()
Description copied from class:WeightThe query that this concerns.
-
getValue
public float getValue()
Description copied from class:WeightThe weight for this query.
-
sumOfSquaredWeights
public float sumOfSquaredWeights() throws IOExceptionDescription copied from class:WeightThe sum of squared weights of contained query clauses.- Specified by:
sumOfSquaredWeightsin classWeight- Throws:
IOException
-
normalize
public void normalize(float queryNorm)
Description copied from class:WeightAssigns the query normalization factor to this.
-
scorer
public Scorer scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer) throws IOException
Description copied from class:WeightReturns aScorerwhich scores documents in/out-of order according toscoreDocsInOrder.NOTE: even if
scoreDocsInOrderis false, it is recommended to check whether the returnedScorerindeed scores documents out of order (i.e., callWeight.scoresDocsOutOfOrder()), as someScorerimplementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.- Specified by:
scorerin classWeight- Parameters:
reader- theIndexReaderfor which to return theScorer.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 supportDocIdSetIterator.nextDoc()and/orDocIdSetIterator.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/orDocIdSetIterator.advance(int)will be called.- Returns:
- a
Scorerwhich scores documents in/out-of order. - Throws:
IOException
-
explain
public Explanation explain(IndexReader reader, int doc) throws IOException
Description copied from class:WeightAn explanation of the score computation for the named document.- Specified by:
explainin classWeight- Parameters:
reader- sub-reader containing the give doc- Returns:
- an Explanation for the score
- Throws:
IOException
-
-