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

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
BulkScorer	bulkScorer(LeafReaderContext context)	Optional method, to return a BulkScorer to score the query and send hits to a Collector.
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
Scorer	scorer(LeafReaderContext context)	Returns a Scorer which can iterate in order over all matching documents and assign them a score.
ScorerSupplier	scorerSupplier(LeafReaderContext context)	Optional method.

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

isCacheable

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

count, getQuery

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

scorer

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

Overrides:

scorer in class FilterWeight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

a Scorer which scores documents in/out-of order.

Throws:

IOException - if there is a low-level I/O error

scorerSupplier

public ScorerSupplier scorerSupplier(LeafReaderContext context)
                              throws IOException

Description copied from class: Weight

Optional method. Get a ScorerSupplier, which allows to know the cost of the Scorer before building it. The default implementation calls Weight.scorer(org.apache.lucene.index.LeafReaderContext) and builds a ScorerSupplier wrapper around it.

Overrides:

scorerSupplier in class Weight

Throws:

IOException

See Also:

• Weight.scorer(org.apache.lucene.index.LeafReaderContext)

bulkScorer

public BulkScorer bulkScorer(LeafReaderContext context)
                      throws IOException

Description copied from class: Weight

Optional method, to return a BulkScorer to score the query and send hits to a Collector. Only queries that have a different top-level approach need to override this; the default implementation pulls a normal Scorer and iterates and collects the resulting hits which are not marked as deleted.

Overrides:

bulkScorer in class Weight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

a BulkScorer which scores documents and passes them to a collector.

Throws:

IOException - if there is a low-level I/O error

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