public class NearSpansPayloadOrdered extends NearSpansOrdered
NearSpansOrdered
that allows collecting payloads.
Expert:
Only public for subclassing. Most implementations should not need this classmatchDoc, matchEnd, matchStart
NO_MORE_POSITIONS
NO_MORE_DOCS
Constructor and Description |
---|
NearSpansPayloadOrdered(SpanNearQuery query,
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. |
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. |
Collection<byte[]> |
getPayload()
Return payloads when available.
|
Spans[] |
getSubSpans() |
boolean |
isPayloadAvailable()
Indicates whether payloads are available
|
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. |
protected boolean |
shrinkToAfterShortestMatch()
The subSpans are ordered in the same doc, so there is a possible match.
|
String |
toString() |
endPosition, nextStartPosition, startPosition
all, empty, slowAdvance
public NearSpansPayloadOrdered(SpanNearQuery query, List<Spans> subSpans) throws IOException
IOException
protected boolean shrinkToAfterShortestMatch() throws IOException
shrinkToAfterShortestMatch
in class NearSpansOrdered
IOException
public Collection<byte[]> getPayload() throws IOException
getPayload
in class NearSpansOrdered
IOException
- if there is a low-level I/O errorpublic boolean isPayloadAvailable()
isPayloadAvailable
in class NearSpansOrdered
public String toString()
toString
in class NearSpansOrdered
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 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 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 TwoPhaseIterator asTwoPhaseIterator()
TwoPhaseIterator
view of this ConjunctionSpans.asTwoPhaseIterator
in class Spans
public Spans[] getSubSpans()
Copyright © 2000-2015 Apache Software Foundation. All Rights Reserved.