public class NearSpansOrdered extends Spans
The formed spans only contains minimum slop matches.
The matching slop is computed from the distance(s) between
the non overlapping matching Spans.
Successive matches are always formed from the successive Spans
of the SpanNearQuery.
The formed spans may contain overlaps when the slop is at least 1. For example, when querying using
t1 t2 t3with slop at least 1, the fragment:
t1 t2 t1 t3 t2 t3matches twice:
t1 t2 .. t3
t1 .. t2 t3Expert: Only public for subclassing. Most implementations should not need this class
| Modifier and Type | Field and Description |
|---|---|
protected int |
matchEnd |
protected int |
matchStart |
protected int |
matchWidth |
NO_MORE_POSITIONSNO_MORE_DOCS| Constructor and Description |
|---|
NearSpansOrdered(int allowedSlop,
List<Spans> subSpans) |
| 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.
|
TwoPhaseIterator |
asTwoPhaseIterator()
Return a
TwoPhaseIterator view of this ConjunctionSpans. |
void |
collect(SpanCollector collector)
Collect postings data from the leaves of the current Spans.
|
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. |
int |
endPosition()
Returns the end position for the current start position, or -1 when
Spans.nextStartPosition() was not yet called on the current doc. |
Spans[] |
getSubSpans() |
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
Spans.asTwoPhaseIterator() returned null. |
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. |
doCurrentSpans, doStartCurrentDoc, toStringall, empty, slowAdvanceprotected int matchStart
protected int matchEnd
protected int matchWidth
public NearSpansOrdered(int allowedSlop,
List<Spans> subSpans)
throws IOException
IOExceptionpublic int nextStartPosition()
throws IOException
SpansSpans.NO_MORE_POSITIONS.nextStartPosition in class SpansIOExceptionpublic int startPosition()
SpansSpans.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 Spanspublic int endPosition()
SpansSpans.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 Spanspublic int width()
Spansslop 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
SpansSpans.nextStartPosition(), and before
Spans.NO_MORE_POSITIONS has been reached.collect in class Spanscollector - a SpanCollectorIOExceptionpublic 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 DocIdSetIteratorpublic long cost()
DocIdSetIteratorDocIdSetIterator.
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 DocIdSetIteratorpublic int nextDoc()
throws IOException
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.nextDoc in class DocIdSetIteratorIOExceptionpublic int advance(int target)
throws IOException
DocIdSetIteratorDocIdSetIterator.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 DocIdSetIteratorIOExceptionpublic TwoPhaseIterator asTwoPhaseIterator()
TwoPhaseIterator view of this ConjunctionSpans.asTwoPhaseIterator in class SpansScorer.twoPhaseIterator()public float positionsCost()
SpansSpans for any single document, but only after
Spans.asTwoPhaseIterator() returned null.
Otherwise this method should not be called.
The returned value is independent of the current document.positionsCost in class Spanspublic Spans[] getSubSpans()
Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.