blob: 9a198a707ffa7f88a29d84dda6aa01433fab1d1c [file] [log] [blame]
<!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.mapreduce, class: CellCreator">
<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.mapreduce;</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.util.List;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.KeyValue;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.Tag;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.util.ReflectionUtils;</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"> * Facade to create Cells for HFileOutputFormat. The created Cells are of &lt;code&gt;Put&lt;/code&gt; type.</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.Public</span>
<span class="source-line-no">033</span><span id="line-33">public class CellCreator {</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 String VISIBILITY_EXP_RESOLVER_CLASS =</span>
<span class="source-line-no">036</span><span id="line-36"> "hbase.mapreduce.visibility.expression.resolver.class";</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 VisibilityExpressionResolver visExpResolver;</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> public CellCreator(Configuration conf) {</span>
<span class="source-line-no">041</span><span id="line-41"> Class&lt;? extends VisibilityExpressionResolver&gt; clazz =</span>
<span class="source-line-no">042</span><span id="line-42"> conf.getClass(VISIBILITY_EXP_RESOLVER_CLASS, DefaultVisibilityExpressionResolver.class,</span>
<span class="source-line-no">043</span><span id="line-43"> VisibilityExpressionResolver.class);</span>
<span class="source-line-no">044</span><span id="line-44"> this.visExpResolver = ReflectionUtils.newInstance(clazz, conf);</span>
<span class="source-line-no">045</span><span id="line-45"> this.visExpResolver.init();</span>
<span class="source-line-no">046</span><span id="line-46"> }</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> /**</span>
<span class="source-line-no">049</span><span id="line-49"> * @param row row key</span>
<span class="source-line-no">050</span><span id="line-50"> * @param roffset row offset</span>
<span class="source-line-no">051</span><span id="line-51"> * @param rlength row length</span>
<span class="source-line-no">052</span><span id="line-52"> * @param family family name</span>
<span class="source-line-no">053</span><span id="line-53"> * @param foffset family offset</span>
<span class="source-line-no">054</span><span id="line-54"> * @param flength family length</span>
<span class="source-line-no">055</span><span id="line-55"> * @param qualifier column qualifier</span>
<span class="source-line-no">056</span><span id="line-56"> * @param qoffset qualifier offset</span>
<span class="source-line-no">057</span><span id="line-57"> * @param qlength qualifier length</span>
<span class="source-line-no">058</span><span id="line-58"> * @param timestamp version timestamp</span>
<span class="source-line-no">059</span><span id="line-59"> * @param value column value</span>
<span class="source-line-no">060</span><span id="line-60"> * @param voffset value offset</span>
<span class="source-line-no">061</span><span id="line-61"> * @param vlength value length</span>
<span class="source-line-no">062</span><span id="line-62"> * @return created Cell</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> public Cell create(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength,</span>
<span class="source-line-no">065</span><span id="line-65"> byte[] qualifier, int qoffset, int qlength, long timestamp, byte[] value, int voffset,</span>
<span class="source-line-no">066</span><span id="line-66"> int vlength) throws IOException {</span>
<span class="source-line-no">067</span><span id="line-67"> return create(row, roffset, rlength, family, foffset, flength, qualifier, qoffset, qlength,</span>
<span class="source-line-no">068</span><span id="line-68"> timestamp, value, voffset, vlength, (List&lt;Tag&gt;) null);</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> /**</span>
<span class="source-line-no">072</span><span id="line-72"> * @param row row key</span>
<span class="source-line-no">073</span><span id="line-73"> * @param roffset row offset</span>
<span class="source-line-no">074</span><span id="line-74"> * @param rlength row length</span>
<span class="source-line-no">075</span><span id="line-75"> * @param family family name</span>
<span class="source-line-no">076</span><span id="line-76"> * @param foffset family offset</span>
<span class="source-line-no">077</span><span id="line-77"> * @param flength family length</span>
<span class="source-line-no">078</span><span id="line-78"> * @param qualifier column qualifier</span>
<span class="source-line-no">079</span><span id="line-79"> * @param qoffset qualifier offset</span>
<span class="source-line-no">080</span><span id="line-80"> * @param qlength qualifier length</span>
<span class="source-line-no">081</span><span id="line-81"> * @param timestamp version timestamp</span>
<span class="source-line-no">082</span><span id="line-82"> * @param value column value</span>
<span class="source-line-no">083</span><span id="line-83"> * @param voffset value offset</span>
<span class="source-line-no">084</span><span id="line-84"> * @param vlength value length</span>
<span class="source-line-no">085</span><span id="line-85"> * @param visExpression visibility expression to be associated with cell</span>
<span class="source-line-no">086</span><span id="line-86"> * @return created Cell</span>
<span class="source-line-no">087</span><span id="line-87"> * @deprecated since 0.98.9</span>
<span class="source-line-no">088</span><span id="line-88"> * @see &lt;a href="https://issues.apache.org/jira/browse/HBASE-10560"&gt;HBASE-10560&lt;/a&gt;</span>
<span class="source-line-no">089</span><span id="line-89"> */</span>
<span class="source-line-no">090</span><span id="line-90"> @Deprecated</span>
<span class="source-line-no">091</span><span id="line-91"> public Cell create(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength,</span>
<span class="source-line-no">092</span><span id="line-92"> byte[] qualifier, int qoffset, int qlength, long timestamp, byte[] value, int voffset,</span>
<span class="source-line-no">093</span><span id="line-93"> int vlength, String visExpression) throws IOException {</span>
<span class="source-line-no">094</span><span id="line-94"> List&lt;Tag&gt; visTags = null;</span>
<span class="source-line-no">095</span><span id="line-95"> if (visExpression != null) {</span>
<span class="source-line-no">096</span><span id="line-96"> visTags = this.visExpResolver.createVisibilityExpTags(visExpression);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> return new KeyValue(row, roffset, rlength, family, foffset, flength, qualifier, qoffset,</span>
<span class="source-line-no">099</span><span id="line-99"> qlength, timestamp, KeyValue.Type.Put, value, voffset, vlength, visTags);</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> /**</span>
<span class="source-line-no">103</span><span id="line-103"> * @param row row key</span>
<span class="source-line-no">104</span><span id="line-104"> * @param roffset row offset</span>
<span class="source-line-no">105</span><span id="line-105"> * @param rlength row length</span>
<span class="source-line-no">106</span><span id="line-106"> * @param family family name</span>
<span class="source-line-no">107</span><span id="line-107"> * @param foffset family offset</span>
<span class="source-line-no">108</span><span id="line-108"> * @param flength family length</span>
<span class="source-line-no">109</span><span id="line-109"> * @param qualifier column qualifier</span>
<span class="source-line-no">110</span><span id="line-110"> * @param qoffset qualifier offset</span>
<span class="source-line-no">111</span><span id="line-111"> * @param qlength qualifier length</span>
<span class="source-line-no">112</span><span id="line-112"> * @param timestamp version timestamp</span>
<span class="source-line-no">113</span><span id="line-113"> * @param value column value</span>
<span class="source-line-no">114</span><span id="line-114"> * @param voffset value offset</span>
<span class="source-line-no">115</span><span id="line-115"> * @param vlength value length</span>
<span class="source-line-no">116</span><span id="line-116"> * @return created Cell</span>
<span class="source-line-no">117</span><span id="line-117"> */</span>
<span class="source-line-no">118</span><span id="line-118"> public Cell create(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength,</span>
<span class="source-line-no">119</span><span id="line-119"> byte[] qualifier, int qoffset, int qlength, long timestamp, byte[] value, int voffset,</span>
<span class="source-line-no">120</span><span id="line-120"> int vlength, List&lt;Tag&gt; tags) throws IOException {</span>
<span class="source-line-no">121</span><span id="line-121"> return new KeyValue(row, roffset, rlength, family, foffset, flength, qualifier, qoffset,</span>
<span class="source-line-no">122</span><span id="line-122"> qlength, timestamp, KeyValue.Type.Put, value, voffset, vlength, tags);</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"> /** Returns Visibility expression resolver */</span>
<span class="source-line-no">126</span><span id="line-126"> public VisibilityExpressionResolver getVisibilityExpressionResolver() {</span>
<span class="source-line-no">127</span><span id="line-127"> return this.visExpResolver;</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>
</pre>
</div>
</main>
</body>
</html>