org.apache.lucene.search

Interface Weight

public interface Weight extends Serializable

Expert: Calculate query weights and build query scorers.

A Weight is constructed by a query, given a Searcher ({@link Query#createWeight(Searcher)}). The {@link #sumOfSquaredWeights()} method is then called on the top-level query to compute the query normalization factor (@link Similarity#queryNorm(float)}). This factor is then passed to {@link #normalize(float)}. At this point the weighting is complete and a scorer may be constructed by calling {@link #scorer(IndexReader)}.

Method Summary
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 norm)
Assigns the query normalization factor to this.
Scorerscorer(IndexReader reader)
Constructs a scorer for this.
floatsumOfSquaredWeights()
The sum of squared weights of contained query clauses.

Method Detail

explain

public Explanation explain(IndexReader reader, int doc)
An explanation of the score computation for the named document.

getQuery

public Query getQuery()
The query that this concerns.

getValue

public float getValue()
The weight for this query.

normalize

public void normalize(float norm)
Assigns the query normalization factor to this.

scorer

public Scorer scorer(IndexReader reader)
Constructs a scorer for this.

sumOfSquaredWeights

public float sumOfSquaredWeights()
The sum of squared weights of contained query clauses.
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.