Package org.apache.lucene.queries.spans
Class TermSpans
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.queries.spans.Spans
org.apache.lucene.queries.spans.TermSpans
Expert: Public for extension only. This does not work correctly for terms that indexed at
position Integer.MAX_VALUE.
-
Field Summary
Modifier and TypeFieldDescriptionprotected int
protected int
protected int
protected int
protected final PostingsEnum
protected boolean
protected final Term
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
ConstructorDescriptionTermSpans
(LeafSimScorer scorer, PostingsEnum postings, Term term, float positionsCost) -
Method Summary
Modifier and TypeMethodDescriptionint
advance
(int target) void
collect
(SpanCollector collector) Collect postings data from the leaves of the current Spans.long
cost()
int
docID()
int
Returns the end position for the current start position, or -1 whenSpans.nextStartPosition()
was not yet called on the current doc.int
nextDoc()
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
.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
asTwoPhaseIterator, doCurrentSpans, doStartCurrentDoc
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
postings
-
term
-
doc
protected int doc -
freq
protected int freq -
count
protected int count -
position
protected int position -
readPayload
protected boolean readPayload
-
-
Constructor Details
-
TermSpans
-
-
Method Details
-
nextDoc
- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
IOException
-
advance
- Specified by:
advance
in classDocIdSetIterator
- Throws:
IOException
-
docID
public 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 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 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. -
cost
public long cost()- Specified by:
cost
in classDocIdSetIterator
-
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
-
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
-
toString
-
getPostings
-