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
Modifier and TypeClassDescriptionstatic enum
Status returned fromaccept(Spans)
that indicates whether a candidate match should be accepted, rejected, or rejected and move on to the next document. -
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract FilterSpans.AcceptStatus
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.final int
advance
(int target) final TwoPhaseIterator
Optional method: Return aTwoPhaseIterator
view of thisScorer
.void
collect
(SpanCollector collector) Collect postings data from the leaves of the current Spans.final long
cost()
final int
docID()
final int
Returns the end position for the current start position, or -1 whenSpans.nextStartPosition()
was not yet called on the current doc.final int
nextDoc()
final int
Returns the next start position for the current doc.float
Return an estimation of the cost of using the positions of thisSpans
for any single document, but only afterSpans.asTwoPhaseIterator()
returnednull
.final int
Returns the start position in the current doc, or -1 whenSpans.nextStartPosition()
was not yet called on the current doc.toString()
int
width()
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
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, 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:
nextDoc
in classDocIdSetIterator
- Throws:
IOException
-
advance
- Specified by:
advance
in classDocIdSetIterator
- Throws:
IOException
-
docID
public final int docID()- Specified by:
docID
in classDocIdSetIterator
-
nextStartPosition
Description copied from class:Spans
Returns 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:
nextStartPosition
in classSpans
- Throws:
IOException
-
startPosition
public final int startPosition()Description copied from class:Spans
Returns 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:
startPosition
in classSpans
-
endPosition
public final int endPosition()Description copied from class:Spans
Returns 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:
endPosition
in classSpans
-
width
public int width()Description copied from class:Spans
Return 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:Spans
Collect postings data from the leaves of the current Spans.This method should only be called after
Spans.nextStartPosition()
, and beforeSpans.NO_MORE_POSITIONS
has been reached.- Specified by:
collect
in classSpans
- Parameters:
collector
- a SpanCollector- Throws:
IOException
-
cost
public final long cost()- Specified by:
cost
in classDocIdSetIterator
-
toString
-
asTwoPhaseIterator
Description copied from class:Spans
Optional method: Return aTwoPhaseIterator
view of thisScorer
. A return value ofnull
indicates that two-phase iteration is not supported.- Overrides:
asTwoPhaseIterator
in classSpans
- See Also:
-
positionsCost
public float positionsCost()Description copied from class:Spans
Return an estimation of the cost of using the positions of thisSpans
for 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:
positionsCost
in classSpans
-