org.elasticsearch.index.codec.postingsformat

Class BloomFilterPostingsFormat

java.lang.Object

org.apache.lucene.codecs.PostingsFormat

org.elasticsearch.index.codec.postingsformat.BloomFilterPostingsFormat

All Implemented Interfaces:

org.apache.lucene.util.NamedSPILoader.NamedSPI

Deprecated.

only for reading old segments

@Deprecated
public class BloomFilterPostingsFormat
extends org.apache.lucene.codecs.PostingsFormat

A PostingsFormat useful for low doc-frequency fields such as primary keys. Bloom filters are maintained in a ".blm" file which offers "fast-fail" for reads in segments known to have no record of the key. A choice of delegate PostingsFormat is used to record all other Postings data.

This is a special bloom filter version, based on BloomFilter and inspired by Lucene org.apache.lucene.codecs.bloom.BloomFilteringPostingsFormat.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BloomFilterPostingsFormat.BloomFilteredFieldsConsumer Deprecated.
class	BloomFilterPostingsFormat.BloomFilteredFieldsProducer Deprecated.
static class	BloomFilterPostingsFormat.BloomFilteredTerms Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOOM_CODEC_NAME Deprecated.
static int	BLOOM_CODEC_VERSION Deprecated.
static int	BLOOM_CODEC_VERSION_CHECKSUM Deprecated.
static int	BLOOM_CODEC_VERSION_CURRENT Deprecated.

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
BloomFilterPostingsFormat() Deprecated.
BloomFilterPostingsFormat(org.apache.lucene.codecs.PostingsFormat delegatePostingsFormat, BloomFilter.Factory bloomFilterFactory) Deprecated. Creates Bloom filters for a selection of fields created in the index.

Method Summary

Methods

Modifier and Type	Method and Description
BloomFilterPostingsFormat.BloomFilteredFieldsConsumer	fieldsConsumer(org.apache.lucene.index.SegmentWriteState state) Deprecated.
BloomFilterPostingsFormat.BloomFilteredFieldsProducer	fieldsProducer(org.apache.lucene.index.SegmentReadState state) Deprecated.
org.apache.lucene.codecs.PostingsFormat	getDelegate() Deprecated.

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

availablePostingsFormats, forName, getName, reloadPostingsFormats, toString

Methods inherited from class java.lang.Object

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

Field Detail

BLOOM_CODEC_NAME

public static final String BLOOM_CODEC_NAME

Deprecated.

See Also:

Constant Field Values

BLOOM_CODEC_VERSION

public static final int BLOOM_CODEC_VERSION

Deprecated.

See Also:

Constant Field Values

BLOOM_CODEC_VERSION_CHECKSUM

public static final int BLOOM_CODEC_VERSION_CHECKSUM

Deprecated.

See Also:

Constant Field Values

BLOOM_CODEC_VERSION_CURRENT

public static final int BLOOM_CODEC_VERSION_CURRENT

Deprecated.

See Also:

Constant Field Values

Constructor Detail

BloomFilterPostingsFormat

public BloomFilterPostingsFormat(org.apache.lucene.codecs.PostingsFormat delegatePostingsFormat,
                         BloomFilter.Factory bloomFilterFactory)

Deprecated.

Creates Bloom filters for a selection of fields created in the index. This is recorded as a set of Bitsets held as a segment summary in an additional "blm" file. This PostingsFormat delegates to a choice of delegate PostingsFormat for encoding all other postings data.

Parameters:

delegatePostingsFormat - The PostingsFormat that records all the non-bloom filter data i.e. postings info.

bloomFilterFactory - The BloomFilter.Factory responsible for sizing BloomFilters appropriately

BloomFilterPostingsFormat

public BloomFilterPostingsFormat()

Deprecated.

Method Detail

fieldsConsumer

public BloomFilterPostingsFormat.BloomFilteredFieldsConsumer fieldsConsumer(org.apache.lucene.index.SegmentWriteState state)
                                                                     throws IOException

Deprecated.

Specified by:

fieldsConsumer in class org.apache.lucene.codecs.PostingsFormat

Throws:

IOException

fieldsProducer

public BloomFilterPostingsFormat.BloomFilteredFieldsProducer fieldsProducer(org.apache.lucene.index.SegmentReadState state)
                                                                     throws IOException

Deprecated.

Specified by:

fieldsProducer in class org.apache.lucene.codecs.PostingsFormat

Throws:

IOException

getDelegate

public org.apache.lucene.codecs.PostingsFormat getDelegate()

Deprecated.