Package org.apache.lucene.search
Class BooleanQuery.BooleanWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.BooleanQuery.BooleanWeight
-
- Enclosing class:
- BooleanQuery
protected class BooleanQuery.BooleanWeight extends Weight
Expert: the Weight for BooleanQuery, used to normalize, score and explain these queries.NOTE: this API and implementation is subject to change suddenly in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected int
maxCoord
protected Similarity
similarity
The Similarity implementation.protected java.util.ArrayList<Weight>
weights
-
Constructor Summary
Constructors Constructor Description BooleanWeight(IndexSearcher searcher, boolean disableCoord)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description float
coord(int overlap, int maxOverlap)
Explanation
explain(AtomicReaderContext context, int doc)
An explanation of the score computation for the named document.Query
getQuery()
The query that this concerns.float
getValueForNormalization()
The value for normalization of contained query clauses (e.g.void
normalize(float norm, float topLevelBoost)
Assigns the query normalization factor and boost from parent queries to this.Scorer
scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs)
Returns aScorer
which scores documents in/out-of order according toscoreDocsInOrder
.boolean
scoresDocsOutOfOrder()
Returns true iff this implementation scores docs only out of order.
-
-
-
Field Detail
-
similarity
protected Similarity similarity
The Similarity implementation.
-
weights
protected java.util.ArrayList<Weight> weights
-
maxCoord
protected int maxCoord
-
-
Constructor Detail
-
BooleanWeight
public BooleanWeight(IndexSearcher searcher, boolean disableCoord) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
getQuery
public Query getQuery()
Description copied from class:Weight
The query that this concerns.
-
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 classWeight
- Throws:
java.io.IOException
-
coord
public float coord(int overlap, int maxOverlap)
-
normalize
public void normalize(float norm, float topLevelBoost)
Description copied from class:Weight
Assigns the query normalization factor and boost from parent queries to this.
-
explain
public Explanation explain(AtomicReaderContext 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 classWeight
- Parameters:
context
- the readers context to create theExplanation
for.doc
- the document's id relative to the given context's reader- Returns:
- an Explanation for the score
- Throws:
java.io.IOException
- if anIOException
occurs
-
scorer
public Scorer scorer(AtomicReaderContext context, boolean scoreDocsInOrder, boolean topScorer, Bits acceptDocs) throws java.io.IOException
Description copied from class:Weight
Returns aScorer
which scores documents in/out-of order according toscoreDocsInOrder
.NOTE: even if
scoreDocsInOrder
is false, it is recommended to check whether the returnedScorer
indeed scores documents out of order (i.e., callWeight.scoresDocsOutOfOrder()
), as someScorer
implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.- Specified by:
scorer
in classWeight
- Parameters:
context
- theAtomicReaderContext
for which to return theScorer
.scoreDocsInOrder
- specifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not supportDocIdSetIterator.nextDoc()
and/orDocIdSetIterator.advance(int)
, therefore it is recommended to request an in-order scorer if use of these methods is required.topScorer
- if true,Scorer.score(Collector)
will be called; if false,DocIdSetIterator.nextDoc()
and/orDocIdSetIterator.advance(int)
will be called.acceptDocs
- Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)- Returns:
- a
Scorer
which scores documents in/out-of order. - Throws:
java.io.IOException
- if there is a low-level I/O error
-
scoresDocsOutOfOrder
public boolean scoresDocsOutOfOrder()
Description copied from class:Weight
Returns true iff this implementation scores docs only out of order. This method is used in conjunction withCollector
'sacceptsDocsOutOfOrder
andWeight.scorer(AtomicReaderContext, boolean, boolean, Bits)
to create a matchingScorer
instance for a givenCollector
, or vice versa.NOTE: the default implementation returns
false
, i.e. theScorer
scores documents in-order.- Overrides:
scoresDocsOutOfOrder
in classWeight
-
-