Module org.apache.lucene.core
Class Lucene101PostingsReader.BlockPostingsEnum
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.PostingsEnum
org.apache.lucene.index.ImpactsEnum
org.apache.lucene.codecs.lucene101.Lucene101PostingsReader.BlockPostingsEnum
- All Implemented Interfaces:
ImpactsSource
- Enclosing class:
Lucene101PostingsReader
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private final int[]
private int
private int
private int
private int
private IndexInput
private PostingDecodingUtil
private int
(package private) final int
private ForDeltaUtil
private final int[]
private long
private final Impacts
(package private) final boolean
(package private) final boolean
(package private) final boolean
(package private) final boolean
(package private) final boolean
private long
private int
private int
private int
private long
private final Lucene101PostingsReader.MutableImpactList
private int
private long
private long
private final BytesRef
private int
private int
private int
private long
private final Lucene101PostingsReader.MutableImpactList
private int
private long
private long
private final BytesRef
(package private) final boolean
(package private) final boolean
(package private) final boolean
(package private) final boolean
(package private) final boolean
(package private) final boolean
(package private) final boolean
private boolean
private final int[]
private final int[]
(package private) final IndexOptions
(package private) final IndexInput
(package private) final PostingDecodingUtil
(package private) final BytesRef
private byte[]
private int
private int
private final int[]
private PForUtil
private int
private final int[]
private int
(package private) final IndexInput
(package private) final PostingDecodingUtil
private int
private int
private int
private int
private int
private long
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
private void
int
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
.boolean
canReuse
(IndexInput docIn, FieldInfo fieldInfo, int flags, boolean needsImpacts) long
cost()
Returns the estimated cost of thisDocIdSetIterator
.private void
doAdvanceShallow
(int target) int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.private void
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.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
private void
private void
private void
private void
private void
reset
(Lucene101PostingsFormat.IntBlockTermState termState, int flags) private void
seekPosData
(long posFP, int posUpto, long payFP, int payUpto) private void
skipLevel0To
(int target) private void
skipLevel1To
(int target) private void
skipPositions
(int freq) 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
-
forDeltaUtil
-
pforUtil
-
docBuffer
private final int[] docBuffer -
doc
private int doc -
level0LastDocID
private int level0LastDocID -
level0DocEndFP
private long level0DocEndFP -
level1LastDocID
private int level1LastDocID -
level1DocEndFP
private long level1DocEndFP -
level1DocCountUpto
private int level1DocCountUpto -
docFreq
private int docFreq -
totalTermFreq
private long totalTermFreq -
singletonDocID
private int singletonDocID -
docCountLeft
private int docCountLeft -
prevDocID
private int prevDocID -
docBufferSize
private int docBufferSize -
docBufferUpto
private int docBufferUpto -
docIn
-
docInUtil
-
freqBuffer
private final int[] freqBuffer -
posDeltaBuffer
private final int[] posDeltaBuffer -
payloadLengthBuffer
private final int[] payloadLengthBuffer -
offsetStartDeltaBuffer
private final int[] offsetStartDeltaBuffer -
offsetLengthBuffer
private final int[] offsetLengthBuffer -
payloadBytes
private byte[] payloadBytes -
payloadByteUpto
private int payloadByteUpto -
payloadLength
private int payloadLength -
lastStartOffset
private int lastStartOffset -
startOffset
private int startOffset -
endOffset
private int endOffset -
posBufferUpto
private int posBufferUpto -
posIn
-
posInUtil
-
payIn
-
payInUtil
-
payload
-
options
-
indexHasFreq
final boolean indexHasFreq -
indexHasPos
final boolean indexHasPos -
indexHasOffsets
final boolean indexHasOffsets -
indexHasPayloads
final boolean indexHasPayloads -
indexHasOffsetsOrPayloads
final boolean indexHasOffsetsOrPayloads -
flags
final int flags -
needsFreq
final boolean needsFreq -
needsPos
final boolean needsPos -
needsOffsets
final boolean needsOffsets -
needsPayloads
final boolean needsPayloads -
needsOffsetsOrPayloads
final boolean needsOffsetsOrPayloads -
needsImpacts
final boolean needsImpacts -
needsDocsAndFreqsOnly
final boolean needsDocsAndFreqsOnly -
freqFP
private long freqFP -
position
private int position -
posDocBufferUpto
private int posDocBufferUpto -
posPendingCount
private int posPendingCount -
lastPosBlockFP
private long lastPosBlockFP -
level0PosEndFP
private long level0PosEndFP -
level0BlockPosUpto
private int level0BlockPosUpto -
level0PayEndFP
private long level0PayEndFP -
level0BlockPayUpto
private int level0BlockPayUpto -
level0SerializedImpacts
-
level0Impacts
-
level1PosEndFP
private long level1PosEndFP -
level1BlockPosUpto
private int level1BlockPosUpto -
level1PayEndFP
private long level1PayEndFP -
level1BlockPayUpto
private int level1BlockPayUpto -
level1SerializedImpacts
-
level1Impacts
-
needsRefilling
private boolean needsRefilling -
impacts
-
-
Constructor Details
-
BlockPostingsEnum
- Throws:
IOException
-
-
Method Details
-
canReuse
-
reset
public Lucene101PostingsReader.BlockPostingsEnum reset(Lucene101PostingsFormat.IntBlockTermState termState, int flags) throws IOException - 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
-
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
-
refillFullBlock
- Throws:
IOException
-
refillRemainder
- Throws:
IOException
-
refillDocs
- Throws:
IOException
-
skipLevel1To
- Throws:
IOException
-
doMoveToNextLevel0Block
- Throws:
IOException
-
moveToNextLevel0Block
- Throws:
IOException
-
readLevel0PosData
- Throws:
IOException
-
seekPosData
- 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
-
doAdvanceShallow
- 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
-
skipPositions
- Throws:
IOException
-
refillLastPositionBlock
- Throws:
IOException
-
refillOffsetsOrPayloads
- Throws:
IOException
-
refillPositions
- Throws:
IOException
-
accumulatePendingPositions
- Throws:
IOException
-
accumulatePayloadAndOffsets
private void accumulatePayloadAndOffsets() -
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
-
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.
-