devapidocs/src-html/org/apache/hadoop/hbase/SizeCachedKeyValue.html - hbase-site - Git at Google

 <!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, class: SizeCachedKeyValue">
 <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;</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 org.apache.hadoop.hbase.util.Bytes;</span>
 <span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
 <span class="source-line-no">022</span><span id="line-22"></span>
 <span class="source-line-no">023</span><span id="line-23">/**</span>
 <span class="source-line-no">024</span><span id="line-24"> * This class is an extension to KeyValue where rowLen and keyLen are cached. Parsing the backing</span>
 <span class="source-line-no">025</span><span id="line-25"> * byte[] every time to get these values will affect the performance. In read path, we tend to read</span>
 <span class="source-line-no">026</span><span id="line-26"> * these values many times in Comparator, SQM etc. Note: Please do not use these objects in write</span>
 <span class="source-line-no">027</span><span id="line-27"> * path as it will increase the heap space usage. See</span>
 <span class="source-line-no">028</span><span id="line-28"> * https://issues.apache.org/jira/browse/HBASE-13448</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">@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "EQ_DOESNT_OVERRIDE_EQUALS")</span>
 <span class="source-line-no">032</span><span id="line-32">public class SizeCachedKeyValue extends KeyValue {</span>
 <span class="source-line-no">033</span><span id="line-33">  // Overhead in this class alone. Parent's overhead will be considered in usage places by calls to</span>
 <span class="source-line-no">034</span><span id="line-34">  // super. methods</span>
 <span class="source-line-no">035</span><span id="line-35">  private static final int FIXED_OVERHEAD = Bytes.SIZEOF_SHORT + Bytes.SIZEOF_INT;</span>
 <span class="source-line-no">036</span><span id="line-36"></span>
 <span class="source-line-no">037</span><span id="line-37">  private short rowLen;</span>
 <span class="source-line-no">038</span><span id="line-38">  private int keyLen;</span>
 <span class="source-line-no">039</span><span id="line-39"></span>
 <span class="source-line-no">040</span><span id="line-40">  public SizeCachedKeyValue(byte[] bytes, int offset, int length, long seqId, int keyLen) {</span>
 <span class="source-line-no">041</span><span id="line-41">    super(bytes, offset, length);</span>
 <span class="source-line-no">042</span><span id="line-42">    // We will read all these cached values at least once. Initialize now itself so that we can</span>
 <span class="source-line-no">043</span><span id="line-43">    // avoid uninitialized checks with every time call</span>
 <span class="source-line-no">044</span><span id="line-44">    this.rowLen = super.getRowLength();</span>
 <span class="source-line-no">045</span><span id="line-45">    this.keyLen = keyLen;</span>
 <span class="source-line-no">046</span><span id="line-46">    setSequenceId(seqId);</span>
 <span class="source-line-no">047</span><span id="line-47">  }</span>
 <span class="source-line-no">048</span><span id="line-48"></span>
 <span class="source-line-no">049</span><span id="line-49">  public SizeCachedKeyValue(byte[] bytes, int offset, int length, long seqId, int keyLen,</span>
 <span class="source-line-no">050</span><span id="line-50">    short rowLen) {</span>
 <span class="source-line-no">051</span><span id="line-51">    super(bytes, offset, length);</span>
 <span class="source-line-no">052</span><span id="line-52">    // We will read all these cached values at least once. Initialize now itself so that we can</span>
 <span class="source-line-no">053</span><span id="line-53">    // avoid uninitialized checks with every time call</span>
 <span class="source-line-no">054</span><span id="line-54">    this.rowLen = rowLen;</span>
 <span class="source-line-no">055</span><span id="line-55">    this.keyLen = keyLen;</span>
 <span class="source-line-no">056</span><span id="line-56">    setSequenceId(seqId);</span>
 <span class="source-line-no">057</span><span id="line-57">  }</span>
 <span class="source-line-no">058</span><span id="line-58"></span>
 <span class="source-line-no">059</span><span id="line-59">  @Override</span>
 <span class="source-line-no">060</span><span id="line-60">  public short getRowLength() {</span>
 <span class="source-line-no">061</span><span id="line-61">    return rowLen;</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">  @Override</span>
 <span class="source-line-no">065</span><span id="line-65">  public int getKeyLength() {</span>
 <span class="source-line-no">066</span><span id="line-66">    return this.keyLen;</span>
 <span class="source-line-no">067</span><span id="line-67">  }</span>
 <span class="source-line-no">068</span><span id="line-68"></span>
 <span class="source-line-no">069</span><span id="line-69">  @Override</span>
 <span class="source-line-no">070</span><span id="line-70">  public long heapSize() {</span>
 <span class="source-line-no">071</span><span id="line-71">    return super.heapSize() + FIXED_OVERHEAD;</span>
 <span class="source-line-no">072</span><span id="line-72">  }</span>
 <span class="source-line-no">073</span><span id="line-73"></span>
 <span class="source-line-no">074</span><span id="line-74">  /**</span>
 <span class="source-line-no">075</span><span id="line-75">   * Override by just returning the length for saving cost of method dispatching. If not, it will</span>
 <span class="source-line-no">076</span><span id="line-76">   * call {@link ExtendedCell#getSerializedSize()} firstly, then forward to</span>
 <span class="source-line-no">077</span><span id="line-77">   * {@link SizeCachedKeyValue#getSerializedSize(boolean)}. (See HBASE-21657)</span>
 <span class="source-line-no">078</span><span id="line-78">   */</span>
 <span class="source-line-no">079</span><span id="line-79">  @Override</span>
 <span class="source-line-no">080</span><span id="line-80">  public int getSerializedSize() {</span>
 <span class="source-line-no">081</span><span id="line-81">    return this.length;</span>
 <span class="source-line-no">082</span><span id="line-82">  }</span>
 <span class="source-line-no">083</span><span id="line-83">}</span>


 </pre>
 </div>
 </main>
 </body>
 </html>
	<!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, class: SizeCachedKeyValue">
	<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;</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 org.apache.hadoop.hbase.util.Bytes;</span>
	<span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
	<span class="source-line-no">022</span><span id="line-22"></span>
	<span class="source-line-no">023</span><span id="line-23">/**</span>
	<span class="source-line-no">024</span><span id="line-24"> * This class is an extension to KeyValue where rowLen and keyLen are cached. Parsing the backing</span>
	<span class="source-line-no">025</span><span id="line-25"> * byte[] every time to get these values will affect the performance. In read path, we tend to read</span>
	<span class="source-line-no">026</span><span id="line-26"> * these values many times in Comparator, SQM etc. Note: Please do not use these objects in write</span>
	<span class="source-line-no">027</span><span id="line-27"> * path as it will increase the heap space usage. See</span>
	<span class="source-line-no">028</span><span id="line-28"> * https://issues.apache.org/jira/browse/HBASE-13448</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">@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "EQ_DOESNT_OVERRIDE_EQUALS")</span>
	<span class="source-line-no">032</span><span id="line-32">public class SizeCachedKeyValue extends KeyValue {</span>
	<span class="source-line-no">033</span><span id="line-33"> // Overhead in this class alone. Parent's overhead will be considered in usage places by calls to</span>
	<span class="source-line-no">034</span><span id="line-34"> // super. methods</span>
	<span class="source-line-no">035</span><span id="line-35"> private static final int FIXED_OVERHEAD = Bytes.SIZEOF_SHORT + Bytes.SIZEOF_INT;</span>
	<span class="source-line-no">036</span><span id="line-36"></span>
	<span class="source-line-no">037</span><span id="line-37"> private short rowLen;</span>
	<span class="source-line-no">038</span><span id="line-38"> private int keyLen;</span>
	<span class="source-line-no">039</span><span id="line-39"></span>
	<span class="source-line-no">040</span><span id="line-40"> public SizeCachedKeyValue(byte[] bytes, int offset, int length, long seqId, int keyLen) {</span>
	<span class="source-line-no">041</span><span id="line-41"> super(bytes, offset, length);</span>
	<span class="source-line-no">042</span><span id="line-42"> // We will read all these cached values at least once. Initialize now itself so that we can</span>
	<span class="source-line-no">043</span><span id="line-43"> // avoid uninitialized checks with every time call</span>
	<span class="source-line-no">044</span><span id="line-44"> this.rowLen = super.getRowLength();</span>
	<span class="source-line-no">045</span><span id="line-45"> this.keyLen = keyLen;</span>
	<span class="source-line-no">046</span><span id="line-46"> setSequenceId(seqId);</span>
	<span class="source-line-no">047</span><span id="line-47"> }</span>
	<span class="source-line-no">048</span><span id="line-48"></span>
	<span class="source-line-no">049</span><span id="line-49"> public SizeCachedKeyValue(byte[] bytes, int offset, int length, long seqId, int keyLen,</span>
	<span class="source-line-no">050</span><span id="line-50"> short rowLen) {</span>
	<span class="source-line-no">051</span><span id="line-51"> super(bytes, offset, length);</span>
	<span class="source-line-no">052</span><span id="line-52"> // We will read all these cached values at least once. Initialize now itself so that we can</span>
	<span class="source-line-no">053</span><span id="line-53"> // avoid uninitialized checks with every time call</span>
	<span class="source-line-no">054</span><span id="line-54"> this.rowLen = rowLen;</span>
	<span class="source-line-no">055</span><span id="line-55"> this.keyLen = keyLen;</span>
	<span class="source-line-no">056</span><span id="line-56"> setSequenceId(seqId);</span>
	<span class="source-line-no">057</span><span id="line-57"> }</span>
	<span class="source-line-no">058</span><span id="line-58"></span>
	<span class="source-line-no">059</span><span id="line-59"> @Override</span>
	<span class="source-line-no">060</span><span id="line-60"> public short getRowLength() {</span>
	<span class="source-line-no">061</span><span id="line-61"> return rowLen;</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"> @Override</span>
	<span class="source-line-no">065</span><span id="line-65"> public int getKeyLength() {</span>
	<span class="source-line-no">066</span><span id="line-66"> return this.keyLen;</span>
	<span class="source-line-no">067</span><span id="line-67"> }</span>
	<span class="source-line-no">068</span><span id="line-68"></span>
	<span class="source-line-no">069</span><span id="line-69"> @Override</span>
	<span class="source-line-no">070</span><span id="line-70"> public long heapSize() {</span>
	<span class="source-line-no">071</span><span id="line-71"> return super.heapSize() + FIXED_OVERHEAD;</span>
	<span class="source-line-no">072</span><span id="line-72"> }</span>
	<span class="source-line-no">073</span><span id="line-73"></span>
	<span class="source-line-no">074</span><span id="line-74"> /**</span>
	<span class="source-line-no">075</span><span id="line-75"> * Override by just returning the length for saving cost of method dispatching. If not, it will</span>
	<span class="source-line-no">076</span><span id="line-76"> * call {@link ExtendedCell#getSerializedSize()} firstly, then forward to</span>
	<span class="source-line-no">077</span><span id="line-77"> * {@link SizeCachedKeyValue#getSerializedSize(boolean)}. (See HBASE-21657)</span>
	<span class="source-line-no">078</span><span id="line-78"> */</span>
	<span class="source-line-no">079</span><span id="line-79"> @Override</span>
	<span class="source-line-no">080</span><span id="line-80"> public int getSerializedSize() {</span>
	<span class="source-line-no">081</span><span id="line-81"> return this.length;</span>
	<span class="source-line-no">082</span><span id="line-82"> }</span>
	<span class="source-line-no">083</span><span id="line-83">}</span>




























































	</pre>
	</div>
	</main>
	</body>
	</html>