Package org.apache.hadoop.hbase.io.hfile

Class CompoundBloomFilter

java.lang.Object

org.apache.hadoop.hbase.io.hfile.CompoundBloomFilterBase

org.apache.hadoop.hbase.io.hfile.CompoundBloomFilter

All Implemented Interfaces:

BloomFilter, BloomFilterBase

@Private
public class CompoundBloomFilter
extends CompoundBloomFilterBase
implements BloomFilter

A Bloom filter implementation built on top of BloomFilterChunk, encapsulating a set of fixed-size Bloom filters written out at the time of HFile generation into the data block stream, and loaded on demand at query time. This class only provides reading capabilities.

Field Summary

Fields

Modifier and Type	Field	Description
private Hash	hash
private int	hashCount
private HFileBlockIndex.BlockIndexReader	index
private final BloomFilterMetrics	metrics
private long[]	numPositivesPerChunk
private long[]	numQueriesPerChunk
private HFile.Reader	reader	Used to load chunks on demand

Fields inherited from class org.apache.hadoop.hbase.io.hfile.CompoundBloomFilterBase

comparator, errorRate, hashType, numChunks, totalByteSize, totalKeyCount, totalMaxKeys, VERSION

Constructor Summary

Constructors

Constructor	Description
CompoundBloomFilter(DataInput meta, HFile.Reader reader, BloomFilterMetrics metrics)	De-serialization for compound Bloom filter metadata.

Method Summary

Modifier and Type	Method	Description
boolean	contains(byte[] key, int keyOffset, int keyLength, ByteBuff bloom)	Check if the specified key is contained in the bloom filter.
boolean	contains(Cell keyCell, ByteBuff bloom, BloomType type)	Check if the specified key is contained in the bloom filter.
private boolean	containsInternal(byte[] key, int keyOffset, int keyLength, ByteBuff bloom)
private boolean	containsInternal(Cell keyCell, ByteBuff bloom, BloomType type)
void	enableTestingStats()
String	formatTestingStats()
HFileBlock	getBloomBlock(int block)
HFileBlockIndex.BlockIndexReader	getBloomIndex()
Hash	getHash()
int	getHashCount()
int	getNumChunks()
long	getNumPositivesForTesting(int chunk)
long	getNumQueriesForTesting(int chunk)
boolean	supportsAutoLoading()
String	toString()

Methods inherited from class org.apache.hadoop.hbase.io.hfile.CompoundBloomFilterBase

getByteSize, getKeyCount, getMaxKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.util.BloomFilterBase

getByteSize, getKeyCount, getMaxKeys

Field Details

reader

private HFile.Reader reader

Used to load chunks on demand

metrics

private final BloomFilterMetrics metrics

index

private HFileBlockIndex.BlockIndexReader index

hashCount

private int hashCount

hash

private Hash hash

numQueriesPerChunk

private long[] numQueriesPerChunk

numPositivesPerChunk

private long[] numPositivesPerChunk

Constructor Details

CompoundBloomFilter

public CompoundBloomFilter(DataInput meta,
 HFile.Reader reader,
 BloomFilterMetrics metrics)
                    throws IOException

De-serialization for compound Bloom filter metadata. Must be consistent with what CompoundBloomFilterWriter does.

Parameters:

meta - serialized Bloom filter metadata without any magic blocks

reader - reader for hfile

metrics - for collecting bloom filter metrics. may be null

Throws:

IOException

Method Details

contains

public boolean contains(byte[] key,
 int keyOffset,
 int keyLength,
 ByteBuff bloom)

Description copied from interface: BloomFilter

Check if the specified key is contained in the bloom filter.

Specified by:

contains in interface BloomFilter

Parameters:

key - data to check for existence of

keyOffset - offset into the data

keyLength - length of the data

bloom - bloom filter data to search. This can be null if auto-loading is supported.

Returns:

true if matched by bloom, false if not

containsInternal

private boolean containsInternal(byte[] key,
 int keyOffset,
 int keyLength,
 ByteBuff bloom)

getBloomBlock

@LimitedPrivate("Unittest")
public HFileBlock getBloomBlock(int block)

contains

public boolean contains(Cell keyCell,
 ByteBuff bloom,
 BloomType type)

Description copied from interface: BloomFilter

Check if the specified key is contained in the bloom filter.

Specified by:

contains in interface BloomFilter

Parameters:

keyCell - the key to check for the existence of

bloom - bloom filter data to search. This can be null if auto-loading is supported.

type - The type of Bloom ROW/ ROW_COL

Returns:

true if matched by bloom, false if not

containsInternal

private boolean containsInternal(Cell keyCell,
 ByteBuff bloom,
 BloomType type)

supportsAutoLoading

public boolean supportsAutoLoading()

Specified by:

supportsAutoLoading in interface BloomFilter

Returns:

true if this Bloom filter can automatically load its data and thus allows a null byte buffer to be passed to contains()

getNumChunks

public int getNumChunks()

enableTestingStats

public void enableTestingStats()

formatTestingStats

public String formatTestingStats()

getNumQueriesForTesting

public long getNumQueriesForTesting(int chunk)

getNumPositivesForTesting

public long getNumPositivesForTesting(int chunk)

toString

public String toString()

Overrides:

toString in class Object

getBloomIndex

@LimitedPrivate("Unittest")
public HFileBlockIndex.BlockIndexReader getBloomIndex()

getHashCount

@LimitedPrivate("Unittest")
public int getHashCount()

getHash

@LimitedPrivate("Unittest")
public Hash getHash()