org.apache.hudi.common.bloom

Class SimpleBloomFilter

java.lang.Object

org.apache.hudi.common.bloom.SimpleBloomFilter

All Implemented Interfaces:

BloomFilter

public class SimpleBloomFilter
extends Object
implements BloomFilter

A Simple Bloom filter implementation built on top of InternalBloomFilter.

Constructor Summary

Constructors

Constructor and Description
SimpleBloomFilter(ByteBuffer byteBuffer) Creates SimpleBloomFilter from the given ByteBuffer.
SimpleBloomFilter(int numEntries, double errorRate, int hashType) Create a new Bloom filter with the given configurations.
SimpleBloomFilter(String serString) Create the bloom filter from serialized string.

Method Summary

Modifier and Type	Method and Description
void	add(byte[] keyBytes) Add a key's bytes, representing UTF8-encoded string, to the BloomFilter.
void	add(String key) Add a key represented by a String to the BloomFilter.
BloomFilterTypeCode	getBloomFilterTypeCode()
boolean	mightContain(String key) Tests for key membership.
void	readFields(DataInput in)
String	serializeToString() Serialize the bloom filter as a string.
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBloomFilter

public SimpleBloomFilter(int numEntries,
                         double errorRate,
                         int hashType)

Create a new Bloom filter with the given configurations.

Parameters:

numEntries - The total number of entries.

errorRate - maximum allowable error rate.

hashType - type of the hashing function (see Hash).

SimpleBloomFilter

public SimpleBloomFilter(String serString)

Create the bloom filter from serialized string.

Parameters:

serString - serialized string which represents the SimpleBloomFilter

SimpleBloomFilter

public SimpleBloomFilter(ByteBuffer byteBuffer)

Creates SimpleBloomFilter from the given ByteBuffer.

Parameters:

byteBuffer - ByteBuffer containing the serialized bloom filter.

Method Detail

add

public void add(String key)

Description copied from interface: BloomFilter

Add a key represented by a String to the BloomFilter.

Specified by:

add in interface BloomFilter

Parameters:

key - the key to the added to the BloomFilter

add

public void add(byte[] keyBytes)

Description copied from interface: BloomFilter

Add a key's bytes, representing UTF8-encoded string, to the BloomFilter.

Specified by:

add in interface BloomFilter

Parameters:

keyBytes - the key bytes to the added to the BloomFilter

mightContain

public boolean mightContain(String key)

Description copied from interface: BloomFilter

Tests for key membership.

Specified by:

mightContain in interface BloomFilter

Parameters:

key - the key to be checked for membership

Returns:

true if key may be found, false if key is not found for sure.

serializeToString

public String serializeToString()

Serialize the bloom filter as a string.

Specified by:

serializeToString in interface BloomFilter

write

public void write(DataOutput out)
           throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Throws:

IOException

getBloomFilterTypeCode

public BloomFilterTypeCode getBloomFilterTypeCode()

Specified by:

getBloomFilterTypeCode in interface BloomFilter

Returns:

the bloom index type code.