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