Module org.apache.lucene.sandbox

Package org.apache.lucene.sandbox.search

Class QueryProfilerWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.FilterWeight

org.apache.lucene.sandbox.search.QueryProfilerWeight

All Implemented Interfaces:

SegmentCacheable

class QueryProfilerWeight
extends FilterWeight

Weight wrapper that will compute how much time it takes to build the Scorer and then return a Scorer that is wrapped in order to compute timings as well.

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 QueryProfilerBreakdown	profile

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
QueryProfilerWeight(Weight subQueryWeight, QueryProfilerBreakdown profile)

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.
int	count(LeafReaderContext context)	Counts the number of live documents that match a given Weight.parentQuery in a leaf.
boolean	isCacheable(LeafReaderContext ctx)
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

explain, matches

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

getQuery

Methods inherited from class java.lang.Object

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

Field Details

profile

private final QueryProfilerBreakdown profile

Constructor Details

QueryProfilerWeight

public QueryProfilerWeight(Weight subQueryWeight,
 QueryProfilerBreakdown profile)

Method Details

count

public int count(LeafReaderContext context)
          throws IOException

Description copied from class: Weight

Counts the number of live documents that match a given Weight.parentQuery in a leaf.

The default implementation returns -1 for every query. This indicates that the count could not be computed in sub-linear time.

Specific query classes should override it to provide other accurate sub-linear implementations (that actually return the count). Look at MatchAllDocsQuery.createWeight(IndexSearcher, ScoreMode, float) for an example

We use this property of the function to count hits in IndexSearcher.count(Query).

Overrides:

count in class Weight

Parameters:

context - the LeafReaderContext for which to return the count.

Returns:

integer count of the number of matches

Throws:

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

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

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Specified by:

isCacheable in interface SegmentCacheable

Overrides:

isCacheable in class FilterWeight

Returns:

true if the object can be cached against a given leaf