Package org.apache.lucene.queries.spans
Class NearSpansOrdered
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.queries.spans.Spans
-
- org.apache.lucene.queries.spans.NearSpansOrdered
-
public class NearSpansOrdered extends Spans
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 t3
with slop at least 1, the fragment:t1 t2 t1 t3 t2 t3
matches twice:t1 t2 .. t3
t1 .. t2 t3
Expert: Only public for subclassing. Most implementations should not need this class
-
-
Field Summary
Fields Modifier and Type Field Description protected intmatchEndprotected intmatchStartprotected intmatchWidth-
Fields inherited from class org.apache.lucene.queries.spans.Spans
NO_MORE_POSITIONS
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description NearSpansOrdered(int allowedSlop, List<Spans> subSpans)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intadvance(int target)TwoPhaseIteratorasTwoPhaseIterator()Return aTwoPhaseIteratorview of this ConjunctionSpans.voidcollect(SpanCollector collector)Collect postings data from the leaves of the current Spans.longcost()intdocID()intendPosition()Returns the end position for the current start position, or -1 whenSpans.nextStartPosition()was not yet called on the current doc.Spans[]getSubSpans()intnextDoc()intnextStartPosition()Returns the next start position for the current doc.floatpositionsCost()Return an estimation of the cost of using the positions of thisSpansfor any single document, but only afterSpans.asTwoPhaseIterator()returnednull.intstartPosition()Returns the start position in the current doc, or -1 whenSpans.nextStartPosition()was not yet called on the current doc.intwidth()Return the width of the match, which is typically used to sloppy freq.-
Methods inherited from class org.apache.lucene.queries.spans.Spans
doCurrentSpans, doStartCurrentDoc, toString
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Constructor Detail
-
NearSpansOrdered
public NearSpansOrdered(int allowedSlop, List<Spans> subSpans) throws IOException- Throws:
IOException
-
-
Method Detail
-
nextStartPosition
public int nextStartPosition() throws IOExceptionDescription copied from class:SpansReturns the next start position for the current doc. There is always at least one start/end position per doc. After the last start/end position at the current doc this returnsSpans.NO_MORE_POSITIONS.- Specified by:
nextStartPositionin classSpans- Throws:
IOException
-
startPosition
public int startPosition()
Description copied from class:SpansReturns the start position in the current doc, or -1 whenSpans.nextStartPosition()was not yet called on the current doc. After the last start/end position at the current doc this returnsSpans.NO_MORE_POSITIONS.- Specified by:
startPositionin classSpans
-
endPosition
public int endPosition()
Description copied from class:SpansReturns the end position for the current start position, or -1 whenSpans.nextStartPosition()was not yet called on the current doc. After the last start/end position at the current doc this returnsSpans.NO_MORE_POSITIONS.- Specified by:
endPositionin classSpans
-
width
public int width()
Description copied from class:SpansReturn the width of the match, which is typically used to sloppy freq. 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.
-
collect
public void collect(SpanCollector collector) throws IOException
Description copied from class:SpansCollect postings data from the leaves of the current Spans.This method should only be called after
Spans.nextStartPosition(), and beforeSpans.NO_MORE_POSITIONShas been reached.- Specified by:
collectin classSpans- Parameters:
collector- a SpanCollector- Throws:
IOException
-
docID
public int docID()
- Specified by:
docIDin classDocIdSetIterator
-
cost
public long cost()
- Specified by:
costin classDocIdSetIterator
-
nextDoc
public int nextDoc() throws IOException- Specified by:
nextDocin classDocIdSetIterator- Throws:
IOException
-
advance
public int advance(int target) throws IOException- Specified by:
advancein classDocIdSetIterator- Throws:
IOException
-
asTwoPhaseIterator
public TwoPhaseIterator asTwoPhaseIterator()
Return aTwoPhaseIteratorview of this ConjunctionSpans.- Overrides:
asTwoPhaseIteratorin classSpans- See Also:
Scorer.twoPhaseIterator()
-
positionsCost
public float positionsCost()
Description copied from class:SpansReturn an estimation of the cost of using the positions of thisSpansfor any single document, but only afterSpans.asTwoPhaseIterator()returnednull. Otherwise this method should not be called. The returned value is independent of the current document.- Specified by:
positionsCostin classSpans
-
getSubSpans
public Spans[] getSubSpans()
-
-