blob: f7bdd543d1a4151003989d17e8c8d9423fb3048b [file] [log] [blame]
<!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> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.client;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.BufferOverflowException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.nio.ByteBuffer;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Arrays;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Collections;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Comparator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Iterator;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.List;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.Map;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.NavigableMap;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.NoSuchElementException;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.TreeMap;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.Cell;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.CellScannable;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.CellScanner;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.HConstants;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.KeyValueUtil;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>/**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Single row result of a {@link Get} or {@link Scan} query.&lt;p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * This class is &lt;b&gt;NOT THREAD SAFE&lt;/b&gt;.&lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> *<a name="line.52"></a>
<span class="sourceLineNo">053</span> * Convenience methods are available that return various {@link Map}<a name="line.53"></a>
<span class="sourceLineNo">054</span> * structures and values directly.&lt;p&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> *<a name="line.55"></a>
<span class="sourceLineNo">056</span> * To get a complete mapping of all cells in the Result, which can include<a name="line.56"></a>
<span class="sourceLineNo">057</span> * multiple families and multiple versions, use {@link #getMap()}.&lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * To get a mapping of each family to its columns (qualifiers and values),<a name="line.59"></a>
<span class="sourceLineNo">060</span> * including only the latest version of each, use {@link #getNoVersionMap()}.<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * To get a mapping of qualifiers to latest values for an individual family use<a name="line.62"></a>
<span class="sourceLineNo">063</span> * {@link #getFamilyMap(byte[])}.&lt;p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> * To get the latest value for a specific family and qualifier use<a name="line.65"></a>
<span class="sourceLineNo">066</span> * {@link #getValue(byte[], byte[])}.<a name="line.66"></a>
<span class="sourceLineNo">067</span> *<a name="line.67"></a>
<span class="sourceLineNo">068</span> * A Result is backed by an array of {@link Cell} objects, each representing<a name="line.68"></a>
<span class="sourceLineNo">069</span> * an HBase cell defined by the row, family, qualifier, timestamp, and value.&lt;p&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * The underlying {@link Cell} objects can be accessed through the method {@link #listCells()}.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * This will create a List from the internal Cell []. Better is to exploit the fact that<a name="line.72"></a>
<span class="sourceLineNo">073</span> * a new Result instance is a primed {@link CellScanner}; just call {@link #advance()} and<a name="line.73"></a>
<span class="sourceLineNo">074</span> * {@link #current()} to iterate over Cells as you would any {@link CellScanner}.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Call {@link #cellScanner()} to reset should you need to iterate the same Result over again<a name="line.75"></a>
<span class="sourceLineNo">076</span> * ({@link CellScanner}s are one-shot).<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * If you need to overwrite a Result with another Result instance -- as in the old 'mapred'<a name="line.78"></a>
<span class="sourceLineNo">079</span> * RecordReader next invocations -- then create an empty Result with the null constructor and<a name="line.79"></a>
<span class="sourceLineNo">080</span> * in then use {@link #copyFrom(Result)}<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span>@InterfaceAudience.Public<a name="line.82"></a>
<span class="sourceLineNo">083</span>public class Result implements CellScannable, CellScanner {<a name="line.83"></a>
<span class="sourceLineNo">084</span> private Cell[] cells;<a name="line.84"></a>
<span class="sourceLineNo">085</span> private Boolean exists; // if the query was just to check existence.<a name="line.85"></a>
<span class="sourceLineNo">086</span> private boolean stale = false;<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * See {@link #mayHaveMoreCellsInRow()}.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> private boolean mayHaveMoreCellsInRow = false;<a name="line.91"></a>
<span class="sourceLineNo">092</span> // We're not using java serialization. Transient here is just a marker to say<a name="line.92"></a>
<span class="sourceLineNo">093</span> // that this is where we cache row if we're ever asked for it.<a name="line.93"></a>
<span class="sourceLineNo">094</span> private transient byte [] row = null;<a name="line.94"></a>
<span class="sourceLineNo">095</span> // Ditto for familyMap. It can be composed on fly from passed in kvs.<a name="line.95"></a>
<span class="sourceLineNo">096</span> private transient NavigableMap&lt;byte[], NavigableMap&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt;&gt;<a name="line.96"></a>
<span class="sourceLineNo">097</span> familyMap = null;<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> private static ThreadLocal&lt;byte[]&gt; localBuffer = new ThreadLocal&lt;&gt;();<a name="line.99"></a>
<span class="sourceLineNo">100</span> private static final int PAD_WIDTH = 128;<a name="line.100"></a>
<span class="sourceLineNo">101</span> public static final Result EMPTY_RESULT = new Result(true);<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> private final static int INITIAL_CELLSCANNER_INDEX = -1;<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Index for where we are when Result is acting as a {@link CellScanner}.<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span> private int cellScannerIndex = INITIAL_CELLSCANNER_INDEX;<a name="line.108"></a>
<span class="sourceLineNo">109</span> private RegionLoadStats stats;<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> private final boolean readonly;<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> private Cursor cursor = null;<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * Creates an empty Result w/ no KeyValue payload; returns null if you call {@link #rawCells()}.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Use this to represent no results if {@code null} won't do or in old 'mapred' as opposed<a name="line.117"></a>
<span class="sourceLineNo">118</span> * to 'mapreduce' package MapReduce where you need to overwrite a Result instance with a<a name="line.118"></a>
<span class="sourceLineNo">119</span> * {@link #copyFrom(Result)} call.<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> public Result() {<a name="line.121"></a>
<span class="sourceLineNo">122</span> this(false);<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Allows to construct special purpose immutable Result objects,<a name="line.126"></a>
<span class="sourceLineNo">127</span> * such as EMPTY_RESULT.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @param readonly whether this Result instance is readonly<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> private Result(boolean readonly) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> this.readonly = readonly;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
<span class="sourceLineNo">135</span> * Instantiate a Result with the specified List of KeyValues.<a name="line.135"></a>
<span class="sourceLineNo">136</span> * &lt;br&gt;&lt;strong&gt;Note:&lt;/strong&gt; You must ensure that the keyvalues are already sorted.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @param cells List of cells<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public static Result create(List&lt;Cell&gt; cells) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return create(cells, null);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> public static Result create(List&lt;Cell&gt; cells, Boolean exists) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> return create(cells, exists, false);<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> public static Result create(List&lt;Cell&gt; cells, Boolean exists, boolean stale) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> return create(cells, exists, stale, false);<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> public static Result create(List&lt;Cell&gt; cells, Boolean exists, boolean stale,<a name="line.151"></a>
<span class="sourceLineNo">152</span> boolean mayHaveMoreCellsInRow) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> if (exists != null){<a name="line.153"></a>
<span class="sourceLineNo">154</span> return new Result(null, exists, stale, mayHaveMoreCellsInRow);<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span> return new Result(cells.toArray(new Cell[cells.size()]), null, stale, mayHaveMoreCellsInRow);<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> /**<a name="line.159"></a>
<span class="sourceLineNo">160</span> * Instantiate a Result with the specified array of KeyValues.<a name="line.160"></a>
<span class="sourceLineNo">161</span> * &lt;br&gt;&lt;strong&gt;Note:&lt;/strong&gt; You must ensure that the keyvalues are already sorted.<a name="line.161"></a>
<span class="sourceLineNo">162</span> * @param cells array of cells<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> public static Result create(Cell[] cells) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return create(cells, null, false);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> public static Result create(Cell[] cells, Boolean exists, boolean stale) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> return create(cells, exists, stale, false);<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> public static Result create(Cell[] cells, Boolean exists, boolean stale,<a name="line.172"></a>
<span class="sourceLineNo">173</span> boolean mayHaveMoreCellsInRow) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if (exists != null) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> return new Result(null, exists, stale, mayHaveMoreCellsInRow);<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> return new Result(cells, null, stale, mayHaveMoreCellsInRow);<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> public static Result createCursorResult(Cursor cursor) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> return new Result(cursor);<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> private Result(Cursor cursor) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> this.cursor = cursor;<a name="line.185"></a>
<span class="sourceLineNo">186</span> this.readonly = false;<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> /** Private ctor. Use {@link #create(Cell[])}. */<a name="line.189"></a>
<span class="sourceLineNo">190</span> private Result(Cell[] cells, Boolean exists, boolean stale, boolean mayHaveMoreCellsInRow) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> this.cells = cells;<a name="line.191"></a>
<span class="sourceLineNo">192</span> this.exists = exists;<a name="line.192"></a>
<span class="sourceLineNo">193</span> this.stale = stale;<a name="line.193"></a>
<span class="sourceLineNo">194</span> this.mayHaveMoreCellsInRow = mayHaveMoreCellsInRow;<a name="line.194"></a>
<span class="sourceLineNo">195</span> this.readonly = false;<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> /**<a name="line.198"></a>
<span class="sourceLineNo">199</span> * Method for retrieving the row key that corresponds to<a name="line.199"></a>
<span class="sourceLineNo">200</span> * the row from which this Result was created.<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @return row<a name="line.201"></a>
<span class="sourceLineNo">202</span> */<a name="line.202"></a>
<span class="sourceLineNo">203</span> public byte [] getRow() {<a name="line.203"></a>
<span class="sourceLineNo">204</span> if (this.row == null) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> this.row = (this.cells == null || this.cells.length == 0) ?<a name="line.205"></a>
<span class="sourceLineNo">206</span> null :<a name="line.206"></a>
<span class="sourceLineNo">207</span> CellUtil.cloneRow(this.cells[0]);<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> return this.row;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
<span class="sourceLineNo">213</span> * Return the array of Cells backing this Result instance.<a name="line.213"></a>
<span class="sourceLineNo">214</span> *<a name="line.214"></a>
<span class="sourceLineNo">215</span> * The array is sorted from smallest -&amp;gt; largest using the<a name="line.215"></a>
<span class="sourceLineNo">216</span> * {@link CellComparator}.<a name="line.216"></a>
<span class="sourceLineNo">217</span> *<a name="line.217"></a>
<span class="sourceLineNo">218</span> * The array only contains what your Get or Scan specifies and no more.<a name="line.218"></a>
<span class="sourceLineNo">219</span> * For example if you request column "A" 1 version you will have at most 1<a name="line.219"></a>
<span class="sourceLineNo">220</span> * Cell in the array. If you request column "A" with 2 version you will<a name="line.220"></a>
<span class="sourceLineNo">221</span> * have at most 2 Cells, with the first one being the newer timestamp and<a name="line.221"></a>
<span class="sourceLineNo">222</span> * the second being the older timestamp (this is the sort order defined by<a name="line.222"></a>
<span class="sourceLineNo">223</span> * {@link CellComparator}). If columns don't exist, they won't be<a name="line.223"></a>
<span class="sourceLineNo">224</span> * present in the result. Therefore if you ask for 1 version all columns,<a name="line.224"></a>
<span class="sourceLineNo">225</span> * it is safe to iterate over this array and expect to see 1 Cell for<a name="line.225"></a>
<span class="sourceLineNo">226</span> * each column and no more.<a name="line.226"></a>
<span class="sourceLineNo">227</span> *<a name="line.227"></a>
<span class="sourceLineNo">228</span> * This API is faster than using getFamilyMap() and getMap()<a name="line.228"></a>
<span class="sourceLineNo">229</span> *<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @return array of Cells; can be null if nothing in the result<a name="line.230"></a>
<span class="sourceLineNo">231</span> */<a name="line.231"></a>
<span class="sourceLineNo">232</span> public Cell[] rawCells() {<a name="line.232"></a>
<span class="sourceLineNo">233</span> return cells;<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> /**<a name="line.236"></a>
<span class="sourceLineNo">237</span> * Create a sorted list of the Cell's in this result.<a name="line.237"></a>
<span class="sourceLineNo">238</span> *<a name="line.238"></a>
<span class="sourceLineNo">239</span> * Since HBase 0.20.5 this is equivalent to raw().<a name="line.239"></a>
<span class="sourceLineNo">240</span> *<a name="line.240"></a>
<span class="sourceLineNo">241</span> * @return sorted List of Cells; can be null if no cells in the result<a name="line.241"></a>
<span class="sourceLineNo">242</span> */<a name="line.242"></a>
<span class="sourceLineNo">243</span> public List&lt;Cell&gt; listCells() {<a name="line.243"></a>
<span class="sourceLineNo">244</span> return isEmpty()? null: Arrays.asList(rawCells());<a name="line.244"></a>
<span class="sourceLineNo">245</span> }<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span> /**<a name="line.247"></a>
<span class="sourceLineNo">248</span> * Return the Cells for the specific column. The Cells are sorted in<a name="line.248"></a>
<span class="sourceLineNo">249</span> * the {@link CellComparator} order. That implies the first entry in<a name="line.249"></a>
<span class="sourceLineNo">250</span> * the list is the most recent column. If the query (Scan or Get) only<a name="line.250"></a>
<span class="sourceLineNo">251</span> * requested 1 version the list will contain at most 1 entry. If the column<a name="line.251"></a>
<span class="sourceLineNo">252</span> * did not exist in the result set (either the column does not exist<a name="line.252"></a>
<span class="sourceLineNo">253</span> * or the column was not selected in the query) the list will be empty.<a name="line.253"></a>
<span class="sourceLineNo">254</span> *<a name="line.254"></a>
<span class="sourceLineNo">255</span> * Also see getColumnLatest which returns just a Cell<a name="line.255"></a>
<span class="sourceLineNo">256</span> *<a name="line.256"></a>
<span class="sourceLineNo">257</span> * @param family the family<a name="line.257"></a>
<span class="sourceLineNo">258</span> * @param qualifier<a name="line.258"></a>
<span class="sourceLineNo">259</span> * @return a list of Cells for this column or empty list if the column<a name="line.259"></a>
<span class="sourceLineNo">260</span> * did not exist in the result set<a name="line.260"></a>
<span class="sourceLineNo">261</span> */<a name="line.261"></a>
<span class="sourceLineNo">262</span> public List&lt;Cell&gt; getColumnCells(byte [] family, byte [] qualifier) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> List&lt;Cell&gt; result = new ArrayList&lt;&gt;();<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span> Cell [] kvs = rawCells();<a name="line.265"></a>
<span class="sourceLineNo">266</span><a name="line.266"></a>
<span class="sourceLineNo">267</span> if (kvs == null || kvs.length == 0) {<a name="line.267"></a>
<span class="sourceLineNo">268</span> return result;<a name="line.268"></a>
<span class="sourceLineNo">269</span> }<a name="line.269"></a>
<span class="sourceLineNo">270</span> int pos = binarySearch(kvs, family, qualifier);<a name="line.270"></a>
<span class="sourceLineNo">271</span> if (pos == -1) {<a name="line.271"></a>
<span class="sourceLineNo">272</span> return result; // cant find it<a name="line.272"></a>
<span class="sourceLineNo">273</span> }<a name="line.273"></a>
<span class="sourceLineNo">274</span><a name="line.274"></a>
<span class="sourceLineNo">275</span> for (int i = pos; i &lt; kvs.length; i++) {<a name="line.275"></a>
<span class="sourceLineNo">276</span> if (CellUtil.matchingColumn(kvs[i], family,qualifier)) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> result.add(kvs[i]);<a name="line.277"></a>
<span class="sourceLineNo">278</span> } else {<a name="line.278"></a>
<span class="sourceLineNo">279</span> break;<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span> }<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span> return result;<a name="line.283"></a>
<span class="sourceLineNo">284</span> }<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span> private byte[] notNullBytes(final byte[] bytes) {<a name="line.286"></a>
<span class="sourceLineNo">287</span> if (bytes == null) {<a name="line.287"></a>
<span class="sourceLineNo">288</span> return HConstants.EMPTY_BYTE_ARRAY;<a name="line.288"></a>
<span class="sourceLineNo">289</span> } else {<a name="line.289"></a>
<span class="sourceLineNo">290</span> return bytes;<a name="line.290"></a>
<span class="sourceLineNo">291</span> }<a name="line.291"></a>
<span class="sourceLineNo">292</span> }<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span> protected int binarySearch(final Cell [] kvs,<a name="line.294"></a>
<span class="sourceLineNo">295</span> final byte [] family,<a name="line.295"></a>
<span class="sourceLineNo">296</span> final byte [] qualifier) {<a name="line.296"></a>
<span class="sourceLineNo">297</span> byte[] familyNotNull = notNullBytes(family);<a name="line.297"></a>
<span class="sourceLineNo">298</span> byte[] qualifierNotNull = notNullBytes(qualifier);<a name="line.298"></a>
<span class="sourceLineNo">299</span> Cell searchTerm =<a name="line.299"></a>
<span class="sourceLineNo">300</span> PrivateCellUtil.createFirstOnRow(kvs[0].getRowArray(),<a name="line.300"></a>
<span class="sourceLineNo">301</span> kvs[0].getRowOffset(), kvs[0].getRowLength(),<a name="line.301"></a>
<span class="sourceLineNo">302</span> familyNotNull, 0, (byte)familyNotNull.length,<a name="line.302"></a>
<span class="sourceLineNo">303</span> qualifierNotNull, 0, qualifierNotNull.length);<a name="line.303"></a>
<span class="sourceLineNo">304</span><a name="line.304"></a>
<span class="sourceLineNo">305</span> // pos === ( -(insertion point) - 1)<a name="line.305"></a>
<span class="sourceLineNo">306</span> int pos = Arrays.binarySearch(kvs, searchTerm, CellComparator.getInstance());<a name="line.306"></a>
<span class="sourceLineNo">307</span> // never will exact match<a name="line.307"></a>
<span class="sourceLineNo">308</span> if (pos &lt; 0) {<a name="line.308"></a>
<span class="sourceLineNo">309</span> pos = (pos+1) * -1;<a name="line.309"></a>
<span class="sourceLineNo">310</span> // pos is now insertion point<a name="line.310"></a>
<span class="sourceLineNo">311</span> }<a name="line.311"></a>
<span class="sourceLineNo">312</span> if (pos == kvs.length) {<a name="line.312"></a>
<span class="sourceLineNo">313</span> return -1; // doesn't exist<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span> return pos;<a name="line.315"></a>
<span class="sourceLineNo">316</span> }<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span> /**<a name="line.318"></a>
<span class="sourceLineNo">319</span> * Searches for the latest value for the specified column.<a name="line.319"></a>
<span class="sourceLineNo">320</span> *<a name="line.320"></a>
<span class="sourceLineNo">321</span> * @param kvs the array to search<a name="line.321"></a>
<span class="sourceLineNo">322</span> * @param family family name<a name="line.322"></a>
<span class="sourceLineNo">323</span> * @param foffset family offset<a name="line.323"></a>
<span class="sourceLineNo">324</span> * @param flength family length<a name="line.324"></a>
<span class="sourceLineNo">325</span> * @param qualifier column qualifier<a name="line.325"></a>
<span class="sourceLineNo">326</span> * @param qoffset qualifier offset<a name="line.326"></a>
<span class="sourceLineNo">327</span> * @param qlength qualifier length<a name="line.327"></a>
<span class="sourceLineNo">328</span> *<a name="line.328"></a>
<span class="sourceLineNo">329</span> * @return the index where the value was found, or -1 otherwise<a name="line.329"></a>
<span class="sourceLineNo">330</span> */<a name="line.330"></a>
<span class="sourceLineNo">331</span> protected int binarySearch(final Cell [] kvs,<a name="line.331"></a>
<span class="sourceLineNo">332</span> final byte [] family, final int foffset, final int flength,<a name="line.332"></a>
<span class="sourceLineNo">333</span> final byte [] qualifier, final int qoffset, final int qlength) {<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span> double keyValueSize = (double)<a name="line.335"></a>
<span class="sourceLineNo">336</span> KeyValue.getKeyValueDataStructureSize(kvs[0].getRowLength(), flength, qlength, 0);<a name="line.336"></a>
<span class="sourceLineNo">337</span><a name="line.337"></a>
<span class="sourceLineNo">338</span> byte[] buffer = localBuffer.get();<a name="line.338"></a>
<span class="sourceLineNo">339</span> if (buffer == null || keyValueSize &gt; buffer.length) {<a name="line.339"></a>
<span class="sourceLineNo">340</span> // pad to the smallest multiple of the pad width<a name="line.340"></a>
<span class="sourceLineNo">341</span> buffer = new byte[(int) Math.ceil(keyValueSize / PAD_WIDTH) * PAD_WIDTH];<a name="line.341"></a>
<span class="sourceLineNo">342</span> localBuffer.set(buffer);<a name="line.342"></a>
<span class="sourceLineNo">343</span> }<a name="line.343"></a>
<span class="sourceLineNo">344</span><a name="line.344"></a>
<span class="sourceLineNo">345</span> Cell searchTerm = KeyValueUtil.createFirstOnRow(buffer, 0,<a name="line.345"></a>
<span class="sourceLineNo">346</span> kvs[0].getRowArray(), kvs[0].getRowOffset(), kvs[0].getRowLength(),<a name="line.346"></a>
<span class="sourceLineNo">347</span> family, foffset, flength,<a name="line.347"></a>
<span class="sourceLineNo">348</span> qualifier, qoffset, qlength);<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span> // pos === ( -(insertion point) - 1)<a name="line.350"></a>
<span class="sourceLineNo">351</span> int pos = Arrays.binarySearch(kvs, searchTerm, CellComparator.getInstance());<a name="line.351"></a>
<span class="sourceLineNo">352</span> // never will exact match<a name="line.352"></a>
<span class="sourceLineNo">353</span> if (pos &lt; 0) {<a name="line.353"></a>
<span class="sourceLineNo">354</span> pos = (pos+1) * -1;<a name="line.354"></a>
<span class="sourceLineNo">355</span> // pos is now insertion point<a name="line.355"></a>
<span class="sourceLineNo">356</span> }<a name="line.356"></a>
<span class="sourceLineNo">357</span> if (pos == kvs.length) {<a name="line.357"></a>
<span class="sourceLineNo">358</span> return -1; // doesn't exist<a name="line.358"></a>
<span class="sourceLineNo">359</span> }<a name="line.359"></a>
<span class="sourceLineNo">360</span> return pos;<a name="line.360"></a>
<span class="sourceLineNo">361</span> }<a name="line.361"></a>
<span class="sourceLineNo">362</span><a name="line.362"></a>
<span class="sourceLineNo">363</span> /**<a name="line.363"></a>
<span class="sourceLineNo">364</span> * The Cell for the most recent timestamp for a given column.<a name="line.364"></a>
<span class="sourceLineNo">365</span> *<a name="line.365"></a>
<span class="sourceLineNo">366</span> * @param family<a name="line.366"></a>
<span class="sourceLineNo">367</span> * @param qualifier<a name="line.367"></a>
<span class="sourceLineNo">368</span> *<a name="line.368"></a>
<span class="sourceLineNo">369</span> * @return the Cell for the column, or null if no value exists in the row or none have been<a name="line.369"></a>
<span class="sourceLineNo">370</span> * selected in the query (Get/Scan)<a name="line.370"></a>
<span class="sourceLineNo">371</span> */<a name="line.371"></a>
<span class="sourceLineNo">372</span> public Cell getColumnLatestCell(byte [] family, byte [] qualifier) {<a name="line.372"></a>
<span class="sourceLineNo">373</span> Cell [] kvs = rawCells(); // side effect possibly.<a name="line.373"></a>
<span class="sourceLineNo">374</span> if (kvs == null || kvs.length == 0) {<a name="line.374"></a>
<span class="sourceLineNo">375</span> return null;<a name="line.375"></a>
<span class="sourceLineNo">376</span> }<a name="line.376"></a>
<span class="sourceLineNo">377</span> int pos = binarySearch(kvs, family, qualifier);<a name="line.377"></a>
<span class="sourceLineNo">378</span> if (pos == -1) {<a name="line.378"></a>
<span class="sourceLineNo">379</span> return null;<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span> if (CellUtil.matchingColumn(kvs[pos], family, qualifier)) {<a name="line.381"></a>
<span class="sourceLineNo">382</span> return kvs[pos];<a name="line.382"></a>
<span class="sourceLineNo">383</span> }<a name="line.383"></a>
<span class="sourceLineNo">384</span> return null;<a name="line.384"></a>
<span class="sourceLineNo">385</span> }<a name="line.385"></a>
<span class="sourceLineNo">386</span><a name="line.386"></a>
<span class="sourceLineNo">387</span> /**<a name="line.387"></a>
<span class="sourceLineNo">388</span> * The Cell for the most recent timestamp for a given column.<a name="line.388"></a>
<span class="sourceLineNo">389</span> *<a name="line.389"></a>
<span class="sourceLineNo">390</span> * @param family family name<a name="line.390"></a>
<span class="sourceLineNo">391</span> * @param foffset family offset<a name="line.391"></a>
<span class="sourceLineNo">392</span> * @param flength family length<a name="line.392"></a>
<span class="sourceLineNo">393</span> * @param qualifier column qualifier<a name="line.393"></a>
<span class="sourceLineNo">394</span> * @param qoffset qualifier offset<a name="line.394"></a>
<span class="sourceLineNo">395</span> * @param qlength qualifier length<a name="line.395"></a>
<span class="sourceLineNo">396</span> *<a name="line.396"></a>
<span class="sourceLineNo">397</span> * @return the Cell for the column, or null if no value exists in the row or none have been<a name="line.397"></a>
<span class="sourceLineNo">398</span> * selected in the query (Get/Scan)<a name="line.398"></a>
<span class="sourceLineNo">399</span> */<a name="line.399"></a>
<span class="sourceLineNo">400</span> public Cell getColumnLatestCell(byte [] family, int foffset, int flength,<a name="line.400"></a>
<span class="sourceLineNo">401</span> byte [] qualifier, int qoffset, int qlength) {<a name="line.401"></a>
<span class="sourceLineNo">402</span><a name="line.402"></a>
<span class="sourceLineNo">403</span> Cell [] kvs = rawCells(); // side effect possibly.<a name="line.403"></a>
<span class="sourceLineNo">404</span> if (kvs == null || kvs.length == 0) {<a name="line.404"></a>
<span class="sourceLineNo">405</span> return null;<a name="line.405"></a>
<span class="sourceLineNo">406</span> }<a name="line.406"></a>
<span class="sourceLineNo">407</span> int pos = binarySearch(kvs, family, foffset, flength, qualifier, qoffset, qlength);<a name="line.407"></a>
<span class="sourceLineNo">408</span> if (pos == -1) {<a name="line.408"></a>
<span class="sourceLineNo">409</span> return null;<a name="line.409"></a>
<span class="sourceLineNo">410</span> }<a name="line.410"></a>
<span class="sourceLineNo">411</span> if (PrivateCellUtil.matchingColumn(kvs[pos], family, foffset, flength, qualifier, qoffset,<a name="line.411"></a>
<span class="sourceLineNo">412</span> qlength)) {<a name="line.412"></a>
<span class="sourceLineNo">413</span> return kvs[pos];<a name="line.413"></a>
<span class="sourceLineNo">414</span> }<a name="line.414"></a>
<span class="sourceLineNo">415</span> return null;<a name="line.415"></a>
<span class="sourceLineNo">416</span> }<a name="line.416"></a>
<span class="sourceLineNo">417</span><a name="line.417"></a>
<span class="sourceLineNo">418</span> /**<a name="line.418"></a>
<span class="sourceLineNo">419</span> * Get the latest version of the specified column.<a name="line.419"></a>
<span class="sourceLineNo">420</span> * Note: this call clones the value content of the hosting Cell. See<a name="line.420"></a>
<span class="sourceLineNo">421</span> * {@link #getValueAsByteBuffer(byte[], byte[])}, etc., or {@link #listCells()} if you would<a name="line.421"></a>
<span class="sourceLineNo">422</span> * avoid the cloning.<a name="line.422"></a>
<span class="sourceLineNo">423</span> * @param family family name<a name="line.423"></a>
<span class="sourceLineNo">424</span> * @param qualifier column qualifier<a name="line.424"></a>
<span class="sourceLineNo">425</span> * @return value of latest version of column, null if none found<a name="line.425"></a>
<span class="sourceLineNo">426</span> */<a name="line.426"></a>
<span class="sourceLineNo">427</span> public byte[] getValue(byte [] family, byte [] qualifier) {<a name="line.427"></a>
<span class="sourceLineNo">428</span> Cell kv = getColumnLatestCell(family, qualifier);<a name="line.428"></a>
<span class="sourceLineNo">429</span> if (kv == null) {<a name="line.429"></a>
<span class="sourceLineNo">430</span> return null;<a name="line.430"></a>
<span class="sourceLineNo">431</span> }<a name="line.431"></a>
<span class="sourceLineNo">432</span> return CellUtil.cloneValue(kv);<a name="line.432"></a>
<span class="sourceLineNo">433</span> }<a name="line.433"></a>
<span class="sourceLineNo">434</span><a name="line.434"></a>
<span class="sourceLineNo">435</span> /**<a name="line.435"></a>
<span class="sourceLineNo">436</span> * Returns the value wrapped in a new &lt;code&gt;ByteBuffer&lt;/code&gt;.<a name="line.436"></a>
<span class="sourceLineNo">437</span> *<a name="line.437"></a>
<span class="sourceLineNo">438</span> * @param family family name<a name="line.438"></a>
<span class="sourceLineNo">439</span> * @param qualifier column qualifier<a name="line.439"></a>
<span class="sourceLineNo">440</span> *<a name="line.440"></a>
<span class="sourceLineNo">441</span> * @return the latest version of the column, or &lt;code&gt;null&lt;/code&gt; if none found<a name="line.441"></a>
<span class="sourceLineNo">442</span> */<a name="line.442"></a>
<span class="sourceLineNo">443</span> public ByteBuffer getValueAsByteBuffer(byte [] family, byte [] qualifier) {<a name="line.443"></a>
<span class="sourceLineNo">444</span><a name="line.444"></a>
<span class="sourceLineNo">445</span> Cell kv = getColumnLatestCell(family, 0, family.length, qualifier, 0, qualifier.length);<a name="line.445"></a>
<span class="sourceLineNo">446</span><a name="line.446"></a>
<span class="sourceLineNo">447</span> if (kv == null) {<a name="line.447"></a>
<span class="sourceLineNo">448</span> return null;<a name="line.448"></a>
<span class="sourceLineNo">449</span> }<a name="line.449"></a>
<span class="sourceLineNo">450</span> return ByteBuffer.wrap(kv.getValueArray(), kv.getValueOffset(), kv.getValueLength()).<a name="line.450"></a>
<span class="sourceLineNo">451</span> asReadOnlyBuffer();<a name="line.451"></a>
<span class="sourceLineNo">452</span> }<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span> /**<a name="line.454"></a>
<span class="sourceLineNo">455</span> * Returns the value wrapped in a new &lt;code&gt;ByteBuffer&lt;/code&gt;.<a name="line.455"></a>
<span class="sourceLineNo">456</span> *<a name="line.456"></a>
<span class="sourceLineNo">457</span> * @param family family name<a name="line.457"></a>
<span class="sourceLineNo">458</span> * @param foffset family offset<a name="line.458"></a>
<span class="sourceLineNo">459</span> * @param flength family length<a name="line.459"></a>
<span class="sourceLineNo">460</span> * @param qualifier column qualifier<a name="line.460"></a>
<span class="sourceLineNo">461</span> * @param qoffset qualifier offset<a name="line.461"></a>
<span class="sourceLineNo">462</span> * @param qlength qualifier length<a name="line.462"></a>
<span class="sourceLineNo">463</span> *<a name="line.463"></a>
<span class="sourceLineNo">464</span> * @return the latest version of the column, or &lt;code&gt;null&lt;/code&gt; if none found<a name="line.464"></a>
<span class="sourceLineNo">465</span> */<a name="line.465"></a>
<span class="sourceLineNo">466</span> public ByteBuffer getValueAsByteBuffer(byte [] family, int foffset, int flength,<a name="line.466"></a>
<span class="sourceLineNo">467</span> byte [] qualifier, int qoffset, int qlength) {<a name="line.467"></a>
<span class="sourceLineNo">468</span><a name="line.468"></a>
<span class="sourceLineNo">469</span> Cell kv = getColumnLatestCell(family, foffset, flength, qualifier, qoffset, qlength);<a name="line.469"></a>
<span class="sourceLineNo">470</span><a name="line.470"></a>
<span class="sourceLineNo">471</span> if (kv == null) {<a name="line.471"></a>
<span class="sourceLineNo">472</span> return null;<a name="line.472"></a>
<span class="sourceLineNo">473</span> }<a name="line.473"></a>
<span class="sourceLineNo">474</span> return ByteBuffer.wrap(kv.getValueArray(), kv.getValueOffset(), kv.getValueLength()).<a name="line.474"></a>
<span class="sourceLineNo">475</span> asReadOnlyBuffer();<a name="line.475"></a>
<span class="sourceLineNo">476</span> }<a name="line.476"></a>
<span class="sourceLineNo">477</span><a name="line.477"></a>
<span class="sourceLineNo">478</span> /**<a name="line.478"></a>
<span class="sourceLineNo">479</span> * Loads the latest version of the specified column into the provided &lt;code&gt;ByteBuffer&lt;/code&gt;.<a name="line.479"></a>
<span class="sourceLineNo">480</span> * &lt;p&gt;<a name="line.480"></a>
<span class="sourceLineNo">481</span> * Does not clear or flip the buffer.<a name="line.481"></a>
<span class="sourceLineNo">482</span> *<a name="line.482"></a>
<span class="sourceLineNo">483</span> * @param family family name<a name="line.483"></a>
<span class="sourceLineNo">484</span> * @param qualifier column qualifier<a name="line.484"></a>
<span class="sourceLineNo">485</span> * @param dst the buffer where to write the value<a name="line.485"></a>
<span class="sourceLineNo">486</span> *<a name="line.486"></a>
<span class="sourceLineNo">487</span> * @return &lt;code&gt;true&lt;/code&gt; if a value was found, &lt;code&gt;false&lt;/code&gt; otherwise<a name="line.487"></a>
<span class="sourceLineNo">488</span> *<a name="line.488"></a>
<span class="sourceLineNo">489</span> * @throws BufferOverflowException there is insufficient space remaining in the buffer<a name="line.489"></a>
<span class="sourceLineNo">490</span> */<a name="line.490"></a>
<span class="sourceLineNo">491</span> public boolean loadValue(byte [] family, byte [] qualifier, ByteBuffer dst)<a name="line.491"></a>
<span class="sourceLineNo">492</span> throws BufferOverflowException {<a name="line.492"></a>
<span class="sourceLineNo">493</span> return loadValue(family, 0, family.length, qualifier, 0, qualifier.length, dst);<a name="line.493"></a>
<span class="sourceLineNo">494</span> }<a name="line.494"></a>
<span class="sourceLineNo">495</span><a name="line.495"></a>
<span class="sourceLineNo">496</span> /**<a name="line.496"></a>
<span class="sourceLineNo">497</span> * Loads the latest version of the specified column into the provided &lt;code&gt;ByteBuffer&lt;/code&gt;.<a name="line.497"></a>
<span class="sourceLineNo">498</span> * &lt;p&gt;<a name="line.498"></a>
<span class="sourceLineNo">499</span> * Does not clear or flip the buffer.<a name="line.499"></a>
<span class="sourceLineNo">500</span> *<a name="line.500"></a>
<span class="sourceLineNo">501</span> * @param family family name<a name="line.501"></a>
<span class="sourceLineNo">502</span> * @param foffset family offset<a name="line.502"></a>
<span class="sourceLineNo">503</span> * @param flength family length<a name="line.503"></a>
<span class="sourceLineNo">504</span> * @param qualifier column qualifier<a name="line.504"></a>
<span class="sourceLineNo">505</span> * @param qoffset qualifier offset<a name="line.505"></a>
<span class="sourceLineNo">506</span> * @param qlength qualifier length<a name="line.506"></a>
<span class="sourceLineNo">507</span> * @param dst the buffer where to write the value<a name="line.507"></a>
<span class="sourceLineNo">508</span> *<a name="line.508"></a>
<span class="sourceLineNo">509</span> * @return &lt;code&gt;true&lt;/code&gt; if a value was found, &lt;code&gt;false&lt;/code&gt; otherwise<a name="line.509"></a>
<span class="sourceLineNo">510</span> *<a name="line.510"></a>
<span class="sourceLineNo">511</span> * @throws BufferOverflowException there is insufficient space remaining in the buffer<a name="line.511"></a>
<span class="sourceLineNo">512</span> */<a name="line.512"></a>
<span class="sourceLineNo">513</span> public boolean loadValue(byte [] family, int foffset, int flength,<a name="line.513"></a>
<span class="sourceLineNo">514</span> byte [] qualifier, int qoffset, int qlength, ByteBuffer dst)<a name="line.514"></a>
<span class="sourceLineNo">515</span> throws BufferOverflowException {<a name="line.515"></a>
<span class="sourceLineNo">516</span> Cell kv = getColumnLatestCell(family, foffset, flength, qualifier, qoffset, qlength);<a name="line.516"></a>
<span class="sourceLineNo">517</span><a name="line.517"></a>
<span class="sourceLineNo">518</span> if (kv == null) {<a name="line.518"></a>
<span class="sourceLineNo">519</span> return false;<a name="line.519"></a>
<span class="sourceLineNo">520</span> }<a name="line.520"></a>
<span class="sourceLineNo">521</span> dst.put(kv.getValueArray(), kv.getValueOffset(), kv.getValueLength());<a name="line.521"></a>
<span class="sourceLineNo">522</span> return true;<a name="line.522"></a>
<span class="sourceLineNo">523</span> }<a name="line.523"></a>
<span class="sourceLineNo">524</span><a name="line.524"></a>
<span class="sourceLineNo">525</span> /**<a name="line.525"></a>
<span class="sourceLineNo">526</span> * Checks if the specified column contains a non-empty value (not a zero-length byte array).<a name="line.526"></a>
<span class="sourceLineNo">527</span> *<a name="line.527"></a>
<span class="sourceLineNo">528</span> * @param family family name<a name="line.528"></a>
<span class="sourceLineNo">529</span> * @param qualifier column qualifier<a name="line.529"></a>
<span class="sourceLineNo">530</span> *<a name="line.530"></a>
<span class="sourceLineNo">531</span> * @return whether or not a latest value exists and is not empty<a name="line.531"></a>
<span class="sourceLineNo">532</span> */<a name="line.532"></a>
<span class="sourceLineNo">533</span> public boolean containsNonEmptyColumn(byte [] family, byte [] qualifier) {<a name="line.533"></a>
<span class="sourceLineNo">534</span><a name="line.534"></a>
<span class="sourceLineNo">535</span> return containsNonEmptyColumn(family, 0, family.length, qualifier, 0, qualifier.length);<a name="line.535"></a>
<span class="sourceLineNo">536</span> }<a name="line.536"></a>
<span class="sourceLineNo">537</span><a name="line.537"></a>
<span class="sourceLineNo">538</span> /**<a name="line.538"></a>
<span class="sourceLineNo">539</span> * Checks if the specified column contains a non-empty value (not a zero-length byte array).<a name="line.539"></a>
<span class="sourceLineNo">540</span> *<a name="line.540"></a>
<span class="sourceLineNo">541</span> * @param family family name<a name="line.541"></a>
<span class="sourceLineNo">542</span> * @param foffset family offset<a name="line.542"></a>
<span class="sourceLineNo">543</span> * @param flength family length<a name="line.543"></a>
<span class="sourceLineNo">544</span> * @param qualifier column qualifier<a name="line.544"></a>
<span class="sourceLineNo">545</span> * @param qoffset qualifier offset<a name="line.545"></a>
<span class="sourceLineNo">546</span> * @param qlength qualifier length<a name="line.546"></a>
<span class="sourceLineNo">547</span> *<a name="line.547"></a>
<span class="sourceLineNo">548</span> * @return whether or not a latest value exists and is not empty<a name="line.548"></a>
<span class="sourceLineNo">549</span> */<a name="line.549"></a>
<span class="sourceLineNo">550</span> public boolean containsNonEmptyColumn(byte [] family, int foffset, int flength,<a name="line.550"></a>
<span class="sourceLineNo">551</span> byte [] qualifier, int qoffset, int qlength) {<a name="line.551"></a>
<span class="sourceLineNo">552</span><a name="line.552"></a>
<span class="sourceLineNo">553</span> Cell kv = getColumnLatestCell(family, foffset, flength, qualifier, qoffset, qlength);<a name="line.553"></a>
<span class="sourceLineNo">554</span><a name="line.554"></a>
<span class="sourceLineNo">555</span> return (kv != null) &amp;&amp; (kv.getValueLength() &gt; 0);<a name="line.555"></a>
<span class="sourceLineNo">556</span> }<a name="line.556"></a>
<span class="sourceLineNo">557</span><a name="line.557"></a>
<span class="sourceLineNo">558</span> /**<a name="line.558"></a>
<span class="sourceLineNo">559</span> * Checks if the specified column contains an empty value (a zero-length byte array).<a name="line.559"></a>
<span class="sourceLineNo">560</span> *<a name="line.560"></a>
<span class="sourceLineNo">561</span> * @param family family name<a name="line.561"></a>
<span class="sourceLineNo">562</span> * @param qualifier column qualifier<a name="line.562"></a>
<span class="sourceLineNo">563</span> *<a name="line.563"></a>
<span class="sourceLineNo">564</span> * @return whether or not a latest value exists and is empty<a name="line.564"></a>
<span class="sourceLineNo">565</span> */<a name="line.565"></a>
<span class="sourceLineNo">566</span> public boolean containsEmptyColumn(byte [] family, byte [] qualifier) {<a name="line.566"></a>
<span class="sourceLineNo">567</span><a name="line.567"></a>
<span class="sourceLineNo">568</span> return containsEmptyColumn(family, 0, family.length, qualifier, 0, qualifier.length);<a name="line.568"></a>
<span class="sourceLineNo">569</span> }<a name="line.569"></a>
<span class="sourceLineNo">570</span><a name="line.570"></a>
<span class="sourceLineNo">571</span> /**<a name="line.571"></a>
<span class="sourceLineNo">572</span> * Checks if the specified column contains an empty value (a zero-length byte array).<a name="line.572"></a>
<span class="sourceLineNo">573</span> *<a name="line.573"></a>
<span class="sourceLineNo">574</span> * @param family family name<a name="line.574"></a>
<span class="sourceLineNo">575</span> * @param foffset family offset<a name="line.575"></a>
<span class="sourceLineNo">576</span> * @param flength family length<a name="line.576"></a>
<span class="sourceLineNo">577</span> * @param qualifier column qualifier<a name="line.577"></a>
<span class="sourceLineNo">578</span> * @param qoffset qualifier offset<a name="line.578"></a>
<span class="sourceLineNo">579</span> * @param qlength qualifier length<a name="line.579"></a>
<span class="sourceLineNo">580</span> *<a name="line.580"></a>
<span class="sourceLineNo">581</span> * @return whether or not a latest value exists and is empty<a name="line.581"></a>
<span class="sourceLineNo">582</span> */<a name="line.582"></a>
<span class="sourceLineNo">583</span> public boolean containsEmptyColumn(byte [] family, int foffset, int flength,<a name="line.583"></a>
<span class="sourceLineNo">584</span> byte [] qualifier, int qoffset, int qlength) {<a name="line.584"></a>
<span class="sourceLineNo">585</span> Cell kv = getColumnLatestCell(family, foffset, flength, qualifier, qoffset, qlength);<a name="line.585"></a>
<span class="sourceLineNo">586</span><a name="line.586"></a>
<span class="sourceLineNo">587</span> return (kv != null) &amp;&amp; (kv.getValueLength() == 0);<a name="line.587"></a>
<span class="sourceLineNo">588</span> }<a name="line.588"></a>
<span class="sourceLineNo">589</span><a name="line.589"></a>
<span class="sourceLineNo">590</span> /**<a name="line.590"></a>
<span class="sourceLineNo">591</span> * Checks for existence of a value for the specified column (empty or not).<a name="line.591"></a>
<span class="sourceLineNo">592</span> *<a name="line.592"></a>
<span class="sourceLineNo">593</span> * @param family family name<a name="line.593"></a>
<span class="sourceLineNo">594</span> * @param qualifier column qualifier<a name="line.594"></a>
<span class="sourceLineNo">595</span> *<a name="line.595"></a>
<span class="sourceLineNo">596</span> * @return true if at least one value exists in the result, false if not<a name="line.596"></a>
<span class="sourceLineNo">597</span> */<a name="line.597"></a>
<span class="sourceLineNo">598</span> public boolean containsColumn(byte [] family, byte [] qualifier) {<a name="line.598"></a>
<span class="sourceLineNo">599</span> Cell kv = getColumnLatestCell(family, qualifier);<a name="line.599"></a>
<span class="sourceLineNo">600</span> return kv != null;<a name="line.600"></a>
<span class="sourceLineNo">601</span> }<a name="line.601"></a>
<span class="sourceLineNo">602</span><a name="line.602"></a>
<span class="sourceLineNo">603</span> /**<a name="line.603"></a>
<span class="sourceLineNo">604</span> * Checks for existence of a value for the specified column (empty or not).<a name="line.604"></a>
<span class="sourceLineNo">605</span> *<a name="line.605"></a>
<span class="sourceLineNo">606</span> * @param family family name<a name="line.606"></a>
<span class="sourceLineNo">607</span> * @param foffset family offset<a name="line.607"></a>
<span class="sourceLineNo">608</span> * @param flength family length<a name="line.608"></a>
<span class="sourceLineNo">609</span> * @param qualifier column qualifier<a name="line.609"></a>
<span class="sourceLineNo">610</span> * @param qoffset qualifier offset<a name="line.610"></a>
<span class="sourceLineNo">611</span> * @param qlength qualifier length<a name="line.611"></a>
<span class="sourceLineNo">612</span> *<a name="line.612"></a>
<span class="sourceLineNo">613</span> * @return true if at least one value exists in the result, false if not<a name="line.613"></a>
<span class="sourceLineNo">614</span> */<a name="line.614"></a>
<span class="sourceLineNo">615</span> public boolean containsColumn(byte [] family, int foffset, int flength,<a name="line.615"></a>
<span class="sourceLineNo">616</span> byte [] qualifier, int qoffset, int qlength) {<a name="line.616"></a>
<span class="sourceLineNo">617</span><a name="line.617"></a>
<span class="sourceLineNo">618</span> return getColumnLatestCell(family, foffset, flength, qualifier, qoffset, qlength) != null;<a name="line.618"></a>
<span class="sourceLineNo">619</span> }<a name="line.619"></a>
<span class="sourceLineNo">620</span><a name="line.620"></a>
<span class="sourceLineNo">621</span> /**<a name="line.621"></a>
<span class="sourceLineNo">622</span> * Map of families to all versions of its qualifiers and values.<a name="line.622"></a>
<span class="sourceLineNo">623</span> * &lt;p&gt;<a name="line.623"></a>
<span class="sourceLineNo">624</span> * Returns a three level Map of the form:<a name="line.624"></a>
<span class="sourceLineNo">625</span> * &lt;code&gt;Map&amp;amp;family,Map&amp;lt;qualifier,Map&amp;lt;timestamp,value&amp;gt;&amp;gt;&amp;gt;&lt;/code&gt;<a name="line.625"></a>
<span class="sourceLineNo">626</span> * &lt;p&gt;<a name="line.626"></a>
<span class="sourceLineNo">627</span> * Note: All other map returning methods make use of this map internally.<a name="line.627"></a>
<span class="sourceLineNo">628</span> * @return map from families to qualifiers to versions<a name="line.628"></a>
<span class="sourceLineNo">629</span> */<a name="line.629"></a>
<span class="sourceLineNo">630</span> public NavigableMap&lt;byte[], NavigableMap&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt;&gt; getMap() {<a name="line.630"></a>
<span class="sourceLineNo">631</span> if (this.familyMap != null) {<a name="line.631"></a>
<span class="sourceLineNo">632</span> return this.familyMap;<a name="line.632"></a>
<span class="sourceLineNo">633</span> }<a name="line.633"></a>
<span class="sourceLineNo">634</span> if(isEmpty()) {<a name="line.634"></a>
<span class="sourceLineNo">635</span> return null;<a name="line.635"></a>
<span class="sourceLineNo">636</span> }<a name="line.636"></a>
<span class="sourceLineNo">637</span> this.familyMap = new TreeMap&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.637"></a>
<span class="sourceLineNo">638</span> for(Cell kv : this.cells) {<a name="line.638"></a>
<span class="sourceLineNo">639</span> byte [] family = CellUtil.cloneFamily(kv);<a name="line.639"></a>
<span class="sourceLineNo">640</span> NavigableMap&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt; columnMap = familyMap.get(family);<a name="line.640"></a>
<span class="sourceLineNo">641</span> if(columnMap == null) {<a name="line.641"></a>
<span class="sourceLineNo">642</span> columnMap = new TreeMap&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.642"></a>
<span class="sourceLineNo">643</span> familyMap.put(family, columnMap);<a name="line.643"></a>
<span class="sourceLineNo">644</span> }<a name="line.644"></a>
<span class="sourceLineNo">645</span> byte [] qualifier = CellUtil.cloneQualifier(kv);<a name="line.645"></a>
<span class="sourceLineNo">646</span> NavigableMap&lt;Long, byte[]&gt; versionMap = columnMap.get(qualifier);<a name="line.646"></a>
<span class="sourceLineNo">647</span> if(versionMap == null) {<a name="line.647"></a>
<span class="sourceLineNo">648</span> versionMap = new TreeMap&lt;&gt;(new Comparator&lt;Long&gt;() {<a name="line.648"></a>
<span class="sourceLineNo">649</span> @Override<a name="line.649"></a>
<span class="sourceLineNo">650</span> public int compare(Long l1, Long l2) {<a name="line.650"></a>
<span class="sourceLineNo">651</span> return l2.compareTo(l1);<a name="line.651"></a>
<span class="sourceLineNo">652</span> }<a name="line.652"></a>
<span class="sourceLineNo">653</span> });<a name="line.653"></a>
<span class="sourceLineNo">654</span> columnMap.put(qualifier, versionMap);<a name="line.654"></a>
<span class="sourceLineNo">655</span> }<a name="line.655"></a>
<span class="sourceLineNo">656</span> Long timestamp = kv.getTimestamp();<a name="line.656"></a>
<span class="sourceLineNo">657</span> byte [] value = CellUtil.cloneValue(kv);<a name="line.657"></a>
<span class="sourceLineNo">658</span><a name="line.658"></a>
<span class="sourceLineNo">659</span> versionMap.put(timestamp, value);<a name="line.659"></a>
<span class="sourceLineNo">660</span> }<a name="line.660"></a>
<span class="sourceLineNo">661</span> return this.familyMap;<a name="line.661"></a>
<span class="sourceLineNo">662</span> }<a name="line.662"></a>
<span class="sourceLineNo">663</span><a name="line.663"></a>
<span class="sourceLineNo">664</span> /**<a name="line.664"></a>
<span class="sourceLineNo">665</span> * Map of families to their most recent qualifiers and values.<a name="line.665"></a>
<span class="sourceLineNo">666</span> * &lt;p&gt;<a name="line.666"></a>
<span class="sourceLineNo">667</span> * Returns a two level Map of the form: &lt;code&gt;Map&amp;amp;family,Map&amp;lt;qualifier,value&amp;gt;&amp;gt;&lt;/code&gt;<a name="line.667"></a>
<span class="sourceLineNo">668</span> * &lt;p&gt;<a name="line.668"></a>
<span class="sourceLineNo">669</span> * The most recent version of each qualifier will be used.<a name="line.669"></a>
<span class="sourceLineNo">670</span> * @return map from families to qualifiers and value<a name="line.670"></a>
<span class="sourceLineNo">671</span> */<a name="line.671"></a>
<span class="sourceLineNo">672</span> public NavigableMap&lt;byte[], NavigableMap&lt;byte[], byte[]&gt;&gt; getNoVersionMap() {<a name="line.672"></a>
<span class="sourceLineNo">673</span> if(this.familyMap == null) {<a name="line.673"></a>
<span class="sourceLineNo">674</span> getMap();<a name="line.674"></a>
<span class="sourceLineNo">675</span> }<a name="line.675"></a>
<span class="sourceLineNo">676</span> if(isEmpty()) {<a name="line.676"></a>
<span class="sourceLineNo">677</span> return null;<a name="line.677"></a>
<span class="sourceLineNo">678</span> }<a name="line.678"></a>
<span class="sourceLineNo">679</span> NavigableMap&lt;byte[], NavigableMap&lt;byte[], byte[]&gt;&gt; returnMap = new TreeMap&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.679"></a>
<span class="sourceLineNo">680</span> for(Map.Entry&lt;byte[], NavigableMap&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt;&gt;<a name="line.680"></a>
<span class="sourceLineNo">681</span> familyEntry : familyMap.entrySet()) {<a name="line.681"></a>
<span class="sourceLineNo">682</span> NavigableMap&lt;byte[], byte[]&gt; qualifierMap = new TreeMap&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.682"></a>
<span class="sourceLineNo">683</span> for(Map.Entry&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt; qualifierEntry :<a name="line.683"></a>
<span class="sourceLineNo">684</span> familyEntry.getValue().entrySet()) {<a name="line.684"></a>
<span class="sourceLineNo">685</span> byte [] value =<a name="line.685"></a>
<span class="sourceLineNo">686</span> qualifierEntry.getValue().get(qualifierEntry.getValue().firstKey());<a name="line.686"></a>
<span class="sourceLineNo">687</span> qualifierMap.put(qualifierEntry.getKey(), value);<a name="line.687"></a>
<span class="sourceLineNo">688</span> }<a name="line.688"></a>
<span class="sourceLineNo">689</span> returnMap.put(familyEntry.getKey(), qualifierMap);<a name="line.689"></a>
<span class="sourceLineNo">690</span> }<a name="line.690"></a>
<span class="sourceLineNo">691</span> return returnMap;<a name="line.691"></a>
<span class="sourceLineNo">692</span> }<a name="line.692"></a>
<span class="sourceLineNo">693</span><a name="line.693"></a>
<span class="sourceLineNo">694</span> /**<a name="line.694"></a>
<span class="sourceLineNo">695</span> * Map of qualifiers to values.<a name="line.695"></a>
<span class="sourceLineNo">696</span> * &lt;p&gt;<a name="line.696"></a>
<span class="sourceLineNo">697</span> * Returns a Map of the form: &lt;code&gt;Map&amp;lt;qualifier,value&amp;gt;&lt;/code&gt;<a name="line.697"></a>
<span class="sourceLineNo">698</span> * @param family column family to get<a name="line.698"></a>
<span class="sourceLineNo">699</span> * @return map of qualifiers to values<a name="line.699"></a>
<span class="sourceLineNo">700</span> */<a name="line.700"></a>
<span class="sourceLineNo">701</span> public NavigableMap&lt;byte[], byte[]&gt; getFamilyMap(byte [] family) {<a name="line.701"></a>
<span class="sourceLineNo">702</span> if(this.familyMap == null) {<a name="line.702"></a>
<span class="sourceLineNo">703</span> getMap();<a name="line.703"></a>
<span class="sourceLineNo">704</span> }<a name="line.704"></a>
<span class="sourceLineNo">705</span> if(isEmpty()) {<a name="line.705"></a>
<span class="sourceLineNo">706</span> return null;<a name="line.706"></a>
<span class="sourceLineNo">707</span> }<a name="line.707"></a>
<span class="sourceLineNo">708</span> NavigableMap&lt;byte[], byte[]&gt; returnMap = new TreeMap&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.708"></a>
<span class="sourceLineNo">709</span> NavigableMap&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt; qualifierMap =<a name="line.709"></a>
<span class="sourceLineNo">710</span> familyMap.get(family);<a name="line.710"></a>
<span class="sourceLineNo">711</span> if(qualifierMap == null) {<a name="line.711"></a>
<span class="sourceLineNo">712</span> return returnMap;<a name="line.712"></a>
<span class="sourceLineNo">713</span> }<a name="line.713"></a>
<span class="sourceLineNo">714</span> for(Map.Entry&lt;byte[], NavigableMap&lt;Long, byte[]&gt;&gt; entry :<a name="line.714"></a>
<span class="sourceLineNo">715</span> qualifierMap.entrySet()) {<a name="line.715"></a>
<span class="sourceLineNo">716</span> byte [] value =<a name="line.716"></a>
<span class="sourceLineNo">717</span> entry.getValue().get(entry.getValue().firstKey());<a name="line.717"></a>
<span class="sourceLineNo">718</span> returnMap.put(entry.getKey(), value);<a name="line.718"></a>
<span class="sourceLineNo">719</span> }<a name="line.719"></a>
<span class="sourceLineNo">720</span> return returnMap;<a name="line.720"></a>
<span class="sourceLineNo">721</span> }<a name="line.721"></a>
<span class="sourceLineNo">722</span><a name="line.722"></a>
<span class="sourceLineNo">723</span> /**<a name="line.723"></a>
<span class="sourceLineNo">724</span> * Returns the value of the first column in the Result.<a name="line.724"></a>
<span class="sourceLineNo">725</span> * @return value of the first column<a name="line.725"></a>
<span class="sourceLineNo">726</span> */<a name="line.726"></a>
<span class="sourceLineNo">727</span> public byte [] value() {<a name="line.727"></a>
<span class="sourceLineNo">728</span> if (isEmpty()) {<a name="line.728"></a>
<span class="sourceLineNo">729</span> return null;<a name="line.729"></a>
<span class="sourceLineNo">730</span> }<a name="line.730"></a>
<span class="sourceLineNo">731</span> return CellUtil.cloneValue(cells[0]);<a name="line.731"></a>
<span class="sourceLineNo">732</span> }<a name="line.732"></a>
<span class="sourceLineNo">733</span><a name="line.733"></a>
<span class="sourceLineNo">734</span> /**<a name="line.734"></a>
<span class="sourceLineNo">735</span> * Check if the underlying Cell [] is empty or not<a name="line.735"></a>
<span class="sourceLineNo">736</span> * @return true if empty<a name="line.736"></a>
<span class="sourceLineNo">737</span> */<a name="line.737"></a>
<span class="sourceLineNo">738</span> public boolean isEmpty() {<a name="line.738"></a>
<span class="sourceLineNo">739</span> return this.cells == null || this.cells.length == 0;<a name="line.739"></a>
<span class="sourceLineNo">740</span> }<a name="line.740"></a>
<span class="sourceLineNo">741</span><a name="line.741"></a>
<span class="sourceLineNo">742</span> /**<a name="line.742"></a>
<span class="sourceLineNo">743</span> * @return the size of the underlying Cell []<a name="line.743"></a>
<span class="sourceLineNo">744</span> */<a name="line.744"></a>
<span class="sourceLineNo">745</span> public int size() {<a name="line.745"></a>
<span class="sourceLineNo">746</span> return this.cells == null? 0: this.cells.length;<a name="line.746"></a>
<span class="sourceLineNo">747</span> }<a name="line.747"></a>
<span class="sourceLineNo">748</span><a name="line.748"></a>
<span class="sourceLineNo">749</span> /**<a name="line.749"></a>
<span class="sourceLineNo">750</span> * @return String<a name="line.750"></a>
<span class="sourceLineNo">751</span> */<a name="line.751"></a>
<span class="sourceLineNo">752</span> @Override<a name="line.752"></a>
<span class="sourceLineNo">753</span> public String toString() {<a name="line.753"></a>
<span class="sourceLineNo">754</span> StringBuilder sb = new StringBuilder();<a name="line.754"></a>
<span class="sourceLineNo">755</span> sb.append("keyvalues=");<a name="line.755"></a>
<span class="sourceLineNo">756</span> if(isEmpty()) {<a name="line.756"></a>
<span class="sourceLineNo">757</span> sb.append("NONE");<a name="line.757"></a>
<span class="sourceLineNo">758</span> return sb.toString();<a name="line.758"></a>
<span class="sourceLineNo">759</span> }<a name="line.759"></a>
<span class="sourceLineNo">760</span> sb.append("{");<a name="line.760"></a>
<span class="sourceLineNo">761</span> boolean moreThanOne = false;<a name="line.761"></a>
<span class="sourceLineNo">762</span> for(Cell kv : this.cells) {<a name="line.762"></a>
<span class="sourceLineNo">763</span> if(moreThanOne) {<a name="line.763"></a>
<span class="sourceLineNo">764</span> sb.append(", ");<a name="line.764"></a>
<span class="sourceLineNo">765</span> } else {<a name="line.765"></a>
<span class="sourceLineNo">766</span> moreThanOne = true;<a name="line.766"></a>
<span class="sourceLineNo">767</span> }<a name="line.767"></a>
<span class="sourceLineNo">768</span> sb.append(kv.toString());<a name="line.768"></a>
<span class="sourceLineNo">769</span> }<a name="line.769"></a>
<span class="sourceLineNo">770</span> sb.append("}");<a name="line.770"></a>
<span class="sourceLineNo">771</span> return sb.toString();<a name="line.771"></a>
<span class="sourceLineNo">772</span> }<a name="line.772"></a>
<span class="sourceLineNo">773</span><a name="line.773"></a>
<span class="sourceLineNo">774</span> /**<a name="line.774"></a>
<span class="sourceLineNo">775</span> * Does a deep comparison of two Results, down to the byte arrays.<a name="line.775"></a>
<span class="sourceLineNo">776</span> * @param res1 first result to compare<a name="line.776"></a>
<span class="sourceLineNo">777</span> * @param res2 second result to compare<a name="line.777"></a>
<span class="sourceLineNo">778</span> * @throws Exception Every difference is throwing an exception<a name="line.778"></a>
<span class="sourceLineNo">779</span> */<a name="line.779"></a>
<span class="sourceLineNo">780</span> public static void compareResults(Result res1, Result res2)<a name="line.780"></a>
<span class="sourceLineNo">781</span> throws Exception {<a name="line.781"></a>
<span class="sourceLineNo">782</span> if (res2 == null) {<a name="line.782"></a>
<span class="sourceLineNo">783</span> throw new Exception("There wasn't enough rows, we stopped at "<a name="line.783"></a>
<span class="sourceLineNo">784</span> + Bytes.toStringBinary(res1.getRow()));<a name="line.784"></a>
<span class="sourceLineNo">785</span> }<a name="line.785"></a>
<span class="sourceLineNo">786</span> if (res1.size() != res2.size()) {<a name="line.786"></a>
<span class="sourceLineNo">787</span> throw new Exception("This row doesn't have the same number of KVs: "<a name="line.787"></a>
<span class="sourceLineNo">788</span> + res1.toString() + " compared to " + res2.toString());<a name="line.788"></a>
<span class="sourceLineNo">789</span> }<a name="line.789"></a>
<span class="sourceLineNo">790</span> Cell[] ourKVs = res1.rawCells();<a name="line.790"></a>
<span class="sourceLineNo">791</span> Cell[] replicatedKVs = res2.rawCells();<a name="line.791"></a>
<span class="sourceLineNo">792</span> for (int i = 0; i &lt; res1.size(); i++) {<a name="line.792"></a>
<span class="sourceLineNo">793</span> if (!ourKVs[i].equals(replicatedKVs[i]) ||<a name="line.793"></a>
<span class="sourceLineNo">794</span> !CellUtil.matchingValue(ourKVs[i], replicatedKVs[i]) ||<a name="line.794"></a>
<span class="sourceLineNo">795</span> !CellUtil.matchingTags(ourKVs[i], replicatedKVs[i])) {<a name="line.795"></a>
<span class="sourceLineNo">796</span> throw new Exception("This result was different: "<a name="line.796"></a>
<span class="sourceLineNo">797</span> + res1.toString() + " compared to " + res2.toString());<a name="line.797"></a>
<span class="sourceLineNo">798</span> }<a name="line.798"></a>
<span class="sourceLineNo">799</span> }<a name="line.799"></a>
<span class="sourceLineNo">800</span> }<a name="line.800"></a>
<span class="sourceLineNo">801</span><a name="line.801"></a>
<span class="sourceLineNo">802</span> /**<a name="line.802"></a>
<span class="sourceLineNo">803</span> * Forms a single result from the partial results in the partialResults list. This method is<a name="line.803"></a>
<span class="sourceLineNo">804</span> * useful for reconstructing partial results on the client side.<a name="line.804"></a>
<span class="sourceLineNo">805</span> * @param partialResults list of partial results<a name="line.805"></a>
<span class="sourceLineNo">806</span> * @return The complete result that is formed by combining all of the partial results together<a name="line.806"></a>
<span class="sourceLineNo">807</span> * @throws IOException A complete result cannot be formed because the results in the partial list<a name="line.807"></a>
<span class="sourceLineNo">808</span> * come from different rows<a name="line.808"></a>
<span class="sourceLineNo">809</span> */<a name="line.809"></a>
<span class="sourceLineNo">810</span> public static Result createCompleteResult(Iterable&lt;Result&gt; partialResults)<a name="line.810"></a>
<span class="sourceLineNo">811</span> throws IOException {<a name="line.811"></a>
<span class="sourceLineNo">812</span> if (partialResults == null) {<a name="line.812"></a>
<span class="sourceLineNo">813</span> return Result.create(Collections.emptyList(), null, false);<a name="line.813"></a>
<span class="sourceLineNo">814</span> }<a name="line.814"></a>
<span class="sourceLineNo">815</span> List&lt;Cell&gt; cells = new ArrayList&lt;&gt;();<a name="line.815"></a>
<span class="sourceLineNo">816</span> boolean stale = false;<a name="line.816"></a>
<span class="sourceLineNo">817</span> byte[] prevRow = null;<a name="line.817"></a>
<span class="sourceLineNo">818</span> byte[] currentRow = null;<a name="line.818"></a>
<span class="sourceLineNo">819</span> for (Iterator&lt;Result&gt; iter = partialResults.iterator(); iter.hasNext();) {<a name="line.819"></a>
<span class="sourceLineNo">820</span> Result r = iter.next();<a name="line.820"></a>
<span class="sourceLineNo">821</span> currentRow = r.getRow();<a name="line.821"></a>
<span class="sourceLineNo">822</span> if (prevRow != null &amp;&amp; !Bytes.equals(prevRow, currentRow)) {<a name="line.822"></a>
<span class="sourceLineNo">823</span> throw new IOException(<a name="line.823"></a>
<span class="sourceLineNo">824</span> "Cannot form complete result. Rows of partial results do not match." +<a name="line.824"></a>
<span class="sourceLineNo">825</span> " Partial Results: " + partialResults);<a name="line.825"></a>
<span class="sourceLineNo">826</span> }<a name="line.826"></a>
<span class="sourceLineNo">827</span> // Ensure that all Results except the last one are marked as partials. The last result<a name="line.827"></a>
<span class="sourceLineNo">828</span> // may not be marked as a partial because Results are only marked as partials when<a name="line.828"></a>
<span class="sourceLineNo">829</span> // the scan on the server side must be stopped due to reaching the maxResultSize.<a name="line.829"></a>
<span class="sourceLineNo">830</span> // Visualizing it makes it easier to understand:<a name="line.830"></a>
<span class="sourceLineNo">831</span> // maxResultSize: 2 cells<a name="line.831"></a>
<span class="sourceLineNo">832</span> // (-x-) represents cell number x in a row<a name="line.832"></a>
<span class="sourceLineNo">833</span> // Example: row1: -1- -2- -3- -4- -5- (5 cells total)<a name="line.833"></a>
<span class="sourceLineNo">834</span> // How row1 will be returned by the server as partial Results:<a name="line.834"></a>
<span class="sourceLineNo">835</span> // Result1: -1- -2- (2 cells, size limit reached, mark as partial)<a name="line.835"></a>
<span class="sourceLineNo">836</span> // Result2: -3- -4- (2 cells, size limit reached, mark as partial)<a name="line.836"></a>
<span class="sourceLineNo">837</span> // Result3: -5- (1 cell, size limit NOT reached, NOT marked as partial)<a name="line.837"></a>
<span class="sourceLineNo">838</span> if (iter.hasNext() &amp;&amp; !r.mayHaveMoreCellsInRow()) {<a name="line.838"></a>
<span class="sourceLineNo">839</span> throw new IOException("Cannot form complete result. Result is missing partial flag. " +<a name="line.839"></a>
<span class="sourceLineNo">840</span> "Partial Results: " + partialResults);<a name="line.840"></a>
<span class="sourceLineNo">841</span> }<a name="line.841"></a>
<span class="sourceLineNo">842</span> prevRow = currentRow;<a name="line.842"></a>
<span class="sourceLineNo">843</span> stale = stale || r.isStale();<a name="line.843"></a>
<span class="sourceLineNo">844</span> for (Cell c : r.rawCells()) {<a name="line.844"></a>
<span class="sourceLineNo">845</span> cells.add(c);<a name="line.845"></a>
<span class="sourceLineNo">846</span> }<a name="line.846"></a>
<span class="sourceLineNo">847</span> }<a name="line.847"></a>
<span class="sourceLineNo">848</span><a name="line.848"></a>
<span class="sourceLineNo">849</span> return Result.create(cells, null, stale);<a name="line.849"></a>
<span class="sourceLineNo">850</span> }<a name="line.850"></a>
<span class="sourceLineNo">851</span><a name="line.851"></a>
<span class="sourceLineNo">852</span> /**<a name="line.852"></a>
<span class="sourceLineNo">853</span> * Get total size of raw cells<a name="line.853"></a>
<span class="sourceLineNo">854</span> * @param result<a name="line.854"></a>
<span class="sourceLineNo">855</span> * @return Total size.<a name="line.855"></a>
<span class="sourceLineNo">856</span> */<a name="line.856"></a>
<span class="sourceLineNo">857</span> public static long getTotalSizeOfCells(Result result) {<a name="line.857"></a>
<span class="sourceLineNo">858</span> long size = 0;<a name="line.858"></a>
<span class="sourceLineNo">859</span> if (result.isEmpty()) {<a name="line.859"></a>
<span class="sourceLineNo">860</span> return size;<a name="line.860"></a>
<span class="sourceLineNo">861</span> }<a name="line.861"></a>
<span class="sourceLineNo">862</span> for (Cell c : result.rawCells()) {<a name="line.862"></a>
<span class="sourceLineNo">863</span> size += c.heapSize();<a name="line.863"></a>
<span class="sourceLineNo">864</span> }<a name="line.864"></a>
<span class="sourceLineNo">865</span> return size;<a name="line.865"></a>
<span class="sourceLineNo">866</span> }<a name="line.866"></a>
<span class="sourceLineNo">867</span><a name="line.867"></a>
<span class="sourceLineNo">868</span> /**<a name="line.868"></a>
<span class="sourceLineNo">869</span> * Copy another Result into this one. Needed for the old Mapred framework<a name="line.869"></a>
<span class="sourceLineNo">870</span> * @throws UnsupportedOperationException if invoked on instance of EMPTY_RESULT<a name="line.870"></a>
<span class="sourceLineNo">871</span> * (which is supposed to be immutable).<a name="line.871"></a>
<span class="sourceLineNo">872</span> * @param other<a name="line.872"></a>
<span class="sourceLineNo">873</span> */<a name="line.873"></a>
<span class="sourceLineNo">874</span> public void copyFrom(Result other) {<a name="line.874"></a>
<span class="sourceLineNo">875</span> checkReadonly();<a name="line.875"></a>
<span class="sourceLineNo">876</span> this.row = null;<a name="line.876"></a>
<span class="sourceLineNo">877</span> this.familyMap = null;<a name="line.877"></a>
<span class="sourceLineNo">878</span> this.cells = other.cells;<a name="line.878"></a>
<span class="sourceLineNo">879</span> }<a name="line.879"></a>
<span class="sourceLineNo">880</span><a name="line.880"></a>
<span class="sourceLineNo">881</span> @Override<a name="line.881"></a>
<span class="sourceLineNo">882</span> public CellScanner cellScanner() {<a name="line.882"></a>
<span class="sourceLineNo">883</span> // Reset<a name="line.883"></a>
<span class="sourceLineNo">884</span> this.cellScannerIndex = INITIAL_CELLSCANNER_INDEX;<a name="line.884"></a>
<span class="sourceLineNo">885</span> return this;<a name="line.885"></a>
<span class="sourceLineNo">886</span> }<a name="line.886"></a>
<span class="sourceLineNo">887</span><a name="line.887"></a>
<span class="sourceLineNo">888</span> @Override<a name="line.888"></a>
<span class="sourceLineNo">889</span> public Cell current() {<a name="line.889"></a>
<span class="sourceLineNo">890</span> if (cells == null<a name="line.890"></a>
<span class="sourceLineNo">891</span> || cellScannerIndex == INITIAL_CELLSCANNER_INDEX<a name="line.891"></a>
<span class="sourceLineNo">892</span> || cellScannerIndex &gt;= cells.length)<a name="line.892"></a>
<span class="sourceLineNo">893</span> return null;<a name="line.893"></a>
<span class="sourceLineNo">894</span> return this.cells[cellScannerIndex];<a name="line.894"></a>
<span class="sourceLineNo">895</span> }<a name="line.895"></a>
<span class="sourceLineNo">896</span><a name="line.896"></a>
<span class="sourceLineNo">897</span> @Override<a name="line.897"></a>
<span class="sourceLineNo">898</span> public boolean advance() {<a name="line.898"></a>
<span class="sourceLineNo">899</span> if (cells == null) return false;<a name="line.899"></a>
<span class="sourceLineNo">900</span> cellScannerIndex++;<a name="line.900"></a>
<span class="sourceLineNo">901</span> if (cellScannerIndex &lt; this.cells.length) {<a name="line.901"></a>
<span class="sourceLineNo">902</span> return true;<a name="line.902"></a>
<span class="sourceLineNo">903</span> } else if (cellScannerIndex == this.cells.length) {<a name="line.903"></a>
<span class="sourceLineNo">904</span> return false;<a name="line.904"></a>
<span class="sourceLineNo">905</span> }<a name="line.905"></a>
<span class="sourceLineNo">906</span> throw new NoSuchElementException("Cannot advance beyond the last cell");<a name="line.906"></a>
<span class="sourceLineNo">907</span> }<a name="line.907"></a>
<span class="sourceLineNo">908</span><a name="line.908"></a>
<span class="sourceLineNo">909</span> public Boolean getExists() {<a name="line.909"></a>
<span class="sourceLineNo">910</span> return exists;<a name="line.910"></a>
<span class="sourceLineNo">911</span> }<a name="line.911"></a>
<span class="sourceLineNo">912</span><a name="line.912"></a>
<span class="sourceLineNo">913</span> public void setExists(Boolean exists) {<a name="line.913"></a>
<span class="sourceLineNo">914</span> checkReadonly();<a name="line.914"></a>
<span class="sourceLineNo">915</span> this.exists = exists;<a name="line.915"></a>
<span class="sourceLineNo">916</span> }<a name="line.916"></a>
<span class="sourceLineNo">917</span><a name="line.917"></a>
<span class="sourceLineNo">918</span> /**<a name="line.918"></a>
<span class="sourceLineNo">919</span> * Whether or not the results are coming from possibly stale data. Stale results<a name="line.919"></a>
<span class="sourceLineNo">920</span> * might be returned if {@link Consistency} is not STRONG for the query.<a name="line.920"></a>
<span class="sourceLineNo">921</span> * @return Whether or not the results are coming from possibly stale data.<a name="line.921"></a>
<span class="sourceLineNo">922</span> */<a name="line.922"></a>
<span class="sourceLineNo">923</span> public boolean isStale() {<a name="line.923"></a>
<span class="sourceLineNo">924</span> return stale;<a name="line.924"></a>
<span class="sourceLineNo">925</span> }<a name="line.925"></a>
<span class="sourceLineNo">926</span><a name="line.926"></a>
<span class="sourceLineNo">927</span> /**<a name="line.927"></a>
<span class="sourceLineNo">928</span> * For scanning large rows, the RS may choose to return the cells chunk by chunk to prevent OOM<a name="line.928"></a>
<span class="sourceLineNo">929</span> * or timeout. This flag is used to tell you if the current Result is the last one of the current<a name="line.929"></a>
<span class="sourceLineNo">930</span> * row. False means this Result is the last one. True means there MAY be more cells belonging to<a name="line.930"></a>
<span class="sourceLineNo">931</span> * the current row.<a name="line.931"></a>
<span class="sourceLineNo">932</span> * If you don't use {@link Scan#setAllowPartialResults(boolean)} or {@link Scan#setBatch(int)},<a name="line.932"></a>
<span class="sourceLineNo">933</span> * this method will always return false because the Result must contains all cells in one Row.<a name="line.933"></a>
<span class="sourceLineNo">934</span> */<a name="line.934"></a>
<span class="sourceLineNo">935</span> public boolean mayHaveMoreCellsInRow() {<a name="line.935"></a>
<span class="sourceLineNo">936</span> return mayHaveMoreCellsInRow;<a name="line.936"></a>
<span class="sourceLineNo">937</span> }<a name="line.937"></a>
<span class="sourceLineNo">938</span><a name="line.938"></a>
<span class="sourceLineNo">939</span> /**<a name="line.939"></a>
<span class="sourceLineNo">940</span> * Set load information about the region to the information about the result<a name="line.940"></a>
<span class="sourceLineNo">941</span> * @param loadStats statistics about the current region from which this was returned<a name="line.941"></a>
<span class="sourceLineNo">942</span> */<a name="line.942"></a>
<span class="sourceLineNo">943</span> @InterfaceAudience.Private<a name="line.943"></a>
<span class="sourceLineNo">944</span> public void setStatistics(RegionLoadStats loadStats) {<a name="line.944"></a>
<span class="sourceLineNo">945</span> this.stats = loadStats;<a name="line.945"></a>
<span class="sourceLineNo">946</span> }<a name="line.946"></a>
<span class="sourceLineNo">947</span><a name="line.947"></a>
<span class="sourceLineNo">948</span> /**<a name="line.948"></a>
<span class="sourceLineNo">949</span> * @return the associated statistics about the region from which this was returned. Can be<a name="line.949"></a>
<span class="sourceLineNo">950</span> * &lt;tt&gt;null&lt;/tt&gt; if stats are disabled.<a name="line.950"></a>
<span class="sourceLineNo">951</span> */<a name="line.951"></a>
<span class="sourceLineNo">952</span> public RegionLoadStats getStats() {<a name="line.952"></a>
<span class="sourceLineNo">953</span> return stats;<a name="line.953"></a>
<span class="sourceLineNo">954</span> }<a name="line.954"></a>
<span class="sourceLineNo">955</span><a name="line.955"></a>
<span class="sourceLineNo">956</span> /**<a name="line.956"></a>
<span class="sourceLineNo">957</span> * All methods modifying state of Result object must call this method<a name="line.957"></a>
<span class="sourceLineNo">958</span> * to ensure that special purpose immutable Results can't be accidentally modified.<a name="line.958"></a>
<span class="sourceLineNo">959</span> */<a name="line.959"></a>
<span class="sourceLineNo">960</span> private void checkReadonly() {<a name="line.960"></a>
<span class="sourceLineNo">961</span> if (readonly == true) {<a name="line.961"></a>
<span class="sourceLineNo">962</span> throw new UnsupportedOperationException("Attempting to modify readonly EMPTY_RESULT!");<a name="line.962"></a>
<span class="sourceLineNo">963</span> }<a name="line.963"></a>
<span class="sourceLineNo">964</span> }<a name="line.964"></a>
<span class="sourceLineNo">965</span><a name="line.965"></a>
<span class="sourceLineNo">966</span> /**<a name="line.966"></a>
<span class="sourceLineNo">967</span> * Return true if this Result is a cursor to tell users where the server has scanned.<a name="line.967"></a>
<span class="sourceLineNo">968</span> * In this Result the only meaningful method is {@link #getCursor()}.<a name="line.968"></a>
<span class="sourceLineNo">969</span> *<a name="line.969"></a>
<span class="sourceLineNo">970</span> * {@code<a name="line.970"></a>
<span class="sourceLineNo">971</span> * while (r = scanner.next() &amp;&amp; r != null) {<a name="line.971"></a>
<span class="sourceLineNo">972</span> * if(r.isCursor()){<a name="line.972"></a>
<span class="sourceLineNo">973</span> * // scanning is not end, it is a cursor, save its row key and close scanner if you want, or<a name="line.973"></a>
<span class="sourceLineNo">974</span> * // just continue the loop to call next().<a name="line.974"></a>
<span class="sourceLineNo">975</span> * } else {<a name="line.975"></a>
<span class="sourceLineNo">976</span> * // just like before<a name="line.976"></a>
<span class="sourceLineNo">977</span> * }<a name="line.977"></a>
<span class="sourceLineNo">978</span> * }<a name="line.978"></a>
<span class="sourceLineNo">979</span> * // scanning is end<a name="line.979"></a>
<span class="sourceLineNo">980</span> *<a name="line.980"></a>
<span class="sourceLineNo">981</span> * }<a name="line.981"></a>
<span class="sourceLineNo">982</span> * {@link Scan#setNeedCursorResult(boolean)}<a name="line.982"></a>
<span class="sourceLineNo">983</span> * {@link Cursor}<a name="line.983"></a>
<span class="sourceLineNo">984</span> * {@link #getCursor()}<a name="line.984"></a>
<span class="sourceLineNo">985</span> */<a name="line.985"></a>
<span class="sourceLineNo">986</span> public boolean isCursor() {<a name="line.986"></a>
<span class="sourceLineNo">987</span> return cursor != null ;<a name="line.987"></a>
<span class="sourceLineNo">988</span> }<a name="line.988"></a>
<span class="sourceLineNo">989</span><a name="line.989"></a>
<span class="sourceLineNo">990</span> /**<a name="line.990"></a>
<span class="sourceLineNo">991</span> * Return the cursor if this Result is a cursor result.<a name="line.991"></a>
<span class="sourceLineNo">992</span> * {@link Scan#setNeedCursorResult(boolean)}<a name="line.992"></a>
<span class="sourceLineNo">993</span> * {@link Cursor}<a name="line.993"></a>
<span class="sourceLineNo">994</span> * {@link #isCursor()}<a name="line.994"></a>
<span class="sourceLineNo">995</span> */<a name="line.995"></a>
<span class="sourceLineNo">996</span> public Cursor getCursor(){<a name="line.996"></a>
<span class="sourceLineNo">997</span> return cursor;<a name="line.997"></a>
<span class="sourceLineNo">998</span> }<a name="line.998"></a>
<span class="sourceLineNo">999</span>}<a name="line.999"></a>
</pre>
</div>
</body>
</html>