Module org.apache.lucene.codecs
Class STMergingBlockReader
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
org.apache.lucene.codecs.uniformsplit.sharedterms.STMergingBlockReader
- All Implemented Interfaces:
Accountable
,BytesRefIterator
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
Fields inherited from class org.apache.lucene.codecs.uniformsplit.sharedterms.STBlockReader
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 interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
ConstructorsConstructorDescriptionSTMergingBlockReader
(IndexDictionary.BrowserSupplier dictionaryBrowserSupplier, IndexInput blockInput, PostingsReaderBase postingsReader, FieldMetadata fieldMetadata, BlockDecoder blockDecoder, FieldInfos fieldInfos) -
Method Summary
Modifier and TypeMethodDescriptionnext()
Increments the iteration to the nextBytesRef
in the iterator.postings
(String fieldName, BlockTermState termState, PostingsEnum reuse, int flags) Creates a newPostingsEnum
for the provided field andBlockTermState
.void
readFieldTermStatesMap
(Map<String, BlockTermState> fieldTermStatesMap) Reads all the fieldsTermState
s of the current term and put them in the provided map.protected BlockTermState
Reads theBlockTermState
if it is not already set.Seeks to the specified term, if it exists, or to the next (ceiling) term.void
seekExact
(long ord) Not supported.boolean
Attempts to seek to the exact term, returning true if the term is found.void
Positions thisBlockReader
without re-seeking the term dictionary.Methods inherited from class org.apache.lucene.codecs.uniformsplit.sharedterms.STBlockReader
createBlockLineSerializer, isBeyondLastTerm, nextTerm, readTermState, seekCeilIgnoreField
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, seekInBlock, seekInBlock, term, termState, totalTermFreq
Methods inherited from class org.apache.lucene.index.BaseTermsEnum
attributes
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
-
Constructor Details
-
STMergingBlockReader
public STMergingBlockReader(IndexDictionary.BrowserSupplier dictionaryBrowserSupplier, IndexInput blockInput, PostingsReaderBase postingsReader, FieldMetadata fieldMetadata, BlockDecoder blockDecoder, FieldInfos fieldInfos) throws IOException - Throws:
IOException
-
-
Method Details
-
seekCeil
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 classSTBlockReader
-
seekExact
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 thanTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.- Overrides:
seekExact
in classSTBlockReader
- Returns:
- true if the term is found; return false if the enum is unpositioned.
-
seekExact
Description copied from class:BlockReader
Positions thisBlockReader
without re-seeking the term dictionary.The block containing the term is not read by this method. It will be read lazily only if needed, for example if
BlockReader.next()
is called. CallingBlockReader.postings(org.apache.lucene.index.PostingsEnum, int)
after this method does require the block to be read.- Overrides:
seekExact
in classBlockReader
- Parameters:
term
- the term the TermState corresponds tostate
- theTermState
-
seekExact
public void seekExact(long ord) Description copied from class:BlockReader
Not supported.- Overrides:
seekExact
in classBlockReader
-
readTermStateIfNotRead
Description copied from class:BlockReader
Reads theBlockTermState
if it is not already set. SetsBlockReader.termState
.- Overrides:
readTermStateIfNotRead
in classBlockReader
-
next
Description copied from interface:BytesRefIterator
Increments the iteration to the nextBytesRef
in the iterator. Returns the resultingBytesRef
ornull
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 interfaceBytesRefIterator
- Overrides:
next
in classSTBlockReader
- Returns:
- the next
BytesRef
in the iterator ornull
if the end of the iterator is reached. - Throws:
IOException
- If there is a low-level I/O error.
-
postings
public PostingsEnum postings(String fieldName, BlockTermState termState, PostingsEnum reuse, int flags) throws IOException Creates a newPostingsEnum
for the provided field andBlockTermState
.- Parameters:
reuse
- PreviousPostingsEnum
to reuse; or null to create a new one.flags
- Postings flags.- Throws:
IOException
-
readFieldTermStatesMap
public void readFieldTermStatesMap(Map<String, BlockTermState> fieldTermStatesMap) throws IOExceptionReads all the fieldsTermState
s of the current term and put them in the provided map. Clears the map first, before puttingTermState
s.- Throws:
IOException
-