Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene912

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

Fields

Modifier and Type	Field	Description
private long	freqFP
(package private) final boolean	indexHasPos

Fields 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

Constructors

Constructor	Description
BlockImpactsDocsEnum(boolean indexHasPos, Lucene912PostingsFormat.IntBlockTermState termState)

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.
void	advanceShallow(int target)	Shallow-advance to target.
int	freq()	Returns term frequency in the current document, or 1 if the field was indexed with IndexOptions.DOCS.
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	refillDocs()
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

Methods inherited from class java.lang.Object

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

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

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

refillDocs

private void refillDocs()
                 throws IOException

Throws:

IOException

skipLevel1To

private void skipLevel1To(int target)
                   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

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