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
Expert-only. Public for use by other weight implementations
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Enumeration defining what postings information should be retrieved from the index for a given SpansNested classes/interfaces inherited from class org.apache.lucene.search.Weight
Weight.DefaultBulkScorer
-
Field Summary
Modifier and TypeFieldDescriptionprotected final String
protected final Similarity
protected final Similarity.SimScorer
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
Constructor Summary
ConstructorDescriptionSpanWeight
(SpanQuery query, IndexSearcher searcher, Map<Term, TermStates> termStates, float boost) Create a new SpanWeight -
Method Summary
Modifier and TypeMethodDescriptionexplain
(LeafReaderContext context, int doc) abstract void
extractTermStates
(Map<Term, TermStates> contexts) Collect all TermStates used by this WeightgetSimScorer
(LeafReaderContext context) Return a LeafSimScorer for this contextabstract Spans
getSpans
(LeafReaderContext ctx, SpanWeight.Postings requiredPostings) Expert: Return a Spans object iterating over matches from this Weightmatches
(LeafReaderContext context, int doc) scorer
(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 Details
-
similarity
-
simScorer
-
field
-
-
Constructor Details
-
SpanWeight
public SpanWeight(SpanQuery query, IndexSearcher searcher, Map<Term, TermStates> termStates, float boost) throws IOExceptionCreate a new SpanWeight- Parameters:
query
- the parent querysearcher
- the IndexSearcher to query againsttermStates
- a map of terms toTermStates
for use in building the similarity. May be null if scores are not required- Throws:
IOException
- on error
-
-
Method Details
-
extractTermStates
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
- Specified by:
scorer
in classWeight
- Throws:
IOException
-
getSimScorer
Return a LeafSimScorer for this context- Parameters:
context
- the LeafReaderContext- Returns:
- a SimWeight
- Throws:
IOException
- on error
-
explain
- Specified by:
explain
in classWeight
- Throws:
IOException
-
matches
- Overrides:
matches
in classWeight
- Throws:
IOException
-