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.io.hfile;
019
020import org.apache.hadoop.hbase.CellComparator;
021import org.apache.hadoop.hbase.util.BloomFilterBase;
022import org.apache.yetus.audience.InterfaceAudience;
023
024@InterfaceAudience.Private
025public class CompoundBloomFilterBase implements BloomFilterBase {
026
027  /**
028   * At read time, the total number of chunks. At write time, the number of chunks created so far.
029   * The first chunk has an ID of 0, and the current chunk has the ID of numChunks - 1.
030   */
031  protected int numChunks;
032
033  /**
034   * The Bloom filter version. There used to be a DynamicByteBloomFilter which had version 2.
035   */
036  public static final int VERSION = 3;
037
038  /** Target error rate for configuring the filter and for information */
039  protected float errorRate;
040
041  /** The total number of keys in all chunks */
042  protected long totalKeyCount;
043  protected long totalByteSize;
044  protected long totalMaxKeys;
045
046  /** Hash function type to use, as defined in {@link org.apache.hadoop.hbase.util.Hash} */
047  protected int hashType;
048  /** Comparator used to compare Bloom filter keys */
049  protected CellComparator comparator;
050
051  @Override
052  public long getMaxKeys() {
053    return totalMaxKeys;
054  }
055
056  @Override
057  public long getKeyCount() {
058    return totalKeyCount;
059  }
060
061  @Override
062  public long getByteSize() {
063    return totalByteSize;
064  }
065
066}