| <!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.encoding;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.OutputStream;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * Provide access to all index block encoding algorithms. All of the algorithms are required to have<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * unique id which should <b>NEVER</b> be changed. If you want to add a new algorithm/version,<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * assign it a new id. Announce the new id in the HBase mailing list to prevent collisions.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>@InterfaceAudience.Public<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public enum IndexBlockEncoding {<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /** Disable index block encoding. */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> NONE(0, null),<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> // id 1 is reserved for the PREFIX_TREE algorithm to be added later<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> PREFIX_TREE(1, null);<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> private final short id;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private final byte[] idInBytes;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private final String encoderCls;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> public static final int ID_SIZE = Bytes.SIZEOF_SHORT;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /** Maps data block encoding ids to enum instances. */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private static IndexBlockEncoding[] idArray = new IndexBlockEncoding[Byte.MAX_VALUE + 1];<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> static {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> for (IndexBlockEncoding algo : values()) {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> if (idArray[algo.id] != null) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> throw new RuntimeException(<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> String.format("Two data block encoder algorithms '%s' and '%s' have " + "the same id %d",<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> idArray[algo.id].toString(), algo.toString(), (int) algo.id));<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> }<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> idArray[algo.id] = algo;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> }<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private IndexBlockEncoding(int id, String encoderClsName) {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> if (id < 0 || id > Byte.MAX_VALUE) {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> throw new AssertionError("Data block encoding algorithm id is out of range: " + id);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> this.id = (short) id;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> this.idInBytes = Bytes.toBytes(this.id);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> if (idInBytes.length != ID_SIZE) {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> // White this may seem redundant, if we accidentally serialize<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> // the id as e.g. an int instead of a short, all encoders will break.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> throw new RuntimeException("Unexpected length of encoder ID byte " + "representation: "<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> + Bytes.toStringBinary(idInBytes));<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> }<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> this.encoderCls = encoderClsName;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /** Returns name converted to bytes. */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public byte[] getNameInBytes() {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return Bytes.toBytes(toString());<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> /** Returns The id of a data block encoder. */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public short getId() {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> return id;<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> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Writes id in bytes.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @param stream where the id should be written.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> public void writeIdInBytes(OutputStream stream) throws IOException {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> stream.write(idInBytes);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Writes id bytes to the given array starting from offset.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param dest output array<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param offset starting offset of the output array<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public void writeIdInBytes(byte[] dest, int offset) throws IOException {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> System.arraycopy(idInBytes, 0, dest, offset, ID_SIZE);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Find and return the name of data block encoder for the given id.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param encoderId id of data block encoder<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return name, same as used in options in column family<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public static String getNameFromId(short encoderId) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return getEncodingById(encoderId).toString();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static IndexBlockEncoding getEncodingById(short indexBlockEncodingId) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> IndexBlockEncoding algorithm = null;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> if (indexBlockEncodingId >= 0 && indexBlockEncodingId <= Byte.MAX_VALUE) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> algorithm = idArray[indexBlockEncodingId];<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (algorithm == null) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> throw new IllegalArgumentException(String<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> .format("There is no index block encoder for given id '%d'", (int) indexBlockEncodingId));<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> return algorithm;<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>}<a name="line.121"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
