| <!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.hfile, class: HFileContextBuilder"> |
| <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.hfile;</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 org.apache.hadoop.hbase.CellComparator;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.io.compress.Compression.Algorithm;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.io.crypto.Encryption;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.io.encoding.IndexBlockEncoding;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.ChecksumType;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">/**</span> |
| <span class="source-line-no">030</span><span id="line-30"> * A builder that helps in building up the HFileContext</span> |
| <span class="source-line-no">031</span><span id="line-31"> */</span> |
| <span class="source-line-no">032</span><span id="line-32">@InterfaceAudience.Private</span> |
| <span class="source-line-no">033</span><span id="line-33">public class HFileContextBuilder {</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35"> public static final int DEFAULT_BYTES_PER_CHECKSUM = 16 * 1024;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> /** Whether checksum is enabled or not **/</span> |
| <span class="source-line-no">038</span><span id="line-38"> private boolean usesHBaseChecksum = true;</span> |
| <span class="source-line-no">039</span><span id="line-39"> /** Whether mvcc is to be included in the Read/Write **/</span> |
| <span class="source-line-no">040</span><span id="line-40"> private boolean includesMvcc = true;</span> |
| <span class="source-line-no">041</span><span id="line-41"> /** Whether tags are to be included in the Read/Write **/</span> |
| <span class="source-line-no">042</span><span id="line-42"> private boolean includesTags = false;</span> |
| <span class="source-line-no">043</span><span id="line-43"> /** Compression algorithm used **/</span> |
| <span class="source-line-no">044</span><span id="line-44"> private Algorithm compression = Algorithm.NONE;</span> |
| <span class="source-line-no">045</span><span id="line-45"> /** Whether tags to be compressed or not **/</span> |
| <span class="source-line-no">046</span><span id="line-46"> private boolean compressTags = false;</span> |
| <span class="source-line-no">047</span><span id="line-47"> /** the checksum type **/</span> |
| <span class="source-line-no">048</span><span id="line-48"> private ChecksumType checkSumType = ChecksumType.getDefaultChecksumType();</span> |
| <span class="source-line-no">049</span><span id="line-49"> /** the number of bytes per checksum value **/</span> |
| <span class="source-line-no">050</span><span id="line-50"> private int bytesPerChecksum = DEFAULT_BYTES_PER_CHECKSUM;</span> |
| <span class="source-line-no">051</span><span id="line-51"> /** Number of uncompressed bytes we allow per block. */</span> |
| <span class="source-line-no">052</span><span id="line-52"> private int blockSize = HConstants.DEFAULT_BLOCKSIZE;</span> |
| <span class="source-line-no">053</span><span id="line-53"> private DataBlockEncoding encoding = DataBlockEncoding.NONE;</span> |
| <span class="source-line-no">054</span><span id="line-54"> /** the index block encoding type **/</span> |
| <span class="source-line-no">055</span><span id="line-55"> private IndexBlockEncoding indexBlockEncoding = IndexBlockEncoding.NONE;</span> |
| <span class="source-line-no">056</span><span id="line-56"> /** Crypto context */</span> |
| <span class="source-line-no">057</span><span id="line-57"> private Encryption.Context cryptoContext = Encryption.Context.NONE;</span> |
| <span class="source-line-no">058</span><span id="line-58"> private long fileCreateTime = 0;</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> private String hfileName = null;</span> |
| <span class="source-line-no">061</span><span id="line-61"> private byte[] columnFamily = null;</span> |
| <span class="source-line-no">062</span><span id="line-62"> private byte[] tableName = null;</span> |
| <span class="source-line-no">063</span><span id="line-63"> private CellComparator cellComparator;</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> public HFileContextBuilder() {</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</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"> * Use this constructor if you want to change a few settings only in another context.</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> public HFileContextBuilder(final HFileContext hfc) {</span> |
| <span class="source-line-no">072</span><span id="line-72"> this.usesHBaseChecksum = hfc.isUseHBaseChecksum();</span> |
| <span class="source-line-no">073</span><span id="line-73"> this.includesMvcc = hfc.isIncludesMvcc();</span> |
| <span class="source-line-no">074</span><span id="line-74"> this.includesTags = hfc.isIncludesTags();</span> |
| <span class="source-line-no">075</span><span id="line-75"> this.compression = hfc.getCompression();</span> |
| <span class="source-line-no">076</span><span id="line-76"> this.compressTags = hfc.isCompressTags();</span> |
| <span class="source-line-no">077</span><span id="line-77"> this.checkSumType = hfc.getChecksumType();</span> |
| <span class="source-line-no">078</span><span id="line-78"> this.bytesPerChecksum = hfc.getBytesPerChecksum();</span> |
| <span class="source-line-no">079</span><span id="line-79"> this.blockSize = hfc.getBlocksize();</span> |
| <span class="source-line-no">080</span><span id="line-80"> this.encoding = hfc.getDataBlockEncoding();</span> |
| <span class="source-line-no">081</span><span id="line-81"> this.cryptoContext = hfc.getEncryptionContext();</span> |
| <span class="source-line-no">082</span><span id="line-82"> this.fileCreateTime = hfc.getFileCreateTime();</span> |
| <span class="source-line-no">083</span><span id="line-83"> this.hfileName = hfc.getHFileName();</span> |
| <span class="source-line-no">084</span><span id="line-84"> this.columnFamily = hfc.getColumnFamily();</span> |
| <span class="source-line-no">085</span><span id="line-85"> this.tableName = hfc.getTableName();</span> |
| <span class="source-line-no">086</span><span id="line-86"> this.cellComparator = hfc.getCellComparator();</span> |
| <span class="source-line-no">087</span><span id="line-87"> this.indexBlockEncoding = hfc.getIndexBlockEncoding();</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> public HFileContextBuilder withHBaseCheckSum(boolean useHBaseCheckSum) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> this.usesHBaseChecksum = useHBaseCheckSum;</span> |
| <span class="source-line-no">092</span><span id="line-92"> return this;</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> public HFileContextBuilder withIncludesMvcc(boolean includesMvcc) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> this.includesMvcc = includesMvcc;</span> |
| <span class="source-line-no">097</span><span id="line-97"> return this;</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"> public HFileContextBuilder withIncludesTags(boolean includesTags) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> this.includesTags = includesTags;</span> |
| <span class="source-line-no">102</span><span id="line-102"> return this;</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</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 HFileContextBuilder withCompression(Algorithm compression) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> this.compression = compression;</span> |
| <span class="source-line-no">107</span><span id="line-107"> return this;</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> public HFileContextBuilder withCompressTags(boolean compressTags) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> this.compressTags = compressTags;</span> |
| <span class="source-line-no">112</span><span id="line-112"> return this;</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> public HFileContextBuilder withChecksumType(ChecksumType checkSumType) {</span> |
| <span class="source-line-no">116</span><span id="line-116"> this.checkSumType = checkSumType;</span> |
| <span class="source-line-no">117</span><span id="line-117"> return this;</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> public HFileContextBuilder withBytesPerCheckSum(int bytesPerChecksum) {</span> |
| <span class="source-line-no">121</span><span id="line-121"> this.bytesPerChecksum = bytesPerChecksum;</span> |
| <span class="source-line-no">122</span><span id="line-122"> return this;</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"> public HFileContextBuilder withBlockSize(int blockSize) {</span> |
| <span class="source-line-no">126</span><span id="line-126"> this.blockSize = blockSize;</span> |
| <span class="source-line-no">127</span><span id="line-127"> return this;</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> public HFileContextBuilder withDataBlockEncoding(DataBlockEncoding encoding) {</span> |
| <span class="source-line-no">131</span><span id="line-131"> this.encoding = encoding;</span> |
| <span class="source-line-no">132</span><span id="line-132"> return this;</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> public HFileContextBuilder withIndexBlockEncoding(IndexBlockEncoding indexBlockEncoding) {</span> |
| <span class="source-line-no">136</span><span id="line-136"> this.indexBlockEncoding = indexBlockEncoding;</span> |
| <span class="source-line-no">137</span><span id="line-137"> return this;</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> public HFileContextBuilder withEncryptionContext(Encryption.Context cryptoContext) {</span> |
| <span class="source-line-no">141</span><span id="line-141"> this.cryptoContext = cryptoContext;</span> |
| <span class="source-line-no">142</span><span id="line-142"> return this;</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> public HFileContextBuilder withCreateTime(long fileCreateTime) {</span> |
| <span class="source-line-no">146</span><span id="line-146"> this.fileCreateTime = fileCreateTime;</span> |
| <span class="source-line-no">147</span><span id="line-147"> return this;</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"></span> |
| <span class="source-line-no">150</span><span id="line-150"> public HFileContextBuilder withHFileName(String name) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> this.hfileName = name;</span> |
| <span class="source-line-no">152</span><span id="line-152"> return this;</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154"></span> |
| <span class="source-line-no">155</span><span id="line-155"> public HFileContextBuilder withColumnFamily(byte[] columnFamily) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> this.columnFamily = columnFamily;</span> |
| <span class="source-line-no">157</span><span id="line-157"> return this;</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"> public HFileContextBuilder withTableName(byte[] tableName) {</span> |
| <span class="source-line-no">161</span><span id="line-161"> this.tableName = tableName;</span> |
| <span class="source-line-no">162</span><span id="line-162"> return this;</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"></span> |
| <span class="source-line-no">165</span><span id="line-165"> public HFileContextBuilder withCellComparator(CellComparator cellComparator) {</span> |
| <span class="source-line-no">166</span><span id="line-166"> this.cellComparator = cellComparator;</span> |
| <span class="source-line-no">167</span><span id="line-167"> return this;</span> |
| <span class="source-line-no">168</span><span id="line-168"> }</span> |
| <span class="source-line-no">169</span><span id="line-169"></span> |
| <span class="source-line-no">170</span><span id="line-170"> public HFileContext build() {</span> |
| <span class="source-line-no">171</span><span id="line-171"> return new HFileContext(usesHBaseChecksum, includesMvcc, includesTags, compression,</span> |
| <span class="source-line-no">172</span><span id="line-172"> compressTags, checkSumType, bytesPerChecksum, blockSize, encoding, cryptoContext,</span> |
| <span class="source-line-no">173</span><span id="line-173"> fileCreateTime, hfileName, columnFamily, tableName, cellComparator, indexBlockEncoding);</span> |
| <span class="source-line-no">174</span><span id="line-174"> }</span> |
| <span class="source-line-no">175</span><span id="line-175">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
