| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with this<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * work for additional information regarding copyright ownership. The ASF<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * licenses this file to you under the Apache License, Version 2.0 (the<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * "License"); you may not use this file except in compliance with the License.<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * License for the specific language governing permissions and limitations<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * under the License.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.hadoop.hbase.io.encoding;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.DataInputStream;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.DataOutputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.ByteBuffer;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.Cell;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.io.hfile.HFileContext;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Encoding of KeyValue. It aims to be fast and efficient using assumptions:<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <ul><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <li>the KeyValues are stored sorted by key</li><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <li>we know the structure of KeyValue</li><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <li>the values are always iterated forward from beginning of block</li><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <li>knowledge of Key Value format</li><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * </ul><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * It is designed to work fast enough to be feasible as in memory compression.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@InterfaceAudience.Private<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public interface DataBlockEncoder {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>// TODO: This Interface should be deprecated and replaced. It presumes hfile and carnal knowledge of<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>// Cell internals. It was done for a different time. Remove. Purge.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Starts encoding for a block of KeyValues. Call<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * {@link #endBlockEncoding(HFileBlockEncodingContext, DataOutputStream, byte[])} to finish<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * encoding of a block.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param encodingCtx<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param out<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @throws IOException<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> void startBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out)<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> throws IOException;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Encodes a KeyValue.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param cell<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param encodingCtx<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param out<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return unencoded kv size written<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @throws IOException<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> int encode(Cell cell, HFileBlockEncodingContext encodingCtx, DataOutputStream out)<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> throws IOException;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Ends encoding for a block of KeyValues. Gives a chance for the encoder to do the finishing<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * stuff for the encoded block. It must be called at the end of block encoding.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param encodingCtx<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param out<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param uncompressedBytesWithHeader<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @throws IOException<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> void endBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out,<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> byte[] uncompressedBytesWithHeader) throws IOException;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Decode.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param source Compressed stream of KeyValues.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param decodingCtx<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @return Uncompressed block of KeyValues.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @throws IOException If there is an error in source.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> ByteBuffer decodeKeyValues(DataInputStream source, HFileBlockDecodingContext decodingCtx)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> throws IOException;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Return first key in block as a cell. Useful for indexing. Typically does not make<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * a deep copy but returns a buffer wrapping a segment of the actual block's<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * byte array. This is because the first key in block is usually stored<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * unencoded.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param block encoded block we want index, the position will not change<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @return First key in block as a cell.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> Cell getFirstKeyCellInBlock(ByteBuff block);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Create a HFileBlock seeker which find KeyValues within a block.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param comparator what kind of comparison should be used<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param decodingCtx<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @return A newly created seeker.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> EncodedSeeker createSeeker(CellComparator comparator, HFileBlockDecodingContext decodingCtx);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Creates a encoder specific encoding context<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param encoding<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * encoding strategy used<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param headerBytes<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * header bytes to be written, put a dummy header here if the header<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * is unknown<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param meta<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * HFile meta data<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @return a newly created encoding context<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> HFileBlockEncodingContext newDataBlockEncodingContext(<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> DataBlockEncoding encoding, byte[] headerBytes, HFileContext meta);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * Creates an encoder specific decoding context, which will prepare the data<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * before actual decoding<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> *<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param meta<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * HFile meta data <a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @return a newly created decoding context<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> HFileBlockDecodingContext newDataBlockDecodingContext(HFileContext meta);<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * An interface which enable to seek while underlying data is encoded.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> *<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * It works on one HFileBlock, but it is reusable. See<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * {@link #setCurrentBuffer(ByteBuff)}.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> interface EncodedSeeker {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * Set on which buffer there will be done seeking.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param buffer Used for seeking.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> void setCurrentBuffer(ByteBuff buffer);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * From the current position creates a cell using the key part<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * of the current buffer<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @return key at current position<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> Cell getKey();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> /**<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Does a shallow copy of the value at the current position. A shallow<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * copy is possible because the returned buffer refers to the backing array<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * of the original encoded buffer.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @return value at current position<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> */<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> ByteBuffer getValueShallowCopy();<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> /**<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @return the Cell at the current position. Includes memstore timestamp.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> */<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> Cell getCell();<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> /** Set position to beginning of given block */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> void rewind();<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Move to next position<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @return true on success, false if there is no more positions.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> boolean next();<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> /**<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * Moves the seeker position within the current block to:<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * <ul><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * <li>the last key that that is less than or equal to the given key if<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * <code>seekBefore</code> is false</li><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * <li>the last key that is strictly less than the given key if <code><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * seekBefore</code> is true. The caller is responsible for loading the<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * previous block if the requested key turns out to be the first key of the<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * current block.</li><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * </ul><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param key - Cell to which the seek should happen<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @param seekBefore find the key strictly less than the given key in case<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * of an exact match. Does not matter in case of an inexact match.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @return 0 on exact match, 1 on inexact match.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> int seekToKeyInBlock(Cell key, boolean seekBefore);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> /**<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * Compare the given key against the current key<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param comparator<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @param key<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @return -1 is the passed key is smaller than the current key, 0 if equal and 1 if greater<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> public int compareKey(CellComparator comparator, Cell key);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span>}<a name="line.197"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
