| <!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<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.io.hfile;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><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 org.apache.hadoop.conf.Configuration;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.Cell;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.io.encoding.HFileBlockDecodingContext;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.util.Bytes;<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> * Controls what kind of data block encoding is used. If data block encoding is not set or the given<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * block is not a data block (encoded or not), methods should just return the unmodified block.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>@InterfaceAudience.Private<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public interface HFileDataBlockEncoder {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /** Type of encoding used for data blocks in HFile. Stored in file info. */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> byte[] DATA_BLOCK_ENCODING = Bytes.toBytes("DATA_BLOCK_ENCODING");<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Starts encoding for a block of KeyValues. Call<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * {@link #endBlockEncoding(HFileBlockEncodingContext, DataOutputStream, byte[], BlockType)} to<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * finish encoding of a block. nnn<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> void startBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out)<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> throws IOException;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Encodes a KeyValue. nnnn<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> void encode(Cell cell, HFileBlockEncodingContext encodingCtx, DataOutputStream out)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> throws IOException;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Ends encoding for a block of KeyValues. Gives a chance for the encoder to do the finishing<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * stuff for the encoded block. It must be called at the end of block encoding. nnnnn<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> void endBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out,<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> byte[] uncompressedBytesWithHeader, BlockType blockType) throws IOException;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Decides whether we should use a scanner over encoded blocks.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @return Whether to use encoded scanner.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> boolean useEncodedScanner();<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> * Save metadata in HFile which will be written to disk<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param writer writer for a given HFile<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @exception IOException on disk problems<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> void saveMetadata(HFile.Writer writer) throws IOException;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /** Returns the data block encoding */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> DataBlockEncoding getDataBlockEncoding();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @return the effective in-cache data block encoding, taking into account whether we are doing a<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * compaction.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public DataBlockEncoding getEffectiveEncodingInCache(boolean isCompaction);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Create an encoder specific encoding context object for writing. And the encoding context should<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * also perform compression if compressionAlgorithm is valid.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @param conf store configuration<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @param headerBytes header bytes<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @param fileContext HFile meta data<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @return a new {@link HFileBlockEncodingContext} object<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> HFileBlockEncodingContext newDataBlockEncodingContext(Configuration conf, byte[] headerBytes,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> HFileContext fileContext);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * create a encoder specific decoding context for reading. And the decoding context should also do<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * decompression if compressionAlgorithm is valid.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param conf store configuration<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @param fileContext - HFile meta data<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @return a new {@link HFileBlockDecodingContext} object<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> HFileBlockDecodingContext newDataBlockDecodingContext(Configuration conf,<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> HFileContext fileContext);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span>}<a name="line.102"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
