blob: 11039148b32ee9b8aebb7ae34da5362c88dc3aea [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, class: KeyValueTestUtil">
<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;</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.nio.ByteBuffer;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Collection;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.commons.lang3.StringUtils;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.Strings;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">027</span><span id="line-27"></span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.com.google.common.collect.Lists;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.org.apache.commons.collections4.IterableUtils;</span>
<span class="source-line-no">030</span><span id="line-30"></span>
<span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.Private</span>
<span class="source-line-no">032</span><span id="line-32">public class KeyValueTestUtil {</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34"> public static KeyValue create(String row, String family, String qualifier, long timestamp,</span>
<span class="source-line-no">035</span><span id="line-35"> String value) {</span>
<span class="source-line-no">036</span><span id="line-36"> return create(row, family, qualifier, timestamp, KeyValue.Type.Put, value);</span>
<span class="source-line-no">037</span><span id="line-37"> }</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> public static KeyValue create(String row, String family, String qualifier, long timestamp,</span>
<span class="source-line-no">040</span><span id="line-40"> KeyValue.Type type, String value) {</span>
<span class="source-line-no">041</span><span id="line-41"> return new KeyValue(Bytes.toBytes(row), Bytes.toBytes(family), Bytes.toBytes(qualifier),</span>
<span class="source-line-no">042</span><span id="line-42"> timestamp, type, Bytes.toBytes(value));</span>
<span class="source-line-no">043</span><span id="line-43"> }</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> public static ByteBuffer toByteBufferAndRewind(final Iterable&lt;? extends KeyValue&gt; kvs,</span>
<span class="source-line-no">046</span><span id="line-46"> boolean includeMemstoreTS) {</span>
<span class="source-line-no">047</span><span id="line-47"> int totalBytes = KeyValueUtil.totalLengthWithMvccVersion(kvs, includeMemstoreTS);</span>
<span class="source-line-no">048</span><span id="line-48"> ByteBuffer bb = ByteBuffer.allocate(totalBytes);</span>
<span class="source-line-no">049</span><span id="line-49"> for (KeyValue kv : IterableUtils.emptyIfNull(kvs)) {</span>
<span class="source-line-no">050</span><span id="line-50"> KeyValueUtil.appendToByteBuffer(bb, kv, includeMemstoreTS);</span>
<span class="source-line-no">051</span><span id="line-51"> }</span>
<span class="source-line-no">052</span><span id="line-52"> bb.rewind();</span>
<span class="source-line-no">053</span><span id="line-53"> return bb;</span>
<span class="source-line-no">054</span><span id="line-54"> }</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"> * Checks whether KeyValues from kvCollection2 are contained in kvCollection1. The comparison is</span>
<span class="source-line-no">058</span><span id="line-58"> * made without distinguishing MVCC version of the KeyValues</span>
<span class="source-line-no">059</span><span id="line-59"> * @return true if KeyValues from kvCollection2 are contained in kvCollection1</span>
<span class="source-line-no">060</span><span id="line-60"> */</span>
<span class="source-line-no">061</span><span id="line-61"> public static boolean containsIgnoreMvccVersion(Collection&lt;? extends Cell&gt; kvCollection1,</span>
<span class="source-line-no">062</span><span id="line-62"> Collection&lt;? extends Cell&gt; kvCollection2) {</span>
<span class="source-line-no">063</span><span id="line-63"> for (Cell kv1 : kvCollection1) {</span>
<span class="source-line-no">064</span><span id="line-64"> boolean found = false;</span>
<span class="source-line-no">065</span><span id="line-65"> for (Cell kv2 : kvCollection2) {</span>
<span class="source-line-no">066</span><span id="line-66"> if (PrivateCellUtil.equalsIgnoreMvccVersion((ExtendedCell) kv1, (ExtendedCell) kv2)) {</span>
<span class="source-line-no">067</span><span id="line-67"> found = true;</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"> if (!found) {</span>
<span class="source-line-no">071</span><span id="line-71"> return false;</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"> return true;</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> public static List&lt;KeyValue&gt; rewindThenToList(final ByteBuffer bb,</span>
<span class="source-line-no">078</span><span id="line-78"> final boolean includesMemstoreTS, final boolean useTags) {</span>
<span class="source-line-no">079</span><span id="line-79"> bb.rewind();</span>
<span class="source-line-no">080</span><span id="line-80"> List&lt;KeyValue&gt; kvs = Lists.newArrayList();</span>
<span class="source-line-no">081</span><span id="line-81"> KeyValue kv = null;</span>
<span class="source-line-no">082</span><span id="line-82"> while (true) {</span>
<span class="source-line-no">083</span><span id="line-83"> kv = KeyValueUtil.nextShallowCopy(bb, includesMemstoreTS, useTags);</span>
<span class="source-line-no">084</span><span id="line-84"> if (kv == null) {</span>
<span class="source-line-no">085</span><span id="line-85"> break;</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"> kvs.add(kv);</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"> return kvs;</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"> /********************* toString ************************************/</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> public static String toStringWithPadding(final Collection&lt;? extends KeyValue&gt; kvs,</span>
<span class="source-line-no">095</span><span id="line-95"> final boolean includeMeta) {</span>
<span class="source-line-no">096</span><span id="line-96"> int maxRowStringLength = 0;</span>
<span class="source-line-no">097</span><span id="line-97"> int maxFamilyStringLength = 0;</span>
<span class="source-line-no">098</span><span id="line-98"> int maxQualifierStringLength = 0;</span>
<span class="source-line-no">099</span><span id="line-99"> int maxTimestampLength = 0;</span>
<span class="source-line-no">100</span><span id="line-100"> for (KeyValue kv : kvs) {</span>
<span class="source-line-no">101</span><span id="line-101"> maxRowStringLength = Math.max(maxRowStringLength, getRowString(kv).length());</span>
<span class="source-line-no">102</span><span id="line-102"> maxFamilyStringLength = Math.max(maxFamilyStringLength, getFamilyString(kv).length());</span>
<span class="source-line-no">103</span><span id="line-103"> maxQualifierStringLength =</span>
<span class="source-line-no">104</span><span id="line-104"> Math.max(maxQualifierStringLength, getQualifierString(kv).length());</span>
<span class="source-line-no">105</span><span id="line-105"> maxTimestampLength =</span>
<span class="source-line-no">106</span><span id="line-106"> Math.max(maxTimestampLength, Long.valueOf(kv.getTimestamp()).toString().length());</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"> StringBuilder sb = new StringBuilder();</span>
<span class="source-line-no">109</span><span id="line-109"> for (KeyValue kv : kvs) {</span>
<span class="source-line-no">110</span><span id="line-110"> if (sb.length() &gt; 0) {</span>
<span class="source-line-no">111</span><span id="line-111"> sb.append("\n");</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> String row = toStringWithPadding(kv, maxRowStringLength, maxFamilyStringLength,</span>
<span class="source-line-no">114</span><span id="line-114"> maxQualifierStringLength, maxTimestampLength, includeMeta);</span>
<span class="source-line-no">115</span><span id="line-115"> sb.append(row);</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"> return sb.toString();</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"> protected static String toStringWithPadding(final KeyValue kv, final int maxRowLength,</span>
<span class="source-line-no">121</span><span id="line-121"> int maxFamilyLength, int maxQualifierLength, int maxTimestampLength, boolean includeMeta) {</span>
<span class="source-line-no">122</span><span id="line-122"> String leadingLengths = "";</span>
<span class="source-line-no">123</span><span id="line-123"> String familyLength = kv.getFamilyLength() + " ";</span>
<span class="source-line-no">124</span><span id="line-124"> if (includeMeta) {</span>
<span class="source-line-no">125</span><span id="line-125"> leadingLengths += Strings.padFront(kv.getKeyLength() + "", '0', 4);</span>
<span class="source-line-no">126</span><span id="line-126"> leadingLengths += " ";</span>
<span class="source-line-no">127</span><span id="line-127"> leadingLengths += Strings.padFront(kv.getValueLength() + "", '0', 4);</span>
<span class="source-line-no">128</span><span id="line-128"> leadingLengths += " ";</span>
<span class="source-line-no">129</span><span id="line-129"> leadingLengths += Strings.padFront(kv.getRowLength() + "", '0', 2);</span>
<span class="source-line-no">130</span><span id="line-130"> leadingLengths += " ";</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"> int spacesAfterRow = maxRowLength - getRowString(kv).length() + 2;</span>
<span class="source-line-no">133</span><span id="line-133"> int spacesAfterFamily = maxFamilyLength - getFamilyString(kv).length() + 2;</span>
<span class="source-line-no">134</span><span id="line-134"> int spacesAfterQualifier = maxQualifierLength - getQualifierString(kv).length() + 1;</span>
<span class="source-line-no">135</span><span id="line-135"> int spacesAfterTimestamp =</span>
<span class="source-line-no">136</span><span id="line-136"> maxTimestampLength - Long.valueOf(kv.getTimestamp()).toString().length() + 1;</span>
<span class="source-line-no">137</span><span id="line-137"> return leadingLengths + getRowString(kv) + StringUtils.repeat(' ', spacesAfterRow)</span>
<span class="source-line-no">138</span><span id="line-138"> + familyLength + getFamilyString(kv) + StringUtils.repeat(' ', spacesAfterFamily)</span>
<span class="source-line-no">139</span><span id="line-139"> + getQualifierString(kv) + StringUtils.repeat(' ', spacesAfterQualifier)</span>
<span class="source-line-no">140</span><span id="line-140"> + getTimestampString(kv) + StringUtils.repeat(' ', spacesAfterTimestamp) + getTypeString(kv)</span>
<span class="source-line-no">141</span><span id="line-141"> + " " + getValueString(kv);</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> protected static String getRowString(final KeyValue kv) {</span>
<span class="source-line-no">145</span><span id="line-145"> return Bytes.toStringBinary(kv.getRowArray(), kv.getRowOffset(), kv.getRowLength());</span>
<span class="source-line-no">146</span><span id="line-146"> }</span>
<span class="source-line-no">147</span><span id="line-147"></span>
<span class="source-line-no">148</span><span id="line-148"> protected static String getFamilyString(final KeyValue kv) {</span>
<span class="source-line-no">149</span><span id="line-149"> return Bytes.toStringBinary(kv.getFamilyArray(), kv.getFamilyOffset(), kv.getFamilyLength());</span>
<span class="source-line-no">150</span><span id="line-150"> }</span>
<span class="source-line-no">151</span><span id="line-151"></span>
<span class="source-line-no">152</span><span id="line-152"> protected static String getQualifierString(final KeyValue kv) {</span>
<span class="source-line-no">153</span><span id="line-153"> return Bytes.toStringBinary(kv.getQualifierArray(), kv.getQualifierOffset(),</span>
<span class="source-line-no">154</span><span id="line-154"> kv.getQualifierLength());</span>
<span class="source-line-no">155</span><span id="line-155"> }</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> protected static String getTimestampString(final KeyValue kv) {</span>
<span class="source-line-no">158</span><span id="line-158"> return kv.getTimestamp() + "";</span>
<span class="source-line-no">159</span><span id="line-159"> }</span>
<span class="source-line-no">160</span><span id="line-160"></span>
<span class="source-line-no">161</span><span id="line-161"> protected static String getTypeString(final KeyValue kv) {</span>
<span class="source-line-no">162</span><span id="line-162"> return KeyValue.Type.codeToType(kv.getTypeByte()).toString();</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"> protected static String getValueString(final KeyValue kv) {</span>
<span class="source-line-no">166</span><span id="line-166"> return Bytes.toStringBinary(kv.getValueArray(), kv.getValueOffset(), kv.getValueLength());</span>
<span class="source-line-no">167</span><span id="line-167"> }</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>
</pre>
</div>
</main>
</body>
</html>