Package org.apache.lucene.queries.spans
Class SpanWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.queries.spans.SpanWeight
-
- All Implemented Interfaces:
SegmentCacheable
- Direct Known Subclasses:
org.apache.lucene.queries.spans.SpanContainQuery.SpanContainWeight,SpanNearQuery.SpanNearWeight,SpanNotQuery.SpanNotWeight,SpanOrQuery.SpanOrWeight,SpanPayloadCheckQuery.SpanPayloadCheckWeight,SpanPositionCheckQuery.SpanPositionCheckWeight,SpanTermQuery.SpanTermWeight
public abstract class SpanWeight extends Weight
Expert-only. Public for use by other weight implementations
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSpanWeight.PostingsEnumeration defining what postings information should be retrieved from the index for a given Spans-
Nested classes/interfaces inherited from class org.apache.lucene.search.Weight
Weight.DefaultBulkScorer
-
-
Field Summary
Fields Modifier and Type Field Description protected Stringfieldprotected Similaritysimilarityprotected Similarity.SimScorersimScorer-
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
-
Constructor Summary
Constructors Constructor Description SpanWeight(SpanQuery query, IndexSearcher searcher, Map<Term,TermStates> termStates, float boost)Create a new SpanWeight
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Explanationexplain(LeafReaderContext context, int doc)abstract voidextractTermStates(Map<Term,TermStates> contexts)Collect all TermStates used by this WeightLeafSimScorergetSimScorer(LeafReaderContext context)Return a LeafSimScorer for this contextabstract SpansgetSpans(LeafReaderContext ctx, SpanWeight.Postings requiredPostings)Expert: Return a Spans object iterating over matches from this WeightMatchesmatches(LeafReaderContext context, int doc)SpanScorerscorer(LeafReaderContext context)-
Methods inherited from class org.apache.lucene.search.Weight
bulkScorer, count, getQuery, scorerSupplier
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.SegmentCacheable
isCacheable
-
-
-
-
Field Detail
-
similarity
protected final Similarity similarity
-
simScorer
protected final Similarity.SimScorer simScorer
-
field
protected final String field
-
-
Constructor Detail
-
SpanWeight
public SpanWeight(SpanQuery query, IndexSearcher searcher, Map<Term,TermStates> termStates, float boost) throws IOException
Create a new SpanWeight- Parameters:
query- the parent querysearcher- the IndexSearcher to query againsttermStates- a map of terms toTermStatesfor use in building the similarity. May be null if scores are not required- Throws:
IOException- on error
-
-
Method Detail
-
extractTermStates
public abstract void extractTermStates(Map<Term,TermStates> contexts)
Collect all TermStates used by this Weight- Parameters:
contexts- a map to add the TermStates to
-
getSpans
public abstract Spans getSpans(LeafReaderContext ctx, SpanWeight.Postings requiredPostings) throws IOException
Expert: Return a Spans object iterating over matches from this Weight- Parameters:
ctx- a LeafReaderContext for this Spans- Returns:
- a Spans
- Throws:
IOException- on error
-
scorer
public SpanScorer scorer(LeafReaderContext context) throws IOException
- Specified by:
scorerin classWeight- Throws:
IOException
-
getSimScorer
public LeafSimScorer getSimScorer(LeafReaderContext context) throws IOException
Return a LeafSimScorer for this context- Parameters:
context- the LeafReaderContext- Returns:
- a SimWeight
- Throws:
IOException- on error
-
explain
public Explanation explain(LeafReaderContext context, int doc) throws IOException
- Specified by:
explainin classWeight- Throws:
IOException
-
matches
public Matches matches(LeafReaderContext context, int doc) throws IOException
- Overrides:
matchesin classWeight- Throws:
IOException
-
-