org.apache.lucene.search.join

Class ToParentBlockJoinQuery.BlockJoinWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.join.ToParentBlockJoinQuery.BlockJoinWeight

Enclosing class:

ToParentBlockJoinQuery

private static class ToParentBlockJoinQuery.BlockJoinWeight
extends Weight

Nested Class Summary

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

Weight.DefaultBulkScorer

Field Summary

Fields

Modifier and Type	Field and Description
private Weight	childWeight
private BitSetProducer	parentsFilter
private ScoreMode	scoreMode

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

parentQuery

Constructor Summary

Constructors

Constructor and Description
BlockJoinWeight(Query joinQuery, Weight childWeight, BitSetProducer parentsFilter, ScoreMode scoreMode)

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.
float	getValueForNormalization() The value for normalization of contained query clauses (e.g.
void	normalize(float norm, float boost) Assigns the query normalization factor and boost to this.
Scorer	scorer(LeafReaderContext readerContext) 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.Weight

bulkScorer, getQuery

Methods inherited from class java.lang.Object

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

Field Detail

childWeight

private final Weight childWeight

parentsFilter

private final BitSetProducer parentsFilter

scoreMode

private final ScoreMode scoreMode

Constructor Detail

BlockJoinWeight

public BlockJoinWeight(Query joinQuery,
                       Weight childWeight,
                       BitSetProducer parentsFilter,
                       ScoreMode scoreMode)

Method Detail

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

getValueForNormalization

public float getValueForNormalization()
                               throws java.io.IOException

Description copied from class: Weight

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

Specified by:

getValueForNormalization in class Weight

Throws:

java.io.IOException

normalize

public void normalize(float norm,
                      float boost)

Description copied from class: Weight

Assigns the query normalization factor and boost to this.

Specified by:

normalize in class Weight

scorer

public Scorer scorer(LeafReaderContext readerContext)
              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.

Specified by:

scorer in class Weight

Parameters:

readerContext - 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

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.

Specified by:

explain in class Weight

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