1 /*
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 package org.apache.hadoop.hbase.util;
20
21 import org.apache.hadoop.classification.InterfaceAudience;
22 import org.apache.hadoop.io.RawComparator;
23
24 /**
25 * Common methods Bloom filter methods required at read and write time.
26 */
27 @InterfaceAudience.Private
28 public interface BloomFilterBase {
29
30 /**
31 * @return The number of keys added to the bloom
32 */
33 long getKeyCount();
34
35 /**
36 * @return The max number of keys that can be inserted
37 * to maintain the desired error rate
38 */
39 long getMaxKeys();
40
41 /**
42 * @return Size of the bloom, in bytes
43 */
44 long getByteSize();
45
46 /**
47 * Create a key for a row-column Bloom filter.
48 */
49 byte[] createBloomKey(byte[] rowBuf, int rowOffset, int rowLen,
50 byte[] qualBuf, int qualOffset, int qualLen);
51
52 /**
53 * @return Bloom key comparator
54 */
55 RawComparator<byte[]> getComparator();
56
57 }