Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene101

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

final class Lucene101PostingsReader.BlockPostingsEnum
extends ImpactsEnum

Field Summary

Fields

Modifier and Type	Field	Description
private int	doc
private final int[]	docBuffer
private int	docBufferSize
private int	docBufferUpto
private int	docCountLeft
private int	docFreq
private IndexInput	docIn
private PostingDecodingUtil	docInUtil
private int	endOffset
(package private) final int	flags
private ForDeltaUtil	forDeltaUtil
private final int[]	freqBuffer
private long	freqFP
private final Impacts	impacts
(package private) final boolean	indexHasFreq
(package private) final boolean	indexHasOffsets
(package private) final boolean	indexHasOffsetsOrPayloads
(package private) final boolean	indexHasPayloads
(package private) final boolean	indexHasPos
private long	lastPosBlockFP
private int	lastStartOffset
private int	level0BlockPayUpto
private int	level0BlockPosUpto
private long	level0DocEndFP
private final Lucene101PostingsReader.MutableImpactList	level0Impacts
private int	level0LastDocID
private long	level0PayEndFP
private long	level0PosEndFP
private final BytesRef	level0SerializedImpacts
private int	level1BlockPayUpto
private int	level1BlockPosUpto
private int	level1DocCountUpto
private long	level1DocEndFP
private final Lucene101PostingsReader.MutableImpactList	level1Impacts
private int	level1LastDocID
private long	level1PayEndFP
private long	level1PosEndFP
private final BytesRef	level1SerializedImpacts
(package private) final boolean	needsDocsAndFreqsOnly
(package private) final boolean	needsFreq
(package private) final boolean	needsImpacts
(package private) final boolean	needsOffsets
(package private) final boolean	needsOffsetsOrPayloads
(package private) final boolean	needsPayloads
(package private) final boolean	needsPos
private boolean	needsRefilling
private final int[]	offsetLengthBuffer
private final int[]	offsetStartDeltaBuffer
(package private) final IndexOptions	options
(package private) final IndexInput	payIn
(package private) final PostingDecodingUtil	payInUtil
(package private) final BytesRef	payload
private byte[]	payloadBytes
private int	payloadByteUpto
private int	payloadLength
private final int[]	payloadLengthBuffer
private PForUtil	pforUtil
private int	posBufferUpto
private final int[]	posDeltaBuffer
private int	posDocBufferUpto
(package private) final IndexInput	posIn
(package private) final PostingDecodingUtil	posInUtil
private int	position
private int	posPendingCount
private int	prevDocID
private int	singletonDocID
private int	startOffset
private long	totalTermFreq

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

Constructor	Description
BlockPostingsEnum(FieldInfo fieldInfo, int flags, boolean needsImpacts)

Method Summary

Modifier and Type	Method	Description
private void	accumulatePayloadAndOffsets()
private void	accumulatePendingPositions()
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 to target.
boolean	canReuse(IndexInput docIn, FieldInfo fieldInfo, int flags, boolean needsImpacts)
long	cost()	Returns the estimated cost of this DocIdSetIterator.
private void	doAdvanceShallow(int target)
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
private void	doMoveToNextLevel0Block()
int	endOffset()	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 with IndexOptions.DOCS.
Impacts	getImpacts()	Get information about upcoming impacts for doc ids that are greater than or equal to the maximum of DocIdSetIterator.docID() and the last target that was passed to ImpactsSource.advanceShallow(int).
BytesRef	getPayload()	Returns the payload at this position, or null if no payload was indexed.
private void	moveToNextLevel0Block()
int	nextDoc()	Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.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	nextPosition()	Returns the next position, or -1 if positions were not indexed.
private void	readLevel0PosData()
private void	refillDocs()
private void	refillFullBlock()
private void	refillLastPositionBlock()
private void	refillOffsetsOrPayloads()
private void	refillPositions()
private void	refillRemainder()
Lucene101PostingsReader.BlockPostingsEnum	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	startOffset()	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

forDeltaUtil

private ForDeltaUtil forDeltaUtil

pforUtil

private PForUtil 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

private IndexInput docIn

docInUtil

private PostingDecodingUtil 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

final IndexInput posIn

posInUtil

final PostingDecodingUtil posInUtil

payIn

final IndexInput payIn

payInUtil

final PostingDecodingUtil payInUtil

payload

final BytesRef payload

options

final IndexOptions 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

private final BytesRef level0SerializedImpacts

level0Impacts

private final Lucene101PostingsReader.MutableImpactList level0Impacts

level1PosEndFP

private long level1PosEndFP

level1BlockPosUpto

private int level1BlockPosUpto

level1PayEndFP

private long level1PayEndFP

level1BlockPayUpto

private int level1BlockPayUpto

level1SerializedImpacts

private final BytesRef level1SerializedImpacts

level1Impacts

private final Lucene101PostingsReader.MutableImpactList level1Impacts

needsRefilling

private boolean needsRefilling

impacts

private final Impacts impacts

Constructor Details

BlockPostingsEnum

public BlockPostingsEnum(FieldInfo fieldInfo,
 int flags,
 boolean needsImpacts)
                  throws IOException

Throws:

IOException

Method Details

canReuse

public boolean canReuse(IndexInput docIn,
 FieldInfo fieldInfo,
 int flags,
 boolean needsImpacts)

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 if DocIdSetIterator.nextDoc() or DocIdSetIterator.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 class DocIdSetIterator

freq

public int freq()
         throws IOException

Description copied from class: PostingsEnum

Returns term frequency in the current document, or 1 if the field was indexed with IndexOptions.DOCS. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns DocIdSetIterator.NO_MORE_DOCS.

NOTE: if the PostingsEnum was obtain with PostingsEnum.NONE, the result of this method is undefined.

Specified by:

freq in class PostingsEnum

Throws:

IOException

refillFullBlock

private void refillFullBlock()
                      throws IOException

Throws:

IOException

refillRemainder

private void refillRemainder()
                      throws IOException

Throws:

IOException

refillDocs

private void refillDocs()
                 throws IOException

Throws:

IOException

skipLevel1To

private void skipLevel1To(int target)
                   throws IOException

Throws:

IOException

doMoveToNextLevel0Block

private void doMoveToNextLevel0Block()
                              throws IOException

Throws:

IOException

moveToNextLevel0Block

private void moveToNextLevel0Block()
                            throws IOException

Throws:

IOException

readLevel0PosData

private void readLevel0PosData()
                        throws IOException

Throws:

IOException

seekPosData

private void seekPosData(long posFP,
 int posUpto,
 long payFP,
 int payUpto)
                  throws IOException

Throws:

IOException

skipLevel0To

private void skipLevel0To(int target)
                   throws IOException

Throws:

IOException

advanceShallow

public void advanceShallow(int target)
                    throws IOException

Description copied from interface: ImpactsSource

Shallow-advance to target. This is cheaper than calling DocIdSetIterator.advance(int) and allows further calls to ImpactsSource.getImpacts() to ignore doc IDs that are less than target in order to get more precise information about impacts. This method may not be called on targets that are less than the current DocIdSetIterator.docID(). After this method has been called, DocIdSetIterator.nextDoc() may not be called if the current doc ID is less than target - 1 and DocIdSetIterator.advance(int) may not be called on targets that are less than target.

Throws:

IOException

doAdvanceShallow

private void doAdvanceShallow(int target)
                       throws IOException

Throws:

IOException

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.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 class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws IOException

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 returns DocIdSetIterator.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 class DocIdSetIterator

Throws:

IOException

skipPositions

private void skipPositions(int freq)
                    throws IOException

Throws:

IOException

refillLastPositionBlock

private void refillLastPositionBlock()
                              throws IOException

Throws:

IOException

refillOffsetsOrPayloads

private void refillOffsetsOrPayloads()
                              throws IOException

Throws:

IOException

refillPositions

private void refillPositions()
                      throws IOException

Throws:

IOException

accumulatePendingPositions

private void accumulatePendingPositions()
                                 throws IOException

Throws:

IOException

accumulatePayloadAndOffsets

private void accumulatePayloadAndOffsets()

nextPosition

public int nextPosition()
                 throws IOException

Description copied from class: PostingsEnum

Returns the next position, or -1 if positions were not indexed. Calling this more than PostingsEnum.freq() times is undefined.

Specified by:

nextPosition in class PostingsEnum

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 class PostingsEnum

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 class PostingsEnum

getPayload

public BytesRef 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 class PostingsEnum

cost

public long cost()

Description copied from class: DocIdSetIterator

Returns the estimated cost of this DocIdSetIterator.

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 class DocIdSetIterator

getImpacts

public Impacts getImpacts()

Description copied from interface: ImpactsSource

Get information about upcoming impacts for doc ids that are greater than or equal to the maximum of DocIdSetIterator.docID() and the last target that was passed to ImpactsSource.advanceShallow(int). This method may not be called on an unpositioned iterator on which ImpactsSource.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.