001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.util;
019
020import org.apache.hadoop.hbase.Cell;
021import org.apache.hadoop.hbase.regionserver.CellSink;
022import org.apache.hadoop.hbase.regionserver.ShipperListener;
023import org.apache.hadoop.io.Writable;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * Specifies methods needed to add elements to a Bloom filter and serialize the resulting Bloom
028 * filter as a sequence of bytes.
029 */
030@InterfaceAudience.Private
031public interface BloomFilterWriter extends BloomFilterBase, CellSink, ShipperListener {
032
033  /** Compact the Bloom filter before writing metadata & data to disk. */
034  void compactBloom();
035
036  /**
037   * Get a writable interface into bloom filter meta data.
038   * @return a writable instance that can be later written to a stream
039   */
040  Writable getMetaWriter();
041
042  /**
043   * Get a writable interface into bloom filter data (the actual Bloom bits). Not used for compound
044   * Bloom filters.
045   * @return a writable instance that can be later written to a stream
046   */
047  Writable getDataWriter();
048
049  /**
050   * Returns the previous cell written by this writer
051   * @return the previous cell
052   */
053  Cell getPrevCell();
054}