| <!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, interface: ExtendedCell"> |
| <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 java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.OutputStream;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.nio.ByteBuffer;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.io.HeapSize;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.ByteBufferUtils;</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"> * Extension to {@link Cell} with server side required functions. Server side Cell implementations</span> |
| <span class="source-line-no">029</span><span id="line-29"> * must implement this.</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.Private</span> |
| <span class="source-line-no">032</span><span id="line-32">public interface ExtendedCell extends RawCell, HeapSize {</span> |
| <span class="source-line-no">033</span><span id="line-33"> int CELL_NOT_BASED_ON_CHUNK = -1;</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35"> /**</span> |
| <span class="source-line-no">036</span><span id="line-36"> * Write this cell to an OutputStream in a {@link KeyValue} format. <br></span> |
| <span class="source-line-no">037</span><span id="line-37"> * KeyValue format <br></span> |
| <span class="source-line-no">038</span><span id="line-38"> * <code>&lt;4 bytes keylength&gt; &lt;4 bytes valuelength&gt; &lt;2 bytes rowlength&gt;</span> |
| <span class="source-line-no">039</span><span id="line-39"> * &lt;row&gt; &lt;1 byte columnfamilylength&gt; &lt;columnfamily&gt; &lt;columnqualifier&gt;</span> |
| <span class="source-line-no">040</span><span id="line-40"> * &lt;8 bytes timestamp&gt; &lt;1 byte keytype&gt; &lt;value&gt; &lt;2 bytes tagslength&gt;</span> |
| <span class="source-line-no">041</span><span id="line-41"> * &lt;tags&gt;</code></span> |
| <span class="source-line-no">042</span><span id="line-42"> * @param out Stream to which cell has to be written</span> |
| <span class="source-line-no">043</span><span id="line-43"> * @param withTags Whether to write tags.</span> |
| <span class="source-line-no">044</span><span id="line-44"> * @return how many bytes are written.</span> |
| <span class="source-line-no">045</span><span id="line-45"> */</span> |
| <span class="source-line-no">046</span><span id="line-46"> // TODO remove the boolean param once HBASE-16706 is done.</span> |
| <span class="source-line-no">047</span><span id="line-47"> default int write(OutputStream out, boolean withTags) throws IOException {</span> |
| <span class="source-line-no">048</span><span id="line-48"> // Key length and then value length</span> |
| <span class="source-line-no">049</span><span id="line-49"> ByteBufferUtils.putInt(out, KeyValueUtil.keyLength(this));</span> |
| <span class="source-line-no">050</span><span id="line-50"> ByteBufferUtils.putInt(out, getValueLength());</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> // Key</span> |
| <span class="source-line-no">053</span><span id="line-53"> PrivateCellUtil.writeFlatKey(this, out);</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> if (getValueLength() > 0) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> // Value</span> |
| <span class="source-line-no">057</span><span id="line-57"> out.write(getValueArray(), getValueOffset(), getValueLength());</span> |
| <span class="source-line-no">058</span><span id="line-58"> }</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> // Tags length and tags byte array</span> |
| <span class="source-line-no">061</span><span id="line-61"> if (withTags && getTagsLength() > 0) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> // Tags length</span> |
| <span class="source-line-no">063</span><span id="line-63"> out.write((byte) (0xff & (getTagsLength() >> 8)));</span> |
| <span class="source-line-no">064</span><span id="line-64"> out.write((byte) (0xff & getTagsLength()));</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> // Tags byte array</span> |
| <span class="source-line-no">067</span><span id="line-67"> out.write(getTagsArray(), getTagsOffset(), getTagsLength());</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> return getSerializedSize(withTags);</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</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"> * KeyValue format</span> |
| <span class="source-line-no">075</span><span id="line-75"> * <p/></span> |
| <span class="source-line-no">076</span><span id="line-76"> * <code>&lt;4 bytes keylength&gt; &lt;4 bytes valuelength&gt; &lt;2 bytes rowlength&gt;</span> |
| <span class="source-line-no">077</span><span id="line-77"> * &lt;row&gt; &lt;1 byte columnfamilylength&gt; &lt;columnfamily&gt; &lt;columnqualifier&gt;</span> |
| <span class="source-line-no">078</span><span id="line-78"> * &lt;8 bytes timestamp&gt; &lt;1 byte keytype&gt; &lt;value&gt; &lt;2 bytes tagslength&gt;</span> |
| <span class="source-line-no">079</span><span id="line-79"> * &lt;tags&gt;</code></span> |
| <span class="source-line-no">080</span><span id="line-80"> * @param withTags Whether to write tags.</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @return Bytes count required to serialize this Cell in a {@link KeyValue} format.</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> // TODO remove the boolean param once HBASE-16706 is done.</span> |
| <span class="source-line-no">084</span><span id="line-84"> default int getSerializedSize(boolean withTags) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> return KeyValueUtil.length(getRowLength(), getFamilyLength(), getQualifierLength(),</span> |
| <span class="source-line-no">086</span><span id="line-86"> getValueLength(), getTagsLength(), withTags);</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> /** Returns Serialized size (defaults to include tag length). */</span> |
| <span class="source-line-no">090</span><span id="line-90"> @Override</span> |
| <span class="source-line-no">091</span><span id="line-91"> default int getSerializedSize() {</span> |
| <span class="source-line-no">092</span><span id="line-92"> return getSerializedSize(true);</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Write this Cell into the given buf's offset in a {@link KeyValue} format.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @param buf The buffer where to write the Cell.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @param offset The offset within buffer, to write the Cell.</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> default void write(ByteBuffer buf, int offset) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> KeyValueUtil.appendTo(this, buf, offset, true);</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /**</span> |
| <span class="source-line-no">105</span><span id="line-105"> * Does a deep copy of the contents to a new memory area and returns it as a new cell.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @return The deep cloned cell</span> |
| <span class="source-line-no">107</span><span id="line-107"> */</span> |
| <span class="source-line-no">108</span><span id="line-108"> default ExtendedCell deepClone() {</span> |
| <span class="source-line-no">109</span><span id="line-109"> // When being added to the memstore, deepClone() is called and KeyValue has less heap overhead.</span> |
| <span class="source-line-no">110</span><span id="line-110"> return new KeyValue(this);</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> /**</span> |
| <span class="source-line-no">114</span><span id="line-114"> * Extracts the id of the backing bytebuffer of this cell if it was obtained from fixed sized</span> |
| <span class="source-line-no">115</span><span id="line-115"> * chunks as in case of MemstoreLAB</span> |
| <span class="source-line-no">116</span><span id="line-116"> * @return the chunk id if the cell is backed by fixed sized Chunks, else return</span> |
| <span class="source-line-no">117</span><span id="line-117"> * {@link #CELL_NOT_BASED_ON_CHUNK}; i.e. -1.</span> |
| <span class="source-line-no">118</span><span id="line-118"> */</span> |
| <span class="source-line-no">119</span><span id="line-119"> default int getChunkId() {</span> |
| <span class="source-line-no">120</span><span id="line-120"> return CELL_NOT_BASED_ON_CHUNK;</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /**</span> |
| <span class="source-line-no">124</span><span id="line-124"> * Sets with the given seqId.</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @param seqId sequence ID</span> |
| <span class="source-line-no">126</span><span id="line-126"> */</span> |
| <span class="source-line-no">127</span><span id="line-127"> void setSequenceId(long seqId) throws IOException;</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Sets with the given timestamp.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * @param ts timestamp</span> |
| <span class="source-line-no">132</span><span id="line-132"> */</span> |
| <span class="source-line-no">133</span><span id="line-133"> void setTimestamp(long ts) throws IOException;</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Sets with the given timestamp.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @param ts buffer containing the timestamp value</span> |
| <span class="source-line-no">138</span><span id="line-138"> */</span> |
| <span class="source-line-no">139</span><span id="line-139"> void setTimestamp(byte[] ts) throws IOException;</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> /**</span> |
| <span class="source-line-no">142</span><span id="line-142"> * A region-specific unique monotonically increasing sequence ID given to each Cell. It always</span> |
| <span class="source-line-no">143</span><span id="line-143"> * exists for cells in the memstore but is not retained forever. It will be kept for</span> |
| <span class="source-line-no">144</span><span id="line-144"> * {@link HConstants#KEEP_SEQID_PERIOD} days, but generally becomes irrelevant after the cell's</span> |
| <span class="source-line-no">145</span><span id="line-145"> * row is no longer involved in any operations that require strict consistency.</span> |
| <span class="source-line-no">146</span><span id="line-146"> * @return seqId (always &gt; 0 if exists), or 0 if it no longer exists</span> |
| <span class="source-line-no">147</span><span id="line-147"> */</span> |
| <span class="source-line-no">148</span><span id="line-148"> long getSequenceId();</span> |
| <span class="source-line-no">149</span><span id="line-149"></span> |
| <span class="source-line-no">150</span><span id="line-150"> /** Returns The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc */</span> |
| <span class="source-line-no">151</span><span id="line-151"> byte getTypeByte();</span> |
| <span class="source-line-no">152</span><span id="line-152"></span> |
| <span class="source-line-no">153</span><span id="line-153"> /**</span> |
| <span class="source-line-no">154</span><span id="line-154"> * Typically, at server side, you'd better always use the {@link #getTypeByte()} as this method</span> |
| <span class="source-line-no">155</span><span id="line-155"> * does not expose the {@code Maximum} and {@code Minimum} because they will not be returned to</span> |
| <span class="source-line-no">156</span><span id="line-156"> * client, but at server side, we do have cells with these types so if you use this method it will</span> |
| <span class="source-line-no">157</span><span id="line-157"> * cause exceptions.</span> |
| <span class="source-line-no">158</span><span id="line-158"> */</span> |
| <span class="source-line-no">159</span><span id="line-159"> @Override</span> |
| <span class="source-line-no">160</span><span id="line-160"> default Type getType() {</span> |
| <span class="source-line-no">161</span><span id="line-161"> return PrivateCellUtil.code2Type(getTypeByte());</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
