org.apache.lucene.codecs.uniformsplit

Class UniformSplitTerms

java.lang.Object

Terms

org.apache.lucene.codecs.uniformsplit.UniformSplitTerms

Direct Known Subclasses:

STUniformSplitTerms

public class UniformSplitTerms
extends Terms

Terms based on the Uniform Split technique.

The index dictionary is lazy loaded only when TermsEnum#seekCeil or TermsEnum#seekExact are called (it is not loaded for a direct terms enumeration).

See Also:

UniformSplitTermsWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockDecoder	blockDecoder
protected IndexInput	blockInput
protected DictionaryBrowserSupplier	dictionaryBrowserSupplier
protected FieldMetadata	fieldMetadata
protected PostingsReaderBase	postingsReader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UniformSplitTerms(IndexInput blockInput, FieldMetadata fieldMetadata, PostingsReaderBase postingsReader, BlockDecoder blockDecoder, DictionaryBrowserSupplier dictionaryBrowserSupplier)
protected	UniformSplitTerms(IndexInput dictionaryInput, IndexInput blockInput, FieldMetadata fieldMetadata, PostingsReaderBase postingsReader, BlockDecoder blockDecoder)

Method Summary

Modifier and Type	Method and Description
protected void	checkIntersectAutomatonType(CompiledAutomaton automaton)
long	getDictionaryRamBytesUsed()
int	getDocCount()
BytesRef	getMax()
long	getSumDocFreq()
long	getSumTotalTermFreq()
boolean	hasFreqs()
boolean	hasOffsets()
boolean	hasPayloads()
boolean	hasPositions()
TermsEnum	intersect(CompiledAutomaton compiled, BytesRef startTerm)
TermsEnum	iterator()
long	ramBytesUsed()
long	ramBytesUsedWithoutDictionary()
long	size()

Methods inherited from class java.lang.Object

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

Field Detail

blockInput

protected final IndexInput blockInput

fieldMetadata

protected final FieldMetadata fieldMetadata

postingsReader

protected final PostingsReaderBase postingsReader

blockDecoder

protected final BlockDecoder blockDecoder

dictionaryBrowserSupplier

protected final DictionaryBrowserSupplier dictionaryBrowserSupplier

Constructor Detail

UniformSplitTerms

protected UniformSplitTerms(IndexInput dictionaryInput,
                            IndexInput blockInput,
                            FieldMetadata fieldMetadata,
                            PostingsReaderBase postingsReader,
                            BlockDecoder blockDecoder)
                     throws java.io.IOException

Parameters:

blockDecoder - Optional block decoder, may be null if none. It can be used for decompression or decryption.

Throws:

java.io.IOException

UniformSplitTerms

protected UniformSplitTerms(IndexInput blockInput,
                            FieldMetadata fieldMetadata,
                            PostingsReaderBase postingsReader,
                            BlockDecoder blockDecoder,
                            DictionaryBrowserSupplier dictionaryBrowserSupplier)

Parameters:

blockDecoder - Optional block decoder, may be null if none. It can be used for decompression or decryption.

Method Detail

iterator

public TermsEnum iterator()
                   throws java.io.IOException

Throws:

java.io.IOException

intersect

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

Throws:

java.io.IOException

checkIntersectAutomatonType

protected void checkIntersectAutomatonType(CompiledAutomaton automaton)

getMax

public BytesRef getMax()

size

public long size()

getSumTotalTermFreq

public long getSumTotalTermFreq()

getSumDocFreq

public long getSumDocFreq()

getDocCount

public int getDocCount()

hasFreqs

public boolean hasFreqs()

hasOffsets

public boolean hasOffsets()

hasPositions

public boolean hasPositions()

hasPayloads

public boolean hasPayloads()

ramBytesUsed

public long ramBytesUsed()

ramBytesUsedWithoutDictionary

public long ramBytesUsedWithoutDictionary()

getDictionaryRamBytesUsed

public long getDictionaryRamBytesUsed()