org.apache.hudi.common.bloom

Class HoodieDynamicBoundedBloomFilter

java.lang.Object

org.apache.hudi.common.bloom.HoodieDynamicBoundedBloomFilter

All Implemented Interfaces:

BloomFilter

public class HoodieDynamicBoundedBloomFilter
extends Object
implements BloomFilter

Hoodie's dynamic bloom bounded bloom filter. This is based largely on Hadoop's DynamicBloomFilter, but with a bound on amount of entries to dynamically expand to. Once the entries added reach the bound, false positive ratio may not be guaranteed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_CODE_PREFIX

Constructor Summary

Constructors

Constructor and Description
HoodieDynamicBoundedBloomFilter(ByteBuffer byteBuffer) Creates HoodieDynamicBoundedBloomFilter from the given ByteBuffer.
HoodieDynamicBoundedBloomFilter(String serString) Generate HoodieDynamicBoundedBloomFilter from the given serString 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.
String	serializeToString() Serialize the bloom filter as a string.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_CODE_PREFIX

public static final String TYPE_CODE_PREFIX

See Also:

Constant Field Values

Constructor Detail

HoodieDynamicBoundedBloomFilter

public HoodieDynamicBoundedBloomFilter(String serString)

Generate HoodieDynamicBoundedBloomFilter from the given serString serialized string.

Parameters:

serString - the serialized string which represents the HoodieDynamicBoundedBloomFilter

HoodieDynamicBoundedBloomFilter

public HoodieDynamicBoundedBloomFilter(ByteBuffer byteBuffer)

Creates HoodieDynamicBoundedBloomFilter 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()

Description copied from interface: BloomFilter

Serialize the bloom filter as a string.

Specified by:

serializeToString in interface BloomFilter

getBloomFilterTypeCode

public BloomFilterTypeCode getBloomFilterTypeCode()

Specified by:

getBloomFilterTypeCode in interface BloomFilter

Returns:

the bloom index type code.