| <!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.io.encoding, interface: DataBlockEncoder"> |
| <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.io.encoding;</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.DataInputStream;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.DataOutputStream;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.nio.ByteBuffer;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.CellComparator;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ExtendedCell;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.io.hfile.HFileContext;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.nio.ByteBuff;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">/**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * Encoding of KeyValue. It aims to be fast and efficient using assumptions:</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <ul></span> |
| <span class="source-line-no">034</span><span id="line-34"> * <li>the KeyValues are stored sorted by key</li></span> |
| <span class="source-line-no">035</span><span id="line-35"> * <li>we know the structure of KeyValue</li></span> |
| <span class="source-line-no">036</span><span id="line-36"> * <li>the values are always iterated forward from beginning of block</li></span> |
| <span class="source-line-no">037</span><span id="line-37"> * <li>knowledge of Key Value format</li></span> |
| <span class="source-line-no">038</span><span id="line-38"> * </ul></span> |
| <span class="source-line-no">039</span><span id="line-39"> * It is designed to work fast enough to be feasible as in memory compression.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42">public interface DataBlockEncoder {</span> |
| <span class="source-line-no">043</span><span id="line-43"> // TODO: This Interface should be deprecated and replaced. It presumes hfile and carnal knowledge</span> |
| <span class="source-line-no">044</span><span id="line-44"> // of</span> |
| <span class="source-line-no">045</span><span id="line-45"> // Cell internals. It was done for a different time. Remove. Purge.</span> |
| <span class="source-line-no">046</span><span id="line-46"> /**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * Starts encoding for a block of KeyValues. Call</span> |
| <span class="source-line-no">048</span><span id="line-48"> * {@link #endBlockEncoding(HFileBlockEncodingContext, DataOutputStream, byte[])} to finish</span> |
| <span class="source-line-no">049</span><span id="line-49"> * encoding of a block.</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> void startBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out)</span> |
| <span class="source-line-no">052</span><span id="line-52"> throws IOException;</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"> * Encodes a KeyValue. After the encode, {@link EncodingState#postCellEncode(int, int)} needs to</span> |
| <span class="source-line-no">056</span><span id="line-56"> * be called to keep track of the encoded and unencoded data size</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> void encode(ExtendedCell cell, HFileBlockEncodingContext encodingCtx, DataOutputStream out)</span> |
| <span class="source-line-no">059</span><span id="line-59"> throws IOException;</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Ends encoding for a block of KeyValues. Gives a chance for the encoder to do the finishing</span> |
| <span class="source-line-no">063</span><span id="line-63"> * stuff for the encoded block. It must be called at the end of block encoding.</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> void endBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out,</span> |
| <span class="source-line-no">066</span><span id="line-66"> byte[] uncompressedBytesWithHeader) throws IOException;</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"> * Decode.</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @param source Compressed stream of KeyValues.</span> |
| <span class="source-line-no">071</span><span id="line-71"> * @return Uncompressed block of KeyValues.</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @throws IOException If there is an error in source.</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> ByteBuffer decodeKeyValues(DataInputStream source, HFileBlockDecodingContext decodingCtx)</span> |
| <span class="source-line-no">075</span><span id="line-75"> throws IOException;</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * Return first key in block as a cell. Useful for indexing. Typically does not make a deep copy</span> |
| <span class="source-line-no">079</span><span id="line-79"> * but returns a buffer wrapping a segment of the actual block's byte array. This is because the</span> |
| <span class="source-line-no">080</span><span id="line-80"> * first key in block is usually stored unencoded.</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @param block encoded block we want index, the position will not change</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @return First key in block as a cell.</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"> ExtendedCell getFirstKeyCellInBlock(ByteBuff block);</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Create a HFileBlock seeker which find KeyValues within a block.</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @return A newly created seeker.</span> |
| <span class="source-line-no">089</span><span id="line-89"> */</span> |
| <span class="source-line-no">090</span><span id="line-90"> EncodedSeeker createSeeker(HFileBlockDecodingContext decodingCtx);</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> /**</span> |
| <span class="source-line-no">093</span><span id="line-93"> * Creates a encoder specific encoding context store configuration encoding strategy used header</span> |
| <span class="source-line-no">094</span><span id="line-94"> * bytes to be written, put a dummy header here if the header is unknown HFile meta data</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @return a newly created encoding context</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> HFileBlockEncodingContext newDataBlockEncodingContext(Configuration conf,</span> |
| <span class="source-line-no">098</span><span id="line-98"> DataBlockEncoding encoding, byte[] headerBytes, HFileContext meta);</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> /**</span> |
| <span class="source-line-no">101</span><span id="line-101"> * Creates an encoder specific decoding context, which will prepare the data before actual</span> |
| <span class="source-line-no">102</span><span id="line-102"> * decoding store configuration HFile meta data</span> |
| <span class="source-line-no">103</span><span id="line-103"> * @return a newly created decoding context</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> HFileBlockDecodingContext newDataBlockDecodingContext(Configuration conf, HFileContext meta);</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * An interface which enable to seek while underlying data is encoded. It works on one HFileBlock,</span> |
| <span class="source-line-no">109</span><span id="line-109"> * but it is reusable. See {@link #setCurrentBuffer(ByteBuff)}.</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111"> interface EncodedSeeker {</span> |
| <span class="source-line-no">112</span><span id="line-112"> /**</span> |
| <span class="source-line-no">113</span><span id="line-113"> * Set on which buffer there will be done seeking.</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @param buffer Used for seeking.</span> |
| <span class="source-line-no">115</span><span id="line-115"> */</span> |
| <span class="source-line-no">116</span><span id="line-116"> void setCurrentBuffer(ByteBuff buffer);</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> /**</span> |
| <span class="source-line-no">119</span><span id="line-119"> * From the current position creates a cell using the key part of the current buffer</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @return key at current position</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> ExtendedCell getKey();</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> /**</span> |
| <span class="source-line-no">125</span><span id="line-125"> * Does a shallow copy of the value at the current position. A shallow copy is possible because</span> |
| <span class="source-line-no">126</span><span id="line-126"> * the returned buffer refers to the backing array of the original encoded buffer.</span> |
| <span class="source-line-no">127</span><span id="line-127"> * @return value at current position</span> |
| <span class="source-line-no">128</span><span id="line-128"> */</span> |
| <span class="source-line-no">129</span><span id="line-129"> ByteBuffer getValueShallowCopy();</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> /** Returns the Cell at the current position. Includes memstore timestamp. */</span> |
| <span class="source-line-no">132</span><span id="line-132"> ExtendedCell getCell();</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /** Set position to beginning of given block */</span> |
| <span class="source-line-no">135</span><span id="line-135"> void rewind();</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> /**</span> |
| <span class="source-line-no">138</span><span id="line-138"> * Move to next position</span> |
| <span class="source-line-no">139</span><span id="line-139"> * @return true on success, false if there is no more positions.</span> |
| <span class="source-line-no">140</span><span id="line-140"> */</span> |
| <span class="source-line-no">141</span><span id="line-141"> boolean next();</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> /**</span> |
| <span class="source-line-no">144</span><span id="line-144"> * Moves the seeker position within the current block to:</span> |
| <span class="source-line-no">145</span><span id="line-145"> * <ul></span> |
| <span class="source-line-no">146</span><span id="line-146"> * <li>the last key that that is less than or equal to the given key if <code>seekBefore</code></span> |
| <span class="source-line-no">147</span><span id="line-147"> * is false</li></span> |
| <span class="source-line-no">148</span><span id="line-148"> * <li>the last key that is strictly less than the given key if <code></span> |
| <span class="source-line-no">149</span><span id="line-149"> * seekBefore</code> is true. The caller is responsible for loading the previous block if the</span> |
| <span class="source-line-no">150</span><span id="line-150"> * requested key turns out to be the first key of the current block.</li></span> |
| <span class="source-line-no">151</span><span id="line-151"> * </ul></span> |
| <span class="source-line-no">152</span><span id="line-152"> * @param key - Cell to which the seek should happen</span> |
| <span class="source-line-no">153</span><span id="line-153"> * @param seekBefore find the key strictly less than the given key in case of an exact match.</span> |
| <span class="source-line-no">154</span><span id="line-154"> * Does not matter in case of an inexact match.</span> |
| <span class="source-line-no">155</span><span id="line-155"> * @return 0 on exact match, 1 on inexact match.</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> int seekToKeyInBlock(ExtendedCell key, boolean seekBefore);</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> /**</span> |
| <span class="source-line-no">160</span><span id="line-160"> * Compare the given key against the current key</span> |
| <span class="source-line-no">161</span><span id="line-161"> * @return -1 is the passed key is smaller than the current key, 0 if equal and 1 if greater</span> |
| <span class="source-line-no">162</span><span id="line-162"> */</span> |
| <span class="source-line-no">163</span><span id="line-163"> public int compareKey(CellComparator comparator, ExtendedCell key);</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
