Class Lucene90PostingsReader.BlockImpactsDocsEnum
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.PostingsEnum
org.apache.lucene.index.ImpactsEnum
org.apache.lucene.backward_codecs.lucene90.Lucene90PostingsReader.BlockImpactsDocsEnum
- All Implemented Interfaces:
ImpactsSource
- Enclosing class:
Lucene90PostingsReader
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate long
private int
private int
private final long[]
private int
private int
(package private) final IndexInput
private final long[]
(package private) final boolean
private boolean
private int
(package private) final PForUtil
private long
private final Lucene90ScoreSkipReader
Fields inherited from class org.apache.lucene.index.PostingsEnum
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
Constructor Summary
ConstructorsConstructorDescriptionBlockImpactsDocsEnum
(FieldInfo fieldInfo, Lucene90PostingsFormat.IntBlockTermState termState) -
Method Summary
Modifier and TypeMethodDescriptionint
advance
(int target) Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.void
advanceShallow
(int target) Shallow-advance totarget
.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
Returns end offset for the current position, or -1 if offsets were not indexed.int
freq()
Returns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS
.Get information about upcoming impacts for doc ids that are greater than or equal to the maximum ofDocIdSetIterator.docID()
and the last target that was passed toImpactsSource.advanceShallow(int)
.Returns the payload at this position, or null if no payload was indexed.int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.int
Returns the next position, or -1 if positions were not indexed.private void
int
Returns start offset for the current position, or -1 if offsets were not indexed.Methods inherited from class org.apache.lucene.index.PostingsEnum
featureRequested
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
pforUtil
-
docBuffer
private final long[] docBuffer -
freqBuffer
private final long[] freqBuffer -
docBufferUpto
private int docBufferUpto -
skipper
-
docIn
-
indexHasFreqs
final boolean indexHasFreqs -
docFreq
private int docFreq -
blockUpto
private int blockUpto -
doc
private int doc -
accum
private long accum -
nextSkipDoc
private int nextSkipDoc -
seekTo
private long seekTo -
isFreqsRead
private boolean isFreqsRead
-
-
Constructor Details
-
BlockImpactsDocsEnum
public BlockImpactsDocsEnum(FieldInfo fieldInfo, Lucene90PostingsFormat.IntBlockTermState termState) throws IOException - Throws:
IOException
-
-
Method Details
-
freq
Description copied from class:PostingsEnum
Returns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS
. Do not call this beforeDocIdSetIterator.nextDoc()
is first called, nor afterDocIdSetIterator.nextDoc()
returnsDocIdSetIterator.NO_MORE_DOCS
.NOTE: if the
PostingsEnum
was obtain withPostingsEnum.NONE
, the result of this method is undefined.- Specified by:
freq
in classPostingsEnum
- Throws:
IOException
-
docID
public int docID()Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
-
refillDocs
- Throws:
IOException
-
advanceShallow
Description copied from interface:ImpactsSource
Shallow-advance totarget
. This is cheaper than callingDocIdSetIterator.advance(int)
and allows further calls toImpactsSource.getImpacts()
to ignore doc IDs that are less thantarget
in order to get more precise information about impacts. This method may not be called on targets that are less than the currentDocIdSetIterator.docID()
. After this method has been called,DocIdSetIterator.nextDoc()
may not be called if the current doc ID is less thantarget - 1
andDocIdSetIterator.advance(int)
may not be called on targets that are less thantarget
.- Throws:
IOException
-
getImpacts
Description copied from interface:ImpactsSource
Get information about upcoming impacts for doc ids that are greater than or equal to the maximum ofDocIdSetIterator.docID()
and the last target that was passed toImpactsSource.advanceShallow(int)
. This method may not be called on an unpositioned iterator on whichImpactsSource.advanceShallow(int)
has never been called. NOTE: advancing this iterator may invalidate the returned impacts, so they should not be used after the iterator has been advanced.- Throws:
IOException
-
nextDoc
Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
IOException
-
advance
Description copied from class:DocIdSetIterator
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returnsDocIdSetIterator.NO_MORE_DOCS
if target is greater than the highest document number in the set.The behavior of this method is undefined when called with
target ≤ current
, or after the iterator has exhausted. Both cases may result in unpredicted behavior.When
target > current
it behaves as if written:int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }
Some implementations are considerably more efficient than that.NOTE: this method may be called with
DocIdSetIterator.NO_MORE_DOCS
for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.- Specified by:
advance
in classDocIdSetIterator
- Throws:
IOException
-
nextPosition
Description copied from class:PostingsEnum
Returns the next position, or -1 if positions were not indexed. Calling this more thanPostingsEnum.freq()
times is undefined.- Specified by:
nextPosition
in classPostingsEnum
- Throws:
IOException
-
startOffset
public int startOffset()Description copied from class:PostingsEnum
Returns start offset for the current position, or -1 if offsets were not indexed.- Specified by:
startOffset
in classPostingsEnum
-
endOffset
public int endOffset()Description copied from class:PostingsEnum
Returns end offset for the current position, or -1 if offsets were not indexed.- Specified by:
endOffset
in classPostingsEnum
-
getPayload
Description copied from class:PostingsEnum
Returns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).- Specified by:
getPayload
in classPostingsEnum
-
cost
public long cost()Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
- Specified by:
cost
in classDocIdSetIterator
-