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