Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene80

Class Lucene80DocValuesProducer.TermsDict

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.BaseTermsEnum

org.apache.lucene.backward_codecs.lucene80.Lucene80DocValuesProducer.TermsDict

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

Lucene80DocValuesProducer

private static class Lucene80DocValuesProducer.TermsDict
extends BaseTermsEnum

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final LongValues	blockAddresses
(package private) BytesRef	blockBuffer
(package private) ByteArrayDataInput	blockInput
(package private) final long	blockMask
(package private) final IndexInput	bytes
(package private) long	currentCompressedBlockEnd
(package private) long	currentCompressedBlockStart
(package private) final Lucene80DocValuesProducer.TermsDictEntry	entry
(package private) final LongValues	indexAddresses
(package private) final IndexInput	indexBytes
(package private) static final int	LZ4_DECOMPRESSOR_PADDING
(package private) long	ord
(package private) final BytesRef	term

Fields inherited from class org.apache.lucene.index.TermsEnum

EMPTY

Constructor Summary

Constructors

Constructor	Description
TermsDict(Lucene80DocValuesProducer.TermsDictEntry entry, IndexInput data)

Method Summary

Modifier and Type	Method	Description
private void	decompressBlock()
int	docFreq()	Returns the number of documents containing the current term.
private BytesRef	getFirstTermFromBlock(long block)
private BytesRef	getTermFromIndex(long index)
ImpactsEnum	impacts(int flags)	Return a ImpactsEnum.
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.
long	ord()	Returns ordinal position for current term.
PostingsEnum	postings(PostingsEnum reuse, int flags)	Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required.
private long	seekBlock(BytesRef text)
TermsEnum.SeekStatus	seekCeil(BytesRef text)	Seeks to the specified term, if it exists, or to the next (ceiling) term.
void	seekExact(long ord)	Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord().
private long	seekTermsIndex(BytesRef text)
BytesRef	term()	Returns current term.
long	totalTermFreq()	Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).

Methods inherited from class org.apache.lucene.index.BaseTermsEnum

attributes, seekExact, seekExact, termState

Methods inherited from class org.apache.lucene.index.TermsEnum

postings

Methods inherited from class java.lang.Object

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

Field Details

LZ4_DECOMPRESSOR_PADDING

static final int LZ4_DECOMPRESSOR_PADDING

See Also:

• Constant Field Values

entry

final Lucene80DocValuesProducer.TermsDictEntry entry

blockAddresses

final LongValues blockAddresses

bytes

final IndexInput bytes

blockMask

final long blockMask

indexAddresses

final LongValues indexAddresses

indexBytes

final IndexInput indexBytes

term

final BytesRef term

ord

long ord

blockBuffer

BytesRef blockBuffer

blockInput

ByteArrayDataInput blockInput

currentCompressedBlockStart

long currentCompressedBlockStart

currentCompressedBlockEnd

long currentCompressedBlockEnd

Constructor Details

TermsDict

TermsDict(Lucene80DocValuesProducer.TermsDictEntry entry,
 IndexInput data)
   throws IOException

Throws:

IOException

Method Details

next

public BytesRef next()
              throws IOException

Description copied from interface: BytesRefIterator

Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.

Returns:

the next BytesRef in the iterator or null if the end of the iterator is reached.

Throws:

IOException - If there is a low-level I/O error.

seekExact

public void seekExact(long ord)
               throws IOException

Description copied from class: TermsEnum

Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.

Specified by:

seekExact in class TermsEnum

Throws:

IOException

getTermFromIndex

private BytesRef getTermFromIndex(long index)
                           throws IOException

Throws:

IOException

seekTermsIndex

private long seekTermsIndex(BytesRef text)
                     throws IOException

Throws:

IOException

getFirstTermFromBlock

private BytesRef getFirstTermFromBlock(long block)
                                throws IOException

Throws:

IOException

seekBlock

private long seekBlock(BytesRef text)
                throws IOException

Throws:

IOException

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef text)
                              throws IOException

Description copied from class: TermsEnum

Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.

Specified by:

seekCeil in class TermsEnum

Throws:

IOException

decompressBlock

private void decompressBlock()
                      throws IOException

Throws:

IOException

term

public BytesRef term()
              throws IOException

Description copied from class: TermsEnum

Returns current term. Do not call this when the enum is unpositioned.

Specified by:

term in class TermsEnum

Throws:

IOException

ord

public long ord()
         throws IOException

Description copied from class: TermsEnum

Returns ordinal position for current term. This is an optional method (the codec may throw UnsupportedOperationException). Do not call this when the enum is unpositioned.

Specified by:

ord in class TermsEnum

Throws:

IOException

totalTermFreq

public long totalTermFreq()
                   throws IOException

Description copied from class: TermsEnum

Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.

Specified by:

totalTermFreq in class TermsEnum

Throws:

IOException

postings

public PostingsEnum postings(PostingsEnum reuse,
 int flags)
                      throws IOException

Description copied from class: TermsEnum

Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required. Do not call this when the enum is unpositioned. This method will not return null.

NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the PostingsEnum.

Specified by:

postings in class TermsEnum

Parameters:

reuse - pass a prior PostingsEnum for possible reuse

flags - specifies which optional per-document values you require; see PostingsEnum.FREQS

Throws:

IOException

impacts

public ImpactsEnum impacts(int flags)
                    throws IOException

Description copied from class: TermsEnum

Return a ImpactsEnum.

Specified by:

impacts in class TermsEnum

Throws:

IOException

See Also:

• TermsEnum.postings(PostingsEnum, int)

docFreq

public int docFreq()
            throws IOException

Description copied from class: TermsEnum

Returns the number of documents containing the current term. Do not call this when the enum is unpositioned. TermsEnum.SeekStatus.END.

Specified by:

docFreq in class TermsEnum

Throws:

IOException