Class Lucene912PostingsReader.BlockImpactsDocsEnum
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.PostingsEnum
org.apache.lucene.index.ImpactsEnum
org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.BlockImpactsEnum
org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.BlockImpactsDocsEnum
- All Implemented Interfaces:
ImpactsSource
- Enclosing class:
Lucene912PostingsReader
final class Lucene912PostingsReader.BlockImpactsDocsEnum
extends Lucene912PostingsReader.BlockImpactsEnum
-
Field Summary
FieldsFields inherited from class org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.BlockImpactsEnum
doc, docBuffer, docBufferSize, docBufferUpto, docCountUpto, docFreq, docIn, forDeltaUtil, freqBuffer, level0DocEndFP, level0Impacts, level0LastDocID, level0SerializedImpacts, level1DocCountUpto, level1DocEndFP, level1Impacts, level1LastDocID, level1SerializedImpacts, needsRefilling, pforUtil, prevDocID
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
(boolean indexHasPos, Lucene912PostingsFormat.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
.int
freq()
Returns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS
.private void
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
private void
skipLevel0To
(int target) private void
skipLevel1To
(int target) Methods inherited from class org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.BlockImpactsEnum
cost, docID, endOffset, getImpacts, getPayload, startOffset
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
-
indexHasPos
final boolean indexHasPos -
freqFP
private long freqFP
-
-
Constructor Details
-
BlockImpactsDocsEnum
public BlockImpactsDocsEnum(boolean indexHasPos, Lucene912PostingsFormat.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
-
nextPosition
public int 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
-
refillDocs
- Throws:
IOException
-
skipLevel1To
- Throws:
IOException
-
skipLevel0To
- 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
-
moveToNextLevel0Block
- 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
-