org.apache.hudi.common.bloom

Interface BloomFilter

All Known Implementing Classes:

HoodieDynamicBoundedBloomFilter, SimpleBloomFilter

public interface BloomFilter

A Bloom filter interface.

Method Summary

Modifier and Type	Method and Description
void	add(byte[] key) 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.

Method Detail

add

void add(String key)

Add a key represented by a String to the BloomFilter.

Parameters:

key - the key to the added to the BloomFilter

add

void add(byte[] key)

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

Parameters:

key - the key bytes to the added to the BloomFilter

mightContain

boolean mightContain(String key)

Tests for key membership.

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

String serializeToString()

Serialize the bloom filter as a string.

getBloomFilterTypeCode

BloomFilterTypeCode getBloomFilterTypeCode()

Returns:

the bloom index type code.