- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.TermQuery.TermWeight
-
- All Implemented Interfaces:
SegmentCacheable
- Enclosing class:
- TermQuery
final class TermQuery.TermWeight 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 Description private ScoreMode
scoreMode
private Similarity
similarity
private Similarity.SimScorer
simScorer
private TermStates
termStates
-
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
-
Constructor Summary
Constructors Constructor Description TermWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost, TermStates termStates)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
count(LeafReaderContext context)
Counts the number of live documents that match a givenWeight.parentQuery
in a leaf.Explanation
explain(LeafReaderContext context, int doc)
An explanation of the score computation for the named document.private TermsEnum
getTermsEnum(LeafReaderContext context)
Returns aTermsEnum
positioned at this weights Term or null if the term does not exist in the given contextboolean
isCacheable(LeafReaderContext ctx)
Matches
matches(LeafReaderContext context, int doc)
ReturnsMatches
for a specific document, ornull
if the document does not match the parent queryScorer
scorer(LeafReaderContext context)
Returns aScorer
which can iterate in order over all matching documents and assign them a score.ScorerSupplier
scorerSupplier(LeafReaderContext context)
Optional method.private boolean
termNotInReader(LeafReader reader, Term term)
java.lang.String
toString()
-
Methods inherited from class org.apache.lucene.search.Weight
bulkScorer, getQuery
-
-
-
-
Field Detail
-
similarity
private final Similarity similarity
-
simScorer
private final Similarity.SimScorer simScorer
-
termStates
private final TermStates termStates
-
scoreMode
private final ScoreMode scoreMode
-
-
Constructor Detail
-
TermWeight
public TermWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost, TermStates termStates) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
matches
public Matches matches(LeafReaderContext context, int doc) throws java.io.IOException
Description copied from class:Weight
ReturnsMatches
for a specific document, ornull
if the document does not match the parent queryA query match that contains no position information (for example, a Point or DocValues query) will return
MatchesUtils.MATCH_WITH_NO_TERMS
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
scorerSupplier
public ScorerSupplier scorerSupplier(LeafReaderContext context) throws java.io.IOException
Description copied from class:Weight
Optional method. Get aScorerSupplier
, which allows to know the cost of theScorer
before building it. The default implementation callsWeight.scorer(org.apache.lucene.index.LeafReaderContext)
and builds aScorerSupplier
wrapper around it.- Overrides:
scorerSupplier
in classWeight
- Throws:
java.io.IOException
- See Also:
Weight.scorer(org.apache.lucene.index.LeafReaderContext)
-
scorer
public Scorer scorer(LeafReaderContext context) throws java.io.IOException
Description copied from class:Weight
Returns aScorer
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 haveLeafReader.getLiveDocs()
applied, they need to be checked on top.- Specified by:
scorer
in classWeight
- Parameters:
context
- theLeafReaderContext
for which to return theScorer
.- Returns:
- a
Scorer
which scores documents in/out-of order. - Throws:
java.io.IOException
- if there is a low-level I/O error
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
true
if the object can be cached against a given leaf
-
getTermsEnum
private TermsEnum getTermsEnum(LeafReaderContext context) throws java.io.IOException
Returns aTermsEnum
positioned at this weights Term or null if the term does not exist in the given context- Throws:
java.io.IOException
-
termNotInReader
private boolean termNotInReader(LeafReader reader, Term term) throws java.io.IOException
- Throws:
java.io.IOException
-
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 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
-
count
public int count(LeafReaderContext context) throws java.io.IOException
Description copied from class:Weight
Counts the number of live documents that match a givenWeight.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 exampleWe use this property of the function to count hits in
IndexSearcher.count(Query)
.- Overrides:
count
in classWeight
- Parameters:
context
- theLeafReaderContext
for which to return the count.- Returns:
- integer count of the number of matches
- Throws:
java.io.IOException
- if there is a low-level I/O error
-
-