org.apache.lucene.codecs.uniformsplit.sharedterms

Class STUniformSplitTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.codecs.uniformsplit.UniformSplitTerms

org.apache.lucene.codecs.uniformsplit.sharedterms.STUniformSplitTerms

All Implemented Interfaces:

Accountable

public class STUniformSplitTerms
extends UniformSplitTerms

Extends UniformSplitTerms for a shared-terms dictionary, with all the fields of a term in the same block line.

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldInfos	fieldInfos
protected FieldMetadata	unionFieldMetadata

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

blockDecoder, blockInput, dictionaryBrowserSupplier, fieldMetadata, postingsReader

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

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	STUniformSplitTerms(IndexInput blockInput, FieldMetadata fieldMetadata, FieldMetadata unionFieldMetadata, PostingsReaderBase postingsReader, BlockDecoder blockDecoder, FieldInfos fieldInfos, DictionaryBrowserSupplier dictionaryBrowserSupplier)

Method Summary

Modifier and Type	Method and Description
(package private) STMergingBlockReader	createMergingBlockReader()
TermsEnum	intersect(CompiledAutomaton compiled, BytesRef startTerm) Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton.
TermsEnum	iterator() Returns an iterator that will step through all terms.

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

checkIntersectAutomatonType, getDictionaryRamBytesUsed, getDocCount, getMax, getSumDocFreq, getSumTotalTermFreq, hasFreqs, hasOffsets, hasPayloads, hasPositions, ramBytesUsed, ramBytesUsedWithoutDictionary, size

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

getMin, getStats

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 Detail

unionFieldMetadata

protected final FieldMetadata unionFieldMetadata

fieldInfos

protected final FieldInfos fieldInfos

Constructor Detail

STUniformSplitTerms

protected STUniformSplitTerms(IndexInput blockInput,
                              FieldMetadata fieldMetadata,
                              FieldMetadata unionFieldMetadata,
                              PostingsReaderBase postingsReader,
                              BlockDecoder blockDecoder,
                              FieldInfos fieldInfos,
                              DictionaryBrowserSupplier dictionaryBrowserSupplier)

Method Detail

intersect

public TermsEnum intersect(CompiledAutomaton compiled,
                           BytesRef startTerm)
                    throws java.io.IOException

Description copied from class: Terms

Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only return terms > startTerm, but you still must call next() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

This is an expert low-level API and will only work for NORMAL compiled automata. To handle any compiled automata you should instead use CompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms) instead.

NOTE: the returned TermsEnum cannot seek

.

Overrides:

intersect in class UniformSplitTerms

Throws:

java.io.IOException

iterator

public TermsEnum iterator()
                   throws java.io.IOException

Description copied from class: Terms

Returns an iterator that will step through all terms. This method will not return null.

Overrides:

iterator in class UniformSplitTerms

Throws:

java.io.IOException

createMergingBlockReader

STMergingBlockReader createMergingBlockReader()
                                       throws java.io.IOException

Throws:

java.io.IOException