View Javadoc

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  
20  package org.apache.hadoop.hbase.util;
21  
22  import org.apache.hadoop.hbase.Cell;
23  import org.apache.hadoop.hbase.classification.InterfaceAudience;
24  import org.apache.hadoop.io.Writable;
25
26  /**
27   * Specifies methods needed to add elements to a Bloom filter and serialize the
28   * resulting Bloom filter as a sequence of bytes.
29   */
30  @InterfaceAudience.Private
31  public interface BloomFilterWriter extends BloomFilterBase {
32
33    /** Compact the Bloom filter before writing metadata & data to disk. */
34    void compactBloom();
35    /**
36     * Get a writable interface into bloom filter meta data.
37     *
38     * @return a writable instance that can be later written to a stream
39     */
40    Writable getMetaWriter();
41
42    /**
43     * Get a writable interface into bloom filter data (the actual Bloom bits).
44     * Not used for compound Bloom filters.
45     *
46     * @return a writable instance that can be later written to a stream
47     */
48    Writable getDataWriter();
49
50    /**
51     * Add the specified binary to the bloom filter.
52     * @param cell the cell data to be added to the bloom
53     */
54    void add(Cell cell);
55  }