View Javadoc

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