org.apache.lucene.codecs.lucene54

Class Lucene54DocValuesProducer.CompressedBinaryDocValues.CompressedBinaryTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.codecs.lucene54.Lucene54DocValuesProducer.CompressedBinaryDocValues.CompressedBinaryTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

Lucene54DocValuesProducer.CompressedBinaryDocValues

class Lucene54DocValuesProducer.CompressedBinaryDocValues.CompressedBinaryTermsEnum
extends TermsEnum

Nested Class Summary

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

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	buffer
private long	currentBlockStart
private long	currentOrd
private BytesRef	firstTerm
private IndexInput	input
private int[]	offsets
private BytesRef	scratch
private BytesRef	term

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
CompressedBinaryTermsEnum(IndexInput input)

Method Summary

Modifier and Type	Method and Description
(package private) long	binarySearchBlock(BytesRef text, long low, long high)
(package private) long	binarySearchIndex(BytesRef text)
int	docFreq() Returns the number of documents containing the current term.
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 void	readByteAddresses()
private void	readFirstTerm()
private void	readHeader()
private void	readShortAddresses()
private void	readTerm(int offset)
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().
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.TermsEnum

attributes, postings, seekExact, seekExact, termState

Methods inherited from class java.lang.Object

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

Field Detail

currentOrd

private long currentOrd

currentBlockStart

private long currentBlockStart

input

private final IndexInput input

offsets

private final int[] offsets

buffer

private final byte[] buffer

term

private final BytesRef term

firstTerm

private final BytesRef firstTerm

scratch

private final BytesRef scratch

Constructor Detail

CompressedBinaryTermsEnum

CompressedBinaryTermsEnum(IndexInput input)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

readHeader

private void readHeader()
                 throws java.io.IOException

Throws:

java.io.IOException

readByteAddresses

private void readByteAddresses()
                        throws java.io.IOException

Throws:

java.io.IOException

readShortAddresses

private void readShortAddresses()
                         throws java.io.IOException

Throws:

java.io.IOException

readFirstTerm

private void readFirstTerm()
                    throws java.io.IOException

Throws:

java.io.IOException

readTerm

private void readTerm(int offset)
               throws java.io.IOException

Throws:

java.io.IOException

next

public BytesRef next()
              throws java.io.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:

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

binarySearchIndex

long binarySearchIndex(BytesRef text)
                throws java.io.IOException

Throws:

java.io.IOException

binarySearchBlock

long binarySearchBlock(BytesRef text,
                       long low,
                       long high)
                throws java.io.IOException

Throws:

java.io.IOException

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef text)
                              throws java.io.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:

java.io.IOException

seekExact

public void seekExact(long ord)
               throws java.io.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:

java.io.IOException

term

public BytesRef term()
              throws java.io.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:

java.io.IOException

ord

public long ord()
         throws java.io.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:

java.io.IOException

docFreq

public int docFreq()
            throws java.io.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:

java.io.IOException

totalTermFreq

public long totalTermFreq()
                   throws java.io.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). This will be -1 if the codec doesn't support this measure. Note that, like other term measures, this measure does not take deleted documents into account.

Specified by:

totalTermFreq in class TermsEnum

Throws:

java.io.IOException

postings

public PostingsEnum postings(PostingsEnum reuse,
                             int flags)
                      throws java.io.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 may return null if the postings information required is not available from the index

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:

java.io.IOException