public class PayloadNearQuery.PayloadNearSpanScorer extends Spans implements SpanCollector
Scorer.ChildScorer
Modifier and Type | Field and Description |
---|---|
protected float |
payloadScore |
docScorer, freq, NO_MORE_POSITIONS, numMatches
NO_MORE_DOCS
Modifier | Constructor and Description |
---|---|
protected |
PayloadNearQuery.PayloadNearSpanScorer(Spans spans,
SpanWeight weight,
Similarity.SimScorer docScorer) |
Modifier and Type | Method and Description |
---|---|
int |
advance(int target)
Advances to the first beyond the current whose document number is greater
than or equal to target, and returns the document number itself.
|
void |
collect(SpanCollector collector)
Collect postings data from the leaves of the current Spans.
|
void |
collectLeaf(PostingsEnum postings,
int position,
Term term)
Collect information from postings
|
long |
cost()
Returns the estimated cost of this
DocIdSetIterator . |
int |
docID()
Returns the following:
-1 if DocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) were not called yet. |
protected void |
doCurrentSpans()
Called each time the scorer's SpanScorer is advanced during frequency calculation
|
protected void |
doStartCurrentDoc()
Called before the current doc's frequency is calculated
|
int |
endPosition()
Returns the end position for the current start position, or -1 when
Spans.nextStartPosition() was not yet called on the current doc. |
int |
nextDoc()
Advances to the next document in the set and returns the doc it is
currently on, or
DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior. |
int |
nextStartPosition()
Returns the next start position for the current doc.
|
float |
positionsCost()
Return an estimation of the cost of using the positions of
this
Spans for any single document, but only after
Scorer.asTwoPhaseIterator() returned null . |
protected void |
processPayloads(Collection<byte[]> payLoads,
int start,
int end)
By default, uses the
PayloadFunction to score the payloads, but
can be overridden to do other things. |
void |
reset()
Call to indicate that the driving Spans has moved to a new position
|
float |
scoreCurrentDoc()
Score the current doc.
|
int |
startPosition()
Returns the start position in the current doc, or -1 when
Spans.nextStartPosition() was not yet called on the current doc. |
int |
width()
Return the width of the match, which is typically used to compute
the
slop factor . |
freq, score, setFreqCurrentDoc, sloppyFreq, toString
asTwoPhaseIterator, getChildren, getWeight
all, empty, slowAdvance
protected PayloadNearQuery.PayloadNearSpanScorer(Spans spans, SpanWeight weight, Similarity.SimScorer docScorer) throws IOException
IOException
protected void processPayloads(Collection<byte[]> payLoads, int start, int end)
PayloadFunction
to score the payloads, but
can be overridden to do other things.payLoads
- The payloadsstart
- The start position of the span being scoredend
- The end position of the span being scoredSpans
public int nextStartPosition() throws IOException
Spans
Spans.NO_MORE_POSITIONS
.nextStartPosition
in class Spans
IOException
public int startPosition()
Spans
Spans.nextStartPosition()
was not yet called on the current doc.
After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS
.startPosition
in class Spans
public int endPosition()
Spans
Spans.nextStartPosition()
was not yet called on the current doc.
After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS
.endPosition
in class Spans
public int width()
Spans
slop factor
. It is only legal
to call this method when the iterator is on a valid doc ID and positioned.
The return value must be positive, and lower values means that the match is
better.public void collect(SpanCollector collector) throws IOException
Spans
Spans.nextStartPosition()
, and before
Spans.NO_MORE_POSITIONS
has been reached.collect
in class Spans
collector
- a SpanCollectorIOException
protected void doStartCurrentDoc() throws IOException
Spans
doStartCurrentDoc
in class Spans
IOException
protected void doCurrentSpans() throws IOException
Spans
doCurrentSpans
in class Spans
IOException
public float scoreCurrentDoc() throws IOException
Spans
Spans.freq
.scoreCurrentDoc
in class Spans
IOException
public void collectLeaf(PostingsEnum postings, int position, Term term) throws IOException
SpanCollector
collectLeaf
in interface SpanCollector
postings
- a PostingsEnum
position
- the position of the PostingsEnumterm
- the Term
for this postings listIOException
- on errorpublic void reset()
SpanCollector
reset
in interface SpanCollector
public int docID()
DocIdSetIterator
-1
if DocIdSetIterator.nextDoc()
or
DocIdSetIterator.advance(int)
were not called yet.
DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.
docID
in class DocIdSetIterator
public int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class DocIdSetIterator
IOException
public int advance(int target) throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if target
is greater than the highest document number in the set.
The behavior of this method is undefined when called with
target ≤ current
, or after the iterator has exhausted.
Both cases may result in unpredicted behavior.
When target > current
it behaves as if written:
int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }Some implementations are considerably more efficient than that.
NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS
for
efficiency by some Scorers. If your implementation cannot efficiently
determine that it should exhaust, it is recommended that you check for that
value in each call to this method.
advance
in class DocIdSetIterator
IOException
public long cost()
DocIdSetIterator
DocIdSetIterator
.
This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
cost
in class DocIdSetIterator
public float positionsCost()
Spans
Spans
for any single document, but only after
Scorer.asTwoPhaseIterator()
returned null
.
Otherwise this method should not be called.
The returned value is independent of the current document.positionsCost
in class Spans
Copyright © 2000-2018 The Apache Software Foundation. All Rights Reserved.