Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene912

Class Lucene912PostingsReader.BlockDocsEnum

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.PostingsEnum

org.apache.lucene.codecs.lucene912.Lucene912PostingsReader.BlockDocsEnum

Enclosing class:

Lucene912PostingsReader

final class Lucene912PostingsReader.BlockDocsEnum
extends PostingsEnum

Field Summary

Fields

Modifier and Type	Field	Description
private int	doc
private final long[]	docBuffer
private int	docBufferUpto
private int	docCountUpto
private int	docFreq
(package private) IndexInput	docIn
(package private) PostingDecodingUtil	docInUtil
(package private) final ForDeltaUtil	forDeltaUtil
(package private) final ForUtil	forUtil
private final long[]	freqBuffer
private long	freqFP
(package private) final boolean	indexHasFreq
(package private) final boolean	indexHasOffsetsOrPayloads
(package private) final boolean	indexHasPos
private int	level0LastDocID
private int	level1DocCountUpto
private long	level1DocEndFP
private int	level1LastDocID
private boolean	needsFreq
(package private) final PForUtil	pforUtil
private long	prevDocID
private int	singletonDocID
(package private) final IndexInput	startDocIn
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
BlockDocsEnum(FieldInfo fieldInfo)

Method Summary

Modifier and Type	Method	Description
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.
boolean	canReuse(IndexInput docIn, FieldInfo fieldInfo)
long	cost()	Returns the estimated cost of this DocIdSetIterator.
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
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.
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	refillFullBlock()
private void	refillRemainder()
PostingsEnum	reset(Lucene912PostingsFormat.IntBlockTermState termState, int flags)
private void	skipLevel0To(int target)
private void	skipLevel1To(int target)
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

forUtil

final ForUtil forUtil

forDeltaUtil

final ForDeltaUtil forDeltaUtil

pforUtil

final PForUtil pforUtil

docBuffer

private final long[] docBuffer

freqBuffer

private final long[] freqBuffer

docBufferUpto

private int docBufferUpto

startDocIn

final IndexInput startDocIn

docIn

IndexInput docIn

docInUtil

PostingDecodingUtil docInUtil

indexHasFreq

final boolean indexHasFreq

indexHasPos

final boolean indexHasPos

indexHasOffsetsOrPayloads

final boolean indexHasOffsetsOrPayloads

docFreq

private int docFreq

totalTermFreq

private long totalTermFreq

docCountUpto

private int docCountUpto

doc

private int doc

prevDocID

private long prevDocID

level0LastDocID

private int level0LastDocID

level1LastDocID

private int level1LastDocID

level1DocEndFP

private long level1DocEndFP

level1DocCountUpto

private int level1DocCountUpto

needsFreq

private boolean needsFreq

singletonDocID

private int singletonDocID

freqFP

private long freqFP

Constructor Details

BlockDocsEnum

public BlockDocsEnum(FieldInfo fieldInfo)
              throws IOException

Throws:

IOException

Method Details

canReuse

public boolean canReuse(IndexInput docIn,
 FieldInfo fieldInfo)

reset

public PostingsEnum reset(Lucene912PostingsFormat.IntBlockTermState termState,
 int flags)
                   throws IOException

Throws:

IOException

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

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()
                throws IOException

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

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

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

Throws:

IOException

getPayload

public BytesRef getPayload()
                    throws IOException

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

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

refillFullBlock

private void refillFullBlock()
                      throws IOException

Throws:

IOException

refillRemainder

private void refillRemainder()
                      throws IOException

Throws:

IOException

skipLevel1To

private void skipLevel1To(int target)
                   throws IOException

Throws:

IOException

skipLevel0To

private void skipLevel0To(int target)
                   throws IOException

Throws:

IOException

moveToNextLevel0Block

private void moveToNextLevel0Block()
                            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

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