Package org.apache.lucene.search.spans
Class NearSpansOrdered
java.lang.Object
org.apache.lucene.search.spans.Spans
org.apache.lucene.search.spans.NearSpansOrdered
A Spans that is formed from the ordered subspans of a SpanNearQuery
where the subspans do not overlap and have a maximum slop between them.
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
-
Constructor Summary
ConstructorsConstructorDescriptionNearSpansOrdered
(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term, TermContext> termContexts) NearSpansOrdered
(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term, TermContext> termContexts, boolean collectPayloads) -
Method Summary
Modifier and TypeMethodDescriptionlong
cost()
Returns the estimated cost of this spans.int
doc()
Returns the document number of the current match.int
end()
Returns the end position of the current match.Collection<byte[]>
Returns the payload data for the current span.Spans[]
boolean
Checks if a payload can be loaded at this position.boolean
next()
Move to the next match, returning true iff any such exists.boolean
skipTo
(int target) Skips to the first match beyond the current, whose document number is greater than or equal to target.int
start()
Returns the start position of the current match.toString()
-
Constructor Details
-
NearSpansOrdered
public NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term, TermContext> termContexts) throws IOException- Throws:
IOException
-
NearSpansOrdered
public NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term, TermContext> termContexts, boolean collectPayloads) throws IOException- Throws:
IOException
-
-
Method Details
-
doc
public int doc()Description copied from class:Spans
Returns the document number of the current match. Initially invalid. -
start
public int start()Description copied from class:Spans
Returns the start position of the current match. Initially invalid. -
end
public int end()Description copied from class:Spans
Returns the end position of the current match. Initially invalid. -
getSubSpans
-
getPayload
Description copied from class:Spans
Returns the payload data for the current span. This is invalid untilSpans.next()
is called for the first time. This method must not be called more than once after each call ofSpans.next()
. However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.
Note that the return type is a collection, thus the ordering should not be relied upon.- Specified by:
getPayload
in classSpans
- Returns:
- a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false
- Throws:
IOException
- if there is a low-level I/O error
-
isPayloadAvailable
public boolean isPayloadAvailable()Description copied from class:Spans
Checks if a payload can be loaded at this position. Payloads can only be loaded once per call toSpans.next()
.- Specified by:
isPayloadAvailable
in classSpans
- Returns:
- true if there is a payload available at this position that can be loaded
-
cost
public long cost()Description copied from class:Spans
Returns the estimated cost of this spans.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.
-
next
Description copied from class:Spans
Move to the next match, returning true iff any such exists.- Specified by:
next
in classSpans
- Throws:
IOException
-
skipTo
Description copied from class:Spans
Skips to the first match beyond the current, whose document number is greater than or equal to target.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.Returns true iff there is such a match.
Behaves as if written:
boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; }
Most implementations are considerably more efficient than that.- Specified by:
skipTo
in classSpans
- Throws:
IOException
-
toString
-