blob: b0d1dc2bfd8bc87e30706086c5b0c1b870cdd69e [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.util, class: BloomContext">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.CellComparator;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ExtendedCell;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.io.hfile.HFile;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">/**</span>
<span class="source-line-no">028</span><span id="line-28"> * The bloom context that is used by the StorefileWriter to add the bloom details per cell</span>
<span class="source-line-no">029</span><span id="line-29"> */</span>
<span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Private</span>
<span class="source-line-no">031</span><span id="line-31">public abstract class BloomContext {</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33"> protected BloomFilterWriter bloomFilterWriter;</span>
<span class="source-line-no">034</span><span id="line-34"> protected CellComparator comparator;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36"> public BloomContext(BloomFilterWriter bloomFilterWriter, CellComparator comparator) {</span>
<span class="source-line-no">037</span><span id="line-37"> this.bloomFilterWriter = bloomFilterWriter;</span>
<span class="source-line-no">038</span><span id="line-38"> this.comparator = comparator;</span>
<span class="source-line-no">039</span><span id="line-39"> }</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> public Cell getLastCell() {</span>
<span class="source-line-no">042</span><span id="line-42"> return this.bloomFilterWriter.getPrevCell();</span>
<span class="source-line-no">043</span><span id="line-43"> }</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> /**</span>
<span class="source-line-no">046</span><span id="line-46"> * Bloom information from the cell is retrieved</span>
<span class="source-line-no">047</span><span id="line-47"> */</span>
<span class="source-line-no">048</span><span id="line-48"> public void writeBloom(ExtendedCell cell) throws IOException {</span>
<span class="source-line-no">049</span><span id="line-49"> // only add to the bloom filter on a new, unique key</span>
<span class="source-line-no">050</span><span id="line-50"> if (isNewKey(cell)) {</span>
<span class="source-line-no">051</span><span id="line-51"> sanityCheck(cell);</span>
<span class="source-line-no">052</span><span id="line-52"> bloomFilterWriter.append(cell);</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"> }</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private void sanityCheck(ExtendedCell cell) throws IOException {</span>
<span class="source-line-no">057</span><span id="line-57"> if (this.getLastCell() != null) {</span>
<span class="source-line-no">058</span><span id="line-58"> if (comparator.compare(cell, this.getLastCell()) &lt;= 0) {</span>
<span class="source-line-no">059</span><span id="line-59"> throw new IOException("Added a key not lexically larger than" + " previous. Current cell = "</span>
<span class="source-line-no">060</span><span id="line-60"> + cell + ", prevCell = " + this.getLastCell());</span>
<span class="source-line-no">061</span><span id="line-61"> }</span>
<span class="source-line-no">062</span><span id="line-62"> }</span>
<span class="source-line-no">063</span><span id="line-63"> }</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> /**</span>
<span class="source-line-no">066</span><span id="line-66"> * Adds the last bloom key to the HFile Writer as part of StorefileWriter close.</span>
<span class="source-line-no">067</span><span id="line-67"> */</span>
<span class="source-line-no">068</span><span id="line-68"> public abstract void addLastBloomKey(HFile.Writer writer) throws IOException;</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> /**</span>
<span class="source-line-no">071</span><span id="line-71"> * Returns true if the cell is a new key as per the bloom type</span>
<span class="source-line-no">072</span><span id="line-72"> * @param cell the cell to be verified</span>
<span class="source-line-no">073</span><span id="line-73"> * @return true if a new key else false</span>
<span class="source-line-no">074</span><span id="line-74"> */</span>
<span class="source-line-no">075</span><span id="line-75"> protected abstract boolean isNewKey(ExtendedCell cell);</span>
<span class="source-line-no">076</span><span id="line-76">}</span>
</pre>
</div>
</main>
</body>
</html>