Class STUniformSplitPostingsFormat
java.lang.Object
org.apache.lucene.codecs.PostingsFormat
org.apache.lucene.codecs.uniformsplit.UniformSplitPostingsFormat
org.apache.lucene.codecs.uniformsplit.sharedterms.STUniformSplitPostingsFormat
- All Implemented Interfaces:
NamedSPILoader.NamedSPI
PostingsFormat based on the Uniform Split technique and supporting Shared Terms.
Shared Terms means the terms of all fields are stored in the same block file, with multiple fields associated to one term (one block line). In the same way, the dictionary trie is also shared between all fields. This highly reduces the memory required by the field dictionary compared to having one separate dictionary per field.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringExtension of the file containing the terms blocks for each field and the fields metadata.static final StringExtension of the file containing the terms dictionary (the FST "trie").static final intFields inherited from class org.apache.lucene.codecs.uniformsplit.UniformSplitPostingsFormat
blockDecoder, blockEncoder, deltaNumLines, dictionaryOnHeap, targetNumBlockLines, VERSION_ENCODABLE_FIELDS_METADATA, VERSION_STARTFields inherited from class org.apache.lucene.codecs.PostingsFormat
EMPTY -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreates aSTUniformSplitPostingsFormatwith default settings.STUniformSplitPostingsFormat(int targetNumBlockLines, int deltaNumLines, BlockEncoder blockEncoder, BlockDecoder blockDecoder, boolean dictionaryOnHeap) protectedSTUniformSplitPostingsFormat(String name, int targetNumBlockLines, int deltaNumLines, BlockEncoder blockEncoder, BlockDecoder blockDecoder, boolean dictionaryOnHeap) -
Method Summary
Modifier and TypeMethodDescriptionprotected FieldsProducercreateUniformSplitTermsReader(PostingsReaderBase postingsReader, SegmentReadState state, BlockDecoder blockDecoder) protected FieldsConsumercreateUniformSplitTermsWriter(PostingsWriterBase postingsWriter, SegmentWriteState state, int targetNumBlockLines, int deltaNumLines, BlockEncoder blockEncoder) Methods inherited from class org.apache.lucene.codecs.uniformsplit.UniformSplitPostingsFormat
fieldsConsumer, fieldsProducerMethods inherited from class org.apache.lucene.codecs.PostingsFormat
availablePostingsFormats, forName, getName, reloadPostingsFormats, toString
-
Field Details
-
TERMS_DICTIONARY_EXTENSION
Extension of the file containing the terms dictionary (the FST "trie").- See Also:
-
TERMS_BLOCKS_EXTENSION
Extension of the file containing the terms blocks for each field and the fields metadata.- See Also:
-
VERSION_CURRENT
public static final int VERSION_CURRENT- See Also:
-
NAME
- See Also:
-
-
Constructor Details
-
STUniformSplitPostingsFormat
public STUniformSplitPostingsFormat()Creates aSTUniformSplitPostingsFormatwith default settings. -
STUniformSplitPostingsFormat
public STUniformSplitPostingsFormat(int targetNumBlockLines, int deltaNumLines, BlockEncoder blockEncoder, BlockDecoder blockDecoder, boolean dictionaryOnHeap) - See Also:
-
STUniformSplitPostingsFormat
protected STUniformSplitPostingsFormat(String name, int targetNumBlockLines, int deltaNumLines, BlockEncoder blockEncoder, BlockDecoder blockDecoder, boolean dictionaryOnHeap)
-
-
Method Details
-
createUniformSplitTermsWriter
protected FieldsConsumer createUniformSplitTermsWriter(PostingsWriterBase postingsWriter, SegmentWriteState state, int targetNumBlockLines, int deltaNumLines, BlockEncoder blockEncoder) throws IOException - Overrides:
createUniformSplitTermsWriterin classUniformSplitPostingsFormat- Throws:
IOException
-
createUniformSplitTermsReader
protected FieldsProducer createUniformSplitTermsReader(PostingsReaderBase postingsReader, SegmentReadState state, BlockDecoder blockDecoder) throws IOException - Overrides:
createUniformSplitTermsReaderin classUniformSplitPostingsFormat- Throws:
IOException
-