Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene912

Class Lucene912PostingsReader.EverythingEnum

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.EverythingEnum

Enclosing class:

Lucene912PostingsReader

final class Lucene912PostingsReader.EverythingEnum
extends Lucene912PostingsReader.AbstractPostingsEnum

Field Summary

Fields

Modifier and Type	Field	Description
private int	endOffset
private int	freq
private final long[]	freqBuffer
(package private) final boolean	indexHasOffsets
(package private) final boolean	indexHasOffsetsOrPayloads
(package private) final boolean	indexHasPayloads
private long	lastPosBlockFP
private int	lastStartOffset
private int	level0BlockPayUpto
private int	level0BlockPosUpto
private long	level0PayEndFP
private long	level0PosEndFP
private int	level1BlockPayUpto
private int	level1BlockPosUpto
private long	level1PayEndFP
private long	level1PosEndFP
private boolean	needsOffsets
private boolean	needsPayloads
private final long[]	offsetLengthBuffer
private final long[]	offsetStartDeltaBuffer
(package private) final IndexInput	payIn
(package private) final BytesRef	payload
private byte[]	payloadBytes
private int	payloadByteUpto
private int	payloadLength
private final long[]	payloadLengthBuffer
private int	posBufferUpto
private final long[]	posDeltaBuffer
(package private) final IndexInput	posIn
private int	position
private long	posPendingCount
private int	startOffset

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
EverythingEnum(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	refillDocs()
private void	refillPositions()
PostingsEnum	reset(Lucene912PostingsFormat.IntBlockTermState termState, int flags)
private void	skipLevel0To(int target)
private void	skipLevel1To(int target)
private void	skipPositions()
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

posDeltaBuffer

private final long[] posDeltaBuffer

payloadLengthBuffer

private final long[] payloadLengthBuffer

offsetStartDeltaBuffer

private final long[] offsetStartDeltaBuffer

offsetLengthBuffer

private final long[] 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

payIn

final IndexInput payIn

payload

final BytesRef payload

indexHasOffsets

final boolean indexHasOffsets

indexHasPayloads

final boolean indexHasPayloads

indexHasOffsetsOrPayloads

final boolean indexHasOffsetsOrPayloads

freq

private int freq

position

private int position

posPendingCount

private long posPendingCount

lastPosBlockFP

private long lastPosBlockFP

level0PosEndFP

private long level0PosEndFP

level0BlockPosUpto

private int level0BlockPosUpto

level0PayEndFP

private long level0PayEndFP

level0BlockPayUpto

private int level0BlockPayUpto

level1PosEndFP

private long level1PosEndFP

level1BlockPosUpto

private int level1BlockPosUpto

level1PayEndFP

private long level1PayEndFP

level1BlockPayUpto

private int level1BlockPayUpto

needsOffsets

private boolean needsOffsets

needsPayloads

private boolean needsPayloads

Constructor Details

EverythingEnum

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

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

refillDocs

private void refillDocs()
                 throws IOException

Throws:

IOException

skipLevel1To

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

skipLevel0To

private void skipLevel0To(int target)
                   throws IOException

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

Throws:

IOException

refillPositions

private void refillPositions()
                      throws IOException

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

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