org.apache.lucene.search.spans
Class SpanWeight

java.lang.Object
  extended by org.apache.lucene.search.Weight
      extended by 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
protected  float idf
           
protected  SpanQuery query
           
protected  float queryNorm
           
protected  float queryWeight
           
protected  Similarity similarity
           
protected  Set<Term> terms
           
protected  float value
           
 
Constructor Summary
SpanWeight(SpanQuery query, Searcher searcher)
           
 
Method Summary
 Explanation explain(IndexReader reader, int doc)
          An explanation of the score computation for the named document.
 Query getQuery()
          The query that this concerns.
 float getValue()
          The weight for this query.
 void normalize(float queryNorm)
          Assigns the query normalization factor to this.
 Scorer scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)
          Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.
 float sumOfSquaredWeights()
          The sum of squared weights of contained query clauses.
 
Methods inherited from class org.apache.lucene.search.Weight
scoresDocsOutOfOrder
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

similarity

protected Similarity similarity

value

protected float value

idf

protected float idf

queryNorm

protected float queryNorm

queryWeight

protected float queryWeight

terms

protected Set<Term> terms

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: Weight
The query that this concerns.

Specified by:
getQuery in class Weight

getValue

public float getValue()
Description copied from class: Weight
The weight for this query.

Specified by:
getValue in class Weight

sumOfSquaredWeights

public float sumOfSquaredWeights()
                          throws IOException
Description copied from class: Weight
The sum of squared weights of contained query clauses.

Specified by:
sumOfSquaredWeights in class Weight
Throws:
IOException

normalize

public void normalize(float queryNorm)
Description copied from class: Weight
Assigns the query normalization factor to this.

Specified by:
normalize in class Weight

scorer

public Scorer scorer(IndexReader reader,
                     boolean scoreDocsInOrder,
                     boolean topScorer)
              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.

Specified by:
scorer in class Weight
Parameters:
reader - the IndexReader for which to return the Scorer.
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 support DocIdSetIterator.nextDoc() and/or DocIdSetIterator.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/or DocIdSetIterator.advance(int) will be called.
Returns:
a Scorer which scores documents in/out-of order.
Throws:
IOException

explain

public Explanation explain(IndexReader reader,
                           int doc)
                    throws IOException
Description copied from class: Weight
An explanation of the score computation for the named document.

Specified by:
explain in class Weight
Parameters:
reader - sub-reader containing the give doc
Returns:
an Explanation for the score
Throws:
IOException


Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.