org.apache.lucene.codecs.autoprefix

Class AutoPrefixPostingsFormat

java.lang.Object

org.apache.lucene.codecs.PostingsFormat

org.apache.lucene.codecs.autoprefix.AutoPrefixPostingsFormat

All Implemented Interfaces:

NamedSPILoader.NamedSPI

public final class AutoPrefixPostingsFormat
extends PostingsFormat

Just like Lucene50PostingsFormat except this format exposes the experimental auto-prefix terms.

Field Summary

Fields inherited from class org.apache.lucene.codecs.PostingsFormat

EMPTY

Constructor Summary

Constructors

Constructor and Description
AutoPrefixPostingsFormat() Creates AutoPrefixPostingsFormat with default settings.
AutoPrefixPostingsFormat(int minItemsInAutoPrefix, int maxItemsInAutoPrefix) Creates Lucene50PostingsFormat with custom values for minBlockSize and maxBlockSize passed to block terms dictionary.
AutoPrefixPostingsFormat(int minItemsInBlock, int maxItemsInBlock, int minItemsInAutoPrefix, int maxItemsInAutoPrefix) Creates Lucene50PostingsFormat with custom values for minBlockSize, maxBlockSize, minItemsInAutoPrefix and maxItemsInAutoPrefix, passed to block tree terms dictionary.

Method Summary

Modifier and Type	Method and Description
FieldsConsumer	fieldsConsumer(SegmentWriteState state) Writes a new segment
FieldsProducer	fieldsProducer(SegmentReadState state) Reads a segment.
java.lang.String	toString()

Methods inherited from class org.apache.lucene.codecs.PostingsFormat

availablePostingsFormats, forName, getName, reloadPostingsFormats

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoPrefixPostingsFormat

public AutoPrefixPostingsFormat()

Creates AutoPrefixPostingsFormat with default settings.

AutoPrefixPostingsFormat

public AutoPrefixPostingsFormat(int minItemsInAutoPrefix,
                                int maxItemsInAutoPrefix)

Creates Lucene50PostingsFormat with custom values for minBlockSize and maxBlockSize passed to block terms dictionary.

See Also:

BlockTreeTermsWriter.BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int)

AutoPrefixPostingsFormat

public AutoPrefixPostingsFormat(int minItemsInBlock,
                                int maxItemsInBlock,
                                int minItemsInAutoPrefix,
                                int maxItemsInAutoPrefix)

Creates Lucene50PostingsFormat with custom values for minBlockSize, maxBlockSize, minItemsInAutoPrefix and maxItemsInAutoPrefix, passed to block tree terms dictionary.

See Also:

BlockTreeTermsWriter.BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int,int,int)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class PostingsFormat

fieldsConsumer

public FieldsConsumer fieldsConsumer(SegmentWriteState state)
                              throws java.io.IOException

Description copied from class: PostingsFormat

Writes a new segment

Specified by:

fieldsConsumer in class PostingsFormat

Throws:

java.io.IOException

fieldsProducer

public FieldsProducer fieldsProducer(SegmentReadState state)
                              throws java.io.IOException

Description copied from class: PostingsFormat

Reads a segment. NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.

Specified by:

fieldsProducer in class PostingsFormat

Throws:

java.io.IOException