Package org.apache.lucene.queries.spans
Class FilterSpans
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.queries.spans.Spans
org.apache.lucene.queries.spans.FilterSpans
A
Spans implementation wrapping another spans instance, allowing to filter spans matches
easily by implementing accept(org.apache.lucene.queries.spans.Spans)-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumStatus returned fromaccept(Spans)that indicates whether a candidate match should be accepted, rejected, or rejected and move on to the next document. -
Field Summary
FieldsFields inherited from class org.apache.lucene.queries.spans.Spans
NO_MORE_POSITIONSFields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract FilterSpans.AcceptStatusReturns YES if the candidate should be an accepted match, NO if it should not, and NO_MORE_IN_CURRENT_DOC if iteration should move on to the next document.final intadvance(int target) final TwoPhaseIteratorOptional method: Return aTwoPhaseIteratorview of thisScorer.voidcollect(SpanCollector collector) Collect postings data from the leaves of the current Spans.final longcost()final intdocID()final intReturns the end position for the current start position, or -1 whenSpans.nextStartPosition()was not yet called on the current doc.final intnextDoc()final intReturns the next start position for the current doc.floatReturn an estimation of the cost of using the positions of thisSpansfor any single document, but only afterSpans.asTwoPhaseIterator()returnednull.final intReturns the start position in the current doc, or -1 whenSpans.nextStartPosition()was not yet called on the current doc.toString()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, doStartCurrentDocMethods inherited from class org.apache.lucene.search.DocIdSetIterator
all, docIDRunEnd, empty, intoBitSet, range, slowAdvance
-
Field Details
-
in
The wrapped spans instance.
-
-
Constructor Details
-
FilterSpans
Wrap the givenSpans.
-
-
Method Details
-
accept
Returns YES if the candidate should be an accepted match, NO if it should not, and NO_MORE_IN_CURRENT_DOC if iteration should move on to the next document.- Throws:
IOException
-
nextDoc
- Specified by:
nextDocin classDocIdSetIterator- Throws:
IOException
-
advance
- Specified by:
advancein classDocIdSetIterator- Throws:
IOException
-
docID
public final int docID()- Specified by:
docIDin classDocIdSetIterator
-
nextStartPosition
Description 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 final 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 final 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
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
-
cost
public final long cost()- Specified by:
costin classDocIdSetIterator
-
toString
-
asTwoPhaseIterator
Description copied from class:SpansOptional method: Return aTwoPhaseIteratorview of thisScorer. A return value ofnullindicates that two-phase iteration is not supported.- Overrides:
asTwoPhaseIteratorin classSpans- See Also:
-
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
-