Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene912

Class Lucene912PostingsReader.BlockDocsEnum

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.PostingsEnum

org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.AbstractPostingsEnum

org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.BlockDocsEnum

Enclosing class:

Lucene912PostingsReader

final class Lucene912PostingsReader.BlockDocsEnum
extends Lucene912PostingsReader.AbstractPostingsEnum

Field Summary

Fields

Modifier and Type	Field	Description
private final long[]	freqBuffer
private long	freqFP
private boolean	needsFreq

Fields inherited from class org.apache.lucene.backward_codecs.lucene912.Lucene912PostingsReader.AbstractPostingsEnum

doc, docBuffer, docBufferSize, docBufferUpto, docCountUpto, docFreq, docIn, forDeltaUtil, indexHasFreq, level0LastDocID, level1DocCountUpto, level1DocEndFP, level1LastDocID, pforUtil, prevDocID, singletonDocID, 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	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.backward_codecs.lucene912.Lucene912PostingsReader.AbstractPostingsEnum

docID, resetIdsAndLevelParams, resetIndexInput

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

freqBuffer

private final long[] freqBuffer

needsFreq

private boolean needsFreq

freqFP

private long freqFP

Constructor Details

BlockDocsEnum

public BlockDocsEnum(FieldInfo fieldInfo)

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

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

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

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