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
-
public class TermSpans extends Spans
Expert: Public for extension only. This does not work correctly for terms that indexed at position Integer.MAX_VALUE.
-
-
Field Summary
Fields Modifier and Type Field Description protected intcountprotected intdocprotected intfreqprotected intpositionprotected PostingsEnumpostingsprotected booleanreadPayloadprotected Termterm-
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 TermSpans(LeafSimScorer scorer, PostingsEnum postings, Term term, float positionsCost)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intadvance(int target)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.PostingsEnumgetPostings()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.StringtoString()intwidth()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 Detail
-
postings
protected final PostingsEnum postings
-
term
protected final Term term
-
doc
protected int doc
-
freq
protected int freq
-
count
protected int count
-
position
protected int position
-
readPayload
protected boolean readPayload
-
-
Constructor Detail
-
TermSpans
public TermSpans(LeafSimScorer scorer, PostingsEnum postings, Term term, float positionsCost)
-
-
Method Detail
-
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
-
docID
public int docID()
- Specified by:
docIDin classDocIdSetIterator
-
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.
-
cost
public long cost()
- Specified by:
costin classDocIdSetIterator
-
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
-
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
-
getPostings
public PostingsEnum getPostings()
-
-