Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.uniformsplit.sharedterms

Class STBlockReader

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.BaseTermsEnum

org.apache.lucene.codecs.uniformsplit.BlockReader

org.apache.lucene.codecs.uniformsplit.sharedterms.STBlockReader

All Implemented Interfaces:

Accountable, BytesRefIterator

Direct Known Subclasses:

STMergingBlockReader

public class STBlockReader
extends BlockReader

Reads terms blocks with the Shared Terms format.

See Also:

• STBlockWriter

Nested Class Summary

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

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected final FieldInfos	fieldInfos

Fields inherited from class org.apache.lucene.codecs.uniformsplit.BlockReader

blockDecoder, blockFirstLineStart, blockHeader, blockHeaderReader, blockInput, blockLine, blockLineReader, blockReadBuffer, blockStartFP, dictionaryBrowser, dictionaryBrowserSupplier, fieldMetadata, forcedTerm, lineIndexInBlock, postingsReader, scratchBlockBytes, scratchBlockLine, scratchTermState, termState, termStateForced, termStateSerializer, termStatesReadBuffer

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

EMPTY

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
STBlockReader(IndexDictionary.BrowserSupplier dictionaryBrowserSupplier, IndexInput blockInput, PostingsReaderBase postingsReader, FieldMetadata fieldMetadata, BlockDecoder blockDecoder, FieldInfos fieldInfos)

Method Summary

Modifier and Type	Method	Description
protected STBlockLine.Serializer	createBlockLineSerializer()
protected boolean	isBeyondLastTerm(BytesRef searchedTerm, long blockStartFP)	Indicates whether the searched term is beyond the last term of the field.
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.
protected BytesRef	nextTerm()	Moves to the next term line and reads it, whichever are the corresponding fields.
protected BlockTermState	readTermState()	Reads the BlockTermState on the current line for this reader's field.
TermsEnum.SeekStatus	seekCeil(BytesRef searchedTerm)	Seeks to the specified term, if it exists, or to the next (ceiling) term.
(package private) TermsEnum.SeekStatus	seekCeilIgnoreField(BytesRef searchedTerm)
boolean	seekExact(BytesRef searchedTerm)	Attempts to seek to the exact term, returning true if the term is found.
private boolean	termOccursInField()

Methods inherited from class org.apache.lucene.codecs.uniformsplit.BlockReader

clearTermState, compareToMiddleAndJump, createBlockHeaderSerializer, createDeltaBaseTermStateSerializer, decodeBlockBytesIfNeeded, docFreq, getOrCreateDictionaryBrowser, impacts, initializeBlockReadLazily, initializeHeader, isCurrentTerm, newCorruptIndexException, ord, postings, ramBytesUsed, readHeader, readLineInBlock, readTermStateIfNotRead, seekExact, seekExact, seekInBlock, seekInBlock, term, termState, totalTermFreq

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

attributes

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

fieldInfos

protected final FieldInfos fieldInfos

Constructor Details

STBlockReader

public STBlockReader(IndexDictionary.BrowserSupplier dictionaryBrowserSupplier,
 IndexInput blockInput,
 PostingsReaderBase postingsReader,
 FieldMetadata fieldMetadata,
 BlockDecoder blockDecoder,
 FieldInfos fieldInfos)
              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.

Specified by:

next in interface BytesRefIterator

Overrides:

next in class BlockReader

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.

termOccursInField

private boolean termOccursInField()
                           throws IOException

Throws:

IOException

nextTerm

protected BytesRef nextTerm()
                     throws IOException

Moves to the next term line and reads it, whichever are the corresponding fields. The term details are not read yet. They will be read only when needed with BlockReader.readTermStateIfNotRead().

Overrides:

nextTerm in class BlockReader

Returns:

The read term bytes.

Throws:

IOException

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef searchedTerm)
                              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.

Overrides:

seekCeil in class BlockReader

Throws:

IOException

seekCeilIgnoreField

TermsEnum.SeekStatus seekCeilIgnoreField(BytesRef searchedTerm)
                                  throws IOException

Throws:

IOException

seekExact

public boolean seekExact(BytesRef searchedTerm)
                  throws IOException

Description copied from class: TermsEnum

Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster than TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Overrides:

seekExact in class BlockReader

Returns:

true if the term is found; return false if the enum is unpositioned.

Throws:

IOException

isBeyondLastTerm

protected boolean isBeyondLastTerm(BytesRef searchedTerm,
 long blockStartFP)

Description copied from class: BlockReader

Indicates whether the searched term is beyond the last term of the field.

Overrides:

isBeyondLastTerm in class BlockReader

Parameters:

blockStartFP - The current block start file pointer.

createBlockLineSerializer

protected STBlockLine.Serializer createBlockLineSerializer()

Overrides:

createBlockLineSerializer in class BlockReader

readTermState

protected BlockTermState readTermState()
                                throws IOException

Reads the BlockTermState on the current line for this reader's field.

Overrides:

readTermState in class BlockReader

Returns:

The BlockTermState; or null if the term does not occur for the field.

Throws:

IOException