Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class ToParentBlockJoinQuery.BlockJoinWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.FilterWeight

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

All Implemented Interfaces:

SegmentCacheable

Enclosing class:

ToParentBlockJoinQuery

private static class ToParentBlockJoinQuery.BlockJoinWeight
extends FilterWeight

Nested Class Summary

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

Weight.DefaultBulkScorer, Weight.DefaultScorerSupplier

Field Summary

Fields

Modifier and Type	Field	Description
private final BitSetProducer	parentsFilter
private final ScoreMode	scoreMode

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

in

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

parentQuery

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Explanation	explain(LeafReaderContext context, int doc)	An explanation of the score computation for the named document.
Matches	matches(LeafReaderContext context, int doc)	Returns Matches for a specific document, or null if the document does not match the parent query
ScorerSupplier	scorerSupplier(LeafReaderContext context)	Get a ScorerSupplier, which allows knowing the cost of the Scorer before building it.

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

isCacheable

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

bulkScorer, count, getQuery, scorer

Methods inherited from class java.lang.Object

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

Field Details

parentsFilter

private final BitSetProducer parentsFilter

scoreMode

private final ScoreMode scoreMode

Constructor Details

BlockJoinWeight

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

Method Details

scorerSupplier

public ScorerSupplier scorerSupplier(LeafReaderContext context)
                              throws IOException

Description copied from class: Weight

Get a ScorerSupplier, which allows knowing the cost of the Scorer before building it. A scorer supplier for the same LeafReaderContext instance may be requested multiple times as part of a single search call.

Note: It must return null if the scorer is null.

Overrides:

scorerSupplier in class FilterWeight

Parameters:

context - the leaf reader context

Returns:

a ScorerSupplier providing the scorer, or null if scorer is null

Throws:

IOException - if an IOException occurs

See Also:

• Scorer
• Weight.DefaultScorerSupplier

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 FilterWeight

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

matches

public Matches matches(LeafReaderContext context,
 int doc)
                throws IOException

Description copied from class: Weight

Returns Matches for a specific document, or null if the document does not match the parent query

A query match that contains no position information (for example, a Point or DocValues query) will return MatchesUtils.MATCH_WITH_NO_TERMS

Overrides:

matches in class FilterWeight

Parameters:

context - the reader's context to create the Matches for

doc - the document's id relative to the given context's reader

Throws:

IOException