blob: f35fef1e528434ce0ed0b1eaddef5b7311254867 [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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.nio.ByteBuffer;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.HashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.NavigableSet;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Set;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.TreeMap;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.TreeSet;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HConstants;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.io.TimeRange;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.security.access.Permission;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.security.visibility.Authorizations;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.Logger;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.LoggerFactory;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Used to perform Get operations on a single row.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * To get everything for a row, instantiate a Get object with the row to get. To further narrow the<a name="line.43"></a>
<span class="sourceLineNo">044</span> * scope of what to Get, use the methods below.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * To get all columns from specific families, execute {@link #addFamily(byte[]) addFamily} for each<a name="line.46"></a>
<span class="sourceLineNo">047</span> * family to retrieve.<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * To get specific columns, execute {@link #addColumn(byte[], byte[]) addColumn} for each column to<a name="line.49"></a>
<span class="sourceLineNo">050</span> * retrieve.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * To only retrieve columns within a specific range of version timestamps, execute<a name="line.52"></a>
<span class="sourceLineNo">053</span> * {@link #setTimeRange(long, long) setTimeRange}.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;p&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * To only retrieve columns with a specific timestamp, execute {@link #setTimestamp(long)<a name="line.55"></a>
<span class="sourceLineNo">056</span> * setTimestamp}.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * To limit the number of versions of each column to be returned, execute {@link #readVersions(int)<a name="line.58"></a>
<span class="sourceLineNo">059</span> * readVersions}.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * To add a filter, call {@link #setFilter(Filter) setFilter}.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span>@InterfaceAudience.Public<a name="line.63"></a>
<span class="sourceLineNo">064</span>public class Get extends Query implements Row {<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static final Logger LOG = LoggerFactory.getLogger(Get.class);<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private byte[] row = null;<a name="line.67"></a>
<span class="sourceLineNo">068</span> private int maxVersions = 1;<a name="line.68"></a>
<span class="sourceLineNo">069</span> private boolean cacheBlocks = true;<a name="line.69"></a>
<span class="sourceLineNo">070</span> private int storeLimit = -1;<a name="line.70"></a>
<span class="sourceLineNo">071</span> private int storeOffset = 0;<a name="line.71"></a>
<span class="sourceLineNo">072</span> private TimeRange tr = TimeRange.allTime();<a name="line.72"></a>
<span class="sourceLineNo">073</span> private boolean checkExistenceOnly = false;<a name="line.73"></a>
<span class="sourceLineNo">074</span> private Map&lt;byte[], NavigableSet&lt;byte[]&gt;&gt; familyMap = new TreeMap&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Create a Get operation for the specified row.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * &lt;p&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span> * If no further operations are done, this will get the latest version of all columns in all<a name="line.79"></a>
<span class="sourceLineNo">080</span> * families of the specified row.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @param row row key<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> public Get(byte[] row) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> Mutation.checkRow(row);<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.row = row;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<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> * Copy-constructor n<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> public Get(Get get) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> this(get.getRow());<a name="line.92"></a>
<span class="sourceLineNo">093</span> // from Query<a name="line.93"></a>
<span class="sourceLineNo">094</span> this.setFilter(get.getFilter());<a name="line.94"></a>
<span class="sourceLineNo">095</span> this.setReplicaId(get.getReplicaId());<a name="line.95"></a>
<span class="sourceLineNo">096</span> this.setConsistency(get.getConsistency());<a name="line.96"></a>
<span class="sourceLineNo">097</span> // from Get<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.cacheBlocks = get.getCacheBlocks();<a name="line.98"></a>
<span class="sourceLineNo">099</span> this.maxVersions = get.getMaxVersions();<a name="line.99"></a>
<span class="sourceLineNo">100</span> this.storeLimit = get.getMaxResultsPerColumnFamily();<a name="line.100"></a>
<span class="sourceLineNo">101</span> this.storeOffset = get.getRowOffsetPerColumnFamily();<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.tr = get.getTimeRange();<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.checkExistenceOnly = get.isCheckExistenceOnly();<a name="line.103"></a>
<span class="sourceLineNo">104</span> this.loadColumnFamiliesOnDemand = get.getLoadColumnFamiliesOnDemandValue();<a name="line.104"></a>
<span class="sourceLineNo">105</span> Map&lt;byte[], NavigableSet&lt;byte[]&gt;&gt; fams = get.getFamilyMap();<a name="line.105"></a>
<span class="sourceLineNo">106</span> for (Map.Entry&lt;byte[], NavigableSet&lt;byte[]&gt;&gt; entry : fams.entrySet()) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> byte[] fam = entry.getKey();<a name="line.107"></a>
<span class="sourceLineNo">108</span> NavigableSet&lt;byte[]&gt; cols = entry.getValue();<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (cols != null &amp;&amp; cols.size() &gt; 0) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> for (byte[] col : cols) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> addColumn(fam, col);<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else {<a name="line.113"></a>
<span class="sourceLineNo">114</span> addFamily(fam);<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> for (Map.Entry&lt;String, byte[]&gt; attr : get.getAttributesMap().entrySet()) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> for (Map.Entry&lt;byte[], TimeRange&gt; entry : get.getColumnFamilyTimeRange().entrySet()) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> TimeRange tr = entry.getValue();<a name="line.121"></a>
<span class="sourceLineNo">122</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> super.setPriority(get.getPriority());<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> /**<a name="line.127"></a>
<span class="sourceLineNo">128</span> * Create a Get operation for the specified row. nnn<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> public Get(byte[] row, int rowOffset, int rowLength) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> Mutation.checkRow(row, rowOffset, rowLength);<a name="line.131"></a>
<span class="sourceLineNo">132</span> this.row = Bytes.copy(row, rowOffset, rowLength);<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> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Create a Get operation for the specified row. n<a name="line.136"></a>
<span class="sourceLineNo">137</span> */<a name="line.137"></a>
<span class="sourceLineNo">138</span> public Get(ByteBuffer row) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> Mutation.checkRow(row);<a name="line.139"></a>
<span class="sourceLineNo">140</span> this.row = new byte[row.remaining()];<a name="line.140"></a>
<span class="sourceLineNo">141</span> row.get(this.row);<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> public boolean isCheckExistenceOnly() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> return checkExistenceOnly;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> public Get setCheckExistenceOnly(boolean checkExistenceOnly) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> this.checkExistenceOnly = checkExistenceOnly;<a name="line.149"></a>
<span class="sourceLineNo">150</span> return this;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> /**<a name="line.153"></a>
<span class="sourceLineNo">154</span> * Get all columns from the specified family.<a name="line.154"></a>
<span class="sourceLineNo">155</span> * &lt;p&gt;<a name="line.155"></a>
<span class="sourceLineNo">156</span> * Overrides previous calls to addColumn for this family.<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @param family family name<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @return the Get object<a name="line.158"></a>
<span class="sourceLineNo">159</span> */<a name="line.159"></a>
<span class="sourceLineNo">160</span> public Get addFamily(byte[] family) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> familyMap.remove(family);<a name="line.161"></a>
<span class="sourceLineNo">162</span> familyMap.put(family, null);<a name="line.162"></a>
<span class="sourceLineNo">163</span> return this;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * Get the column from the specific family with the specified qualifier.<a name="line.167"></a>
<span class="sourceLineNo">168</span> * &lt;p&gt;<a name="line.168"></a>
<span class="sourceLineNo">169</span> * Overrides previous calls to addFamily for this family.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @param family family name<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param qualifier column qualifier<a name="line.171"></a>
<span class="sourceLineNo">172</span> * @return the Get objec<a name="line.172"></a>
<span class="sourceLineNo">173</span> */<a name="line.173"></a>
<span class="sourceLineNo">174</span> public Get addColumn(byte[] family, byte[] qualifier) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> NavigableSet&lt;byte[]&gt; set = familyMap.get(family);<a name="line.175"></a>
<span class="sourceLineNo">176</span> if (set == null) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> set = new TreeSet&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.177"></a>
<span class="sourceLineNo">178</span> familyMap.put(family, set);<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> if (qualifier == null) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> qualifier = HConstants.EMPTY_BYTE_ARRAY;<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> set.add(qualifier);<a name="line.183"></a>
<span class="sourceLineNo">184</span> return this;<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> /**<a name="line.187"></a>
<span class="sourceLineNo">188</span> * Get versions of columns only within the specified timestamp range, [minStamp, maxStamp).<a name="line.188"></a>
<span class="sourceLineNo">189</span> * @param minStamp minimum timestamp value, inclusive<a name="line.189"></a>
<span class="sourceLineNo">190</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.190"></a>
<span class="sourceLineNo">191</span> * @return this for invocation chaining<a name="line.191"></a>
<span class="sourceLineNo">192</span> */<a name="line.192"></a>
<span class="sourceLineNo">193</span> public Get setTimeRange(long minStamp, long maxStamp) throws IOException {<a name="line.193"></a>
<span class="sourceLineNo">194</span> tr = TimeRange.between(minStamp, maxStamp);<a name="line.194"></a>
<span class="sourceLineNo">195</span> return this;<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> * Get versions of columns with the specified timestamp.<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @param timestamp version timestamp<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @return this for invocation chaining<a name="line.201"></a>
<span class="sourceLineNo">202</span> */<a name="line.202"></a>
<span class="sourceLineNo">203</span> public Get setTimestamp(long timestamp) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> try {<a name="line.204"></a>
<span class="sourceLineNo">205</span> tr = TimeRange.at(timestamp);<a name="line.205"></a>
<span class="sourceLineNo">206</span> } catch (Exception e) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> // This should never happen, unless integer overflow or something extremely wrong...<a name="line.207"></a>
<span class="sourceLineNo">208</span> LOG.error("TimeRange failed, likely caused by integer overflow. ", e);<a name="line.208"></a>
<span class="sourceLineNo">209</span> throw e;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span> return this;<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> @Override<a name="line.214"></a>
<span class="sourceLineNo">215</span> public Get setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.215"></a>
<span class="sourceLineNo">216</span> return (Get) super.setColumnFamilyTimeRange(cf, minStamp, maxStamp);<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span> /**<a name="line.219"></a>
<span class="sourceLineNo">220</span> * Get all available versions.<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @return this for invocation chaining<a name="line.221"></a>
<span class="sourceLineNo">222</span> */<a name="line.222"></a>
<span class="sourceLineNo">223</span> public Get readAllVersions() {<a name="line.223"></a>
<span class="sourceLineNo">224</span> this.maxVersions = Integer.MAX_VALUE;<a name="line.224"></a>
<span class="sourceLineNo">225</span> return this;<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span> /**<a name="line.228"></a>
<span class="sourceLineNo">229</span> * Get up to the specified number of versions of each column.<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @param versions specified number of versions for each column<a name="line.230"></a>
<span class="sourceLineNo">231</span> * @throws IOException if invalid number of versions<a name="line.231"></a>
<span class="sourceLineNo">232</span> * @return this for invocation chaining<a name="line.232"></a>
<span class="sourceLineNo">233</span> */<a name="line.233"></a>
<span class="sourceLineNo">234</span> public Get readVersions(int versions) throws IOException {<a name="line.234"></a>
<span class="sourceLineNo">235</span> if (versions &lt;= 0) {<a name="line.235"></a>
<span class="sourceLineNo">236</span> throw new IOException("versions must be positive");<a name="line.236"></a>
<span class="sourceLineNo">237</span> }<a name="line.237"></a>
<span class="sourceLineNo">238</span> this.maxVersions = versions;<a name="line.238"></a>
<span class="sourceLineNo">239</span> return this;<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> @Override<a name="line.242"></a>
<span class="sourceLineNo">243</span> public Get setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.243"></a>
<span class="sourceLineNo">244</span> return (Get) super.setLoadColumnFamiliesOnDemand(value);<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> * Set the maximum number of values to return per row per Column Family<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @param limit the maximum number of values returned / row / CF<a name="line.249"></a>
<span class="sourceLineNo">250</span> * @return this for invocation chaining<a name="line.250"></a>
<span class="sourceLineNo">251</span> */<a name="line.251"></a>
<span class="sourceLineNo">252</span> public Get setMaxResultsPerColumnFamily(int limit) {<a name="line.252"></a>
<span class="sourceLineNo">253</span> this.storeLimit = limit;<a name="line.253"></a>
<span class="sourceLineNo">254</span> return this;<a name="line.254"></a>
<span class="sourceLineNo">255</span> }<a name="line.255"></a>
<span class="sourceLineNo">256</span><a name="line.256"></a>
<span class="sourceLineNo">257</span> /**<a name="line.257"></a>
<span class="sourceLineNo">258</span> * Set offset for the row per Column Family. This offset is only within a particular row/CF<a name="line.258"></a>
<span class="sourceLineNo">259</span> * combination. It gets reset back to zero when we move to the next row or CF.<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @param offset is the number of kvs that will be skipped.<a name="line.260"></a>
<span class="sourceLineNo">261</span> * @return this for invocation chaining<a name="line.261"></a>
<span class="sourceLineNo">262</span> */<a name="line.262"></a>
<span class="sourceLineNo">263</span> public Get setRowOffsetPerColumnFamily(int offset) {<a name="line.263"></a>
<span class="sourceLineNo">264</span> this.storeOffset = offset;<a name="line.264"></a>
<span class="sourceLineNo">265</span> return this;<a name="line.265"></a>
<span class="sourceLineNo">266</span> }<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span> @Override<a name="line.268"></a>
<span class="sourceLineNo">269</span> public Get setFilter(Filter filter) {<a name="line.269"></a>
<span class="sourceLineNo">270</span> super.setFilter(filter);<a name="line.270"></a>
<span class="sourceLineNo">271</span> return this;<a name="line.271"></a>
<span class="sourceLineNo">272</span> }<a name="line.272"></a>
<span class="sourceLineNo">273</span><a name="line.273"></a>
<span class="sourceLineNo">274</span> /* Accessors */<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span> /**<a name="line.276"></a>
<span class="sourceLineNo">277</span> * Set whether blocks should be cached for this Get.<a name="line.277"></a>
<span class="sourceLineNo">278</span> * &lt;p&gt;<a name="line.278"></a>
<span class="sourceLineNo">279</span> * This is true by default. When true, default settings of the table and family are used (this<a name="line.279"></a>
<span class="sourceLineNo">280</span> * will never override caching blocks if the block cache is disabled for that family or entirely).<a name="line.280"></a>
<span class="sourceLineNo">281</span> * @param cacheBlocks if false, default settings are overridden and blocks will not be cached<a name="line.281"></a>
<span class="sourceLineNo">282</span> */<a name="line.282"></a>
<span class="sourceLineNo">283</span> public Get setCacheBlocks(boolean cacheBlocks) {<a name="line.283"></a>
<span class="sourceLineNo">284</span> this.cacheBlocks = cacheBlocks;<a name="line.284"></a>
<span class="sourceLineNo">285</span> return this;<a name="line.285"></a>
<span class="sourceLineNo">286</span> }<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span> /**<a name="line.288"></a>
<span class="sourceLineNo">289</span> * Get whether blocks should be cached for this Get.<a name="line.289"></a>
<span class="sourceLineNo">290</span> * @return true if default caching should be used, false if blocks should not be cached<a name="line.290"></a>
<span class="sourceLineNo">291</span> */<a name="line.291"></a>
<span class="sourceLineNo">292</span> public boolean getCacheBlocks() {<a name="line.292"></a>
<span class="sourceLineNo">293</span> return cacheBlocks;<a name="line.293"></a>
<span class="sourceLineNo">294</span> }<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span> /**<a name="line.296"></a>
<span class="sourceLineNo">297</span> * Method for retrieving the get's row n<a name="line.297"></a>
<span class="sourceLineNo">298</span> */<a name="line.298"></a>
<span class="sourceLineNo">299</span> @Override<a name="line.299"></a>
<span class="sourceLineNo">300</span> public byte[] getRow() {<a name="line.300"></a>
<span class="sourceLineNo">301</span> return this.row;<a name="line.301"></a>
<span class="sourceLineNo">302</span> }<a name="line.302"></a>
<span class="sourceLineNo">303</span><a name="line.303"></a>
<span class="sourceLineNo">304</span> /**<a name="line.304"></a>
<span class="sourceLineNo">305</span> * Method for retrieving the get's maximum number of version<a name="line.305"></a>
<span class="sourceLineNo">306</span> * @return the maximum number of version to fetch for this get<a name="line.306"></a>
<span class="sourceLineNo">307</span> */<a name="line.307"></a>
<span class="sourceLineNo">308</span> public int getMaxVersions() {<a name="line.308"></a>
<span class="sourceLineNo">309</span> return this.maxVersions;<a name="line.309"></a>
<span class="sourceLineNo">310</span> }<a name="line.310"></a>
<span class="sourceLineNo">311</span><a name="line.311"></a>
<span class="sourceLineNo">312</span> /**<a name="line.312"></a>
<span class="sourceLineNo">313</span> * Method for retrieving the get's maximum number of values to return per Column Family<a name="line.313"></a>
<span class="sourceLineNo">314</span> * @return the maximum number of values to fetch per CF<a name="line.314"></a>
<span class="sourceLineNo">315</span> */<a name="line.315"></a>
<span class="sourceLineNo">316</span> public int getMaxResultsPerColumnFamily() {<a name="line.316"></a>
<span class="sourceLineNo">317</span> return this.storeLimit;<a name="line.317"></a>
<span class="sourceLineNo">318</span> }<a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span> /**<a name="line.320"></a>
<span class="sourceLineNo">321</span> * Method for retrieving the get's offset per row per column family (#kvs to be skipped)<a name="line.321"></a>
<span class="sourceLineNo">322</span> * @return the row offset<a name="line.322"></a>
<span class="sourceLineNo">323</span> */<a name="line.323"></a>
<span class="sourceLineNo">324</span> public int getRowOffsetPerColumnFamily() {<a name="line.324"></a>
<span class="sourceLineNo">325</span> return this.storeOffset;<a name="line.325"></a>
<span class="sourceLineNo">326</span> }<a name="line.326"></a>
<span class="sourceLineNo">327</span><a name="line.327"></a>
<span class="sourceLineNo">328</span> /**<a name="line.328"></a>
<span class="sourceLineNo">329</span> * Method for retrieving the get's TimeRange n<a name="line.329"></a>
<span class="sourceLineNo">330</span> */<a name="line.330"></a>
<span class="sourceLineNo">331</span> public TimeRange getTimeRange() {<a name="line.331"></a>
<span class="sourceLineNo">332</span> return this.tr;<a name="line.332"></a>
<span class="sourceLineNo">333</span> }<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span> /**<a name="line.335"></a>
<span class="sourceLineNo">336</span> * Method for retrieving the keys in the familyMap<a name="line.336"></a>
<span class="sourceLineNo">337</span> * @return keys in the current familyMap<a name="line.337"></a>
<span class="sourceLineNo">338</span> */<a name="line.338"></a>
<span class="sourceLineNo">339</span> public Set&lt;byte[]&gt; familySet() {<a name="line.339"></a>
<span class="sourceLineNo">340</span> return this.familyMap.keySet();<a name="line.340"></a>
<span class="sourceLineNo">341</span> }<a name="line.341"></a>
<span class="sourceLineNo">342</span><a name="line.342"></a>
<span class="sourceLineNo">343</span> /**<a name="line.343"></a>
<span class="sourceLineNo">344</span> * Method for retrieving the number of families to get from<a name="line.344"></a>
<span class="sourceLineNo">345</span> * @return number of families<a name="line.345"></a>
<span class="sourceLineNo">346</span> */<a name="line.346"></a>
<span class="sourceLineNo">347</span> public int numFamilies() {<a name="line.347"></a>
<span class="sourceLineNo">348</span> return this.familyMap.size();<a name="line.348"></a>
<span class="sourceLineNo">349</span> }<a name="line.349"></a>
<span class="sourceLineNo">350</span><a name="line.350"></a>
<span class="sourceLineNo">351</span> /**<a name="line.351"></a>
<span class="sourceLineNo">352</span> * Method for checking if any families have been inserted into this Get<a name="line.352"></a>
<span class="sourceLineNo">353</span> * @return true if familyMap is non empty false otherwise<a name="line.353"></a>
<span class="sourceLineNo">354</span> */<a name="line.354"></a>
<span class="sourceLineNo">355</span> public boolean hasFamilies() {<a name="line.355"></a>
<span class="sourceLineNo">356</span> return !this.familyMap.isEmpty();<a name="line.356"></a>
<span class="sourceLineNo">357</span> }<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> /**<a name="line.359"></a>
<span class="sourceLineNo">360</span> * Method for retrieving the get's familyMap n<a name="line.360"></a>
<span class="sourceLineNo">361</span> */<a name="line.361"></a>
<span class="sourceLineNo">362</span> public Map&lt;byte[], NavigableSet&lt;byte[]&gt;&gt; getFamilyMap() {<a name="line.362"></a>
<span class="sourceLineNo">363</span> return this.familyMap;<a name="line.363"></a>
<span class="sourceLineNo">364</span> }<a name="line.364"></a>
<span class="sourceLineNo">365</span><a name="line.365"></a>
<span class="sourceLineNo">366</span> /**<a name="line.366"></a>
<span class="sourceLineNo">367</span> * Compile the table and column family (i.e. schema) information into a String. Useful for parsing<a name="line.367"></a>
<span class="sourceLineNo">368</span> * and aggregation by debugging, logging, and administration tools. n<a name="line.368"></a>
<span class="sourceLineNo">369</span> */<a name="line.369"></a>
<span class="sourceLineNo">370</span> @Override<a name="line.370"></a>
<span class="sourceLineNo">371</span> public Map&lt;String, Object&gt; getFingerprint() {<a name="line.371"></a>
<span class="sourceLineNo">372</span> Map&lt;String, Object&gt; map = new HashMap&lt;&gt;();<a name="line.372"></a>
<span class="sourceLineNo">373</span> List&lt;String&gt; families = new ArrayList&lt;&gt;(this.familyMap.entrySet().size());<a name="line.373"></a>
<span class="sourceLineNo">374</span> map.put("families", families);<a name="line.374"></a>
<span class="sourceLineNo">375</span> for (Map.Entry&lt;byte[], NavigableSet&lt;byte[]&gt;&gt; entry : this.familyMap.entrySet()) {<a name="line.375"></a>
<span class="sourceLineNo">376</span> families.add(Bytes.toStringBinary(entry.getKey()));<a name="line.376"></a>
<span class="sourceLineNo">377</span> }<a name="line.377"></a>
<span class="sourceLineNo">378</span> return map;<a name="line.378"></a>
<span class="sourceLineNo">379</span> }<a name="line.379"></a>
<span class="sourceLineNo">380</span><a name="line.380"></a>
<span class="sourceLineNo">381</span> /**<a name="line.381"></a>
<span class="sourceLineNo">382</span> * Compile the details beyond the scope of getFingerprint (row, columns, timestamps, etc.) into a<a name="line.382"></a>
<span class="sourceLineNo">383</span> * Map along with the fingerprinted information. Useful for debugging, logging, and administration<a name="line.383"></a>
<span class="sourceLineNo">384</span> * tools.<a name="line.384"></a>
<span class="sourceLineNo">385</span> * @param maxCols a limit on the number of columns output prior to truncation n<a name="line.385"></a>
<span class="sourceLineNo">386</span> */<a name="line.386"></a>
<span class="sourceLineNo">387</span> @Override<a name="line.387"></a>
<span class="sourceLineNo">388</span> public Map&lt;String, Object&gt; toMap(int maxCols) {<a name="line.388"></a>
<span class="sourceLineNo">389</span> // we start with the fingerprint map and build on top of it.<a name="line.389"></a>
<span class="sourceLineNo">390</span> Map&lt;String, Object&gt; map = getFingerprint();<a name="line.390"></a>
<span class="sourceLineNo">391</span> // replace the fingerprint's simple list of families with a<a name="line.391"></a>
<span class="sourceLineNo">392</span> // map from column families to lists of qualifiers and kv details<a name="line.392"></a>
<span class="sourceLineNo">393</span> Map&lt;String, List&lt;String&gt;&gt; columns = new HashMap&lt;&gt;();<a name="line.393"></a>
<span class="sourceLineNo">394</span> map.put("families", columns);<a name="line.394"></a>
<span class="sourceLineNo">395</span> // add scalar information first<a name="line.395"></a>
<span class="sourceLineNo">396</span> map.put("row", Bytes.toStringBinary(this.row));<a name="line.396"></a>
<span class="sourceLineNo">397</span> map.put("maxVersions", this.maxVersions);<a name="line.397"></a>
<span class="sourceLineNo">398</span> map.put("cacheBlocks", this.cacheBlocks);<a name="line.398"></a>
<span class="sourceLineNo">399</span> List&lt;Long&gt; timeRange = new ArrayList&lt;&gt;(2);<a name="line.399"></a>
<span class="sourceLineNo">400</span> timeRange.add(this.tr.getMin());<a name="line.400"></a>
<span class="sourceLineNo">401</span> timeRange.add(this.tr.getMax());<a name="line.401"></a>
<span class="sourceLineNo">402</span> map.put("timeRange", timeRange);<a name="line.402"></a>
<span class="sourceLineNo">403</span> int colCount = 0;<a name="line.403"></a>
<span class="sourceLineNo">404</span> // iterate through affected families and add details<a name="line.404"></a>
<span class="sourceLineNo">405</span> for (Map.Entry&lt;byte[], NavigableSet&lt;byte[]&gt;&gt; entry : this.familyMap.entrySet()) {<a name="line.405"></a>
<span class="sourceLineNo">406</span> List&lt;String&gt; familyList = new ArrayList&lt;&gt;();<a name="line.406"></a>
<span class="sourceLineNo">407</span> columns.put(Bytes.toStringBinary(entry.getKey()), familyList);<a name="line.407"></a>
<span class="sourceLineNo">408</span> if (entry.getValue() == null) {<a name="line.408"></a>
<span class="sourceLineNo">409</span> colCount++;<a name="line.409"></a>
<span class="sourceLineNo">410</span> --maxCols;<a name="line.410"></a>
<span class="sourceLineNo">411</span> familyList.add("ALL");<a name="line.411"></a>
<span class="sourceLineNo">412</span> } else {<a name="line.412"></a>
<span class="sourceLineNo">413</span> colCount += entry.getValue().size();<a name="line.413"></a>
<span class="sourceLineNo">414</span> if (maxCols &lt;= 0) {<a name="line.414"></a>
<span class="sourceLineNo">415</span> continue;<a name="line.415"></a>
<span class="sourceLineNo">416</span> }<a name="line.416"></a>
<span class="sourceLineNo">417</span> for (byte[] column : entry.getValue()) {<a name="line.417"></a>
<span class="sourceLineNo">418</span> if (--maxCols &lt;= 0) {<a name="line.418"></a>
<span class="sourceLineNo">419</span> continue;<a name="line.419"></a>
<span class="sourceLineNo">420</span> }<a name="line.420"></a>
<span class="sourceLineNo">421</span> familyList.add(Bytes.toStringBinary(column));<a name="line.421"></a>
<span class="sourceLineNo">422</span> }<a name="line.422"></a>
<span class="sourceLineNo">423</span> }<a name="line.423"></a>
<span class="sourceLineNo">424</span> }<a name="line.424"></a>
<span class="sourceLineNo">425</span> map.put("totalColumns", colCount);<a name="line.425"></a>
<span class="sourceLineNo">426</span> if (this.filter != null) {<a name="line.426"></a>
<span class="sourceLineNo">427</span> map.put("filter", this.filter.toString());<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<a name="line.428"></a>
<span class="sourceLineNo">429</span> // add the id if set<a name="line.429"></a>
<span class="sourceLineNo">430</span> if (getId() != null) {<a name="line.430"></a>
<span class="sourceLineNo">431</span> map.put("id", getId());<a name="line.431"></a>
<span class="sourceLineNo">432</span> }<a name="line.432"></a>
<span class="sourceLineNo">433</span> return map;<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> @Override<a name="line.436"></a>
<span class="sourceLineNo">437</span> public int hashCode() {<a name="line.437"></a>
<span class="sourceLineNo">438</span> // TODO: This is wrong. Can't have two gets the same just because on same row. But it<a name="line.438"></a>
<span class="sourceLineNo">439</span> // matches how equals works currently and gets rid of the findbugs warning.<a name="line.439"></a>
<span class="sourceLineNo">440</span> return Bytes.hashCode(this.getRow());<a name="line.440"></a>
<span class="sourceLineNo">441</span> }<a name="line.441"></a>
<span class="sourceLineNo">442</span><a name="line.442"></a>
<span class="sourceLineNo">443</span> @Override<a name="line.443"></a>
<span class="sourceLineNo">444</span> public boolean equals(Object obj) {<a name="line.444"></a>
<span class="sourceLineNo">445</span> if (this == obj) {<a name="line.445"></a>
<span class="sourceLineNo">446</span> return true;<a name="line.446"></a>
<span class="sourceLineNo">447</span> }<a name="line.447"></a>
<span class="sourceLineNo">448</span> if (!(obj instanceof Row)) {<a name="line.448"></a>
<span class="sourceLineNo">449</span> return false;<a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span> Row other = (Row) obj;<a name="line.451"></a>
<span class="sourceLineNo">452</span> // TODO: This is wrong. Can't have two gets the same just because on same row.<a name="line.452"></a>
<span class="sourceLineNo">453</span> return Row.COMPARATOR.compare(this, other) == 0;<a name="line.453"></a>
<span class="sourceLineNo">454</span> }<a name="line.454"></a>
<span class="sourceLineNo">455</span><a name="line.455"></a>
<span class="sourceLineNo">456</span> @Override<a name="line.456"></a>
<span class="sourceLineNo">457</span> public Get setAttribute(String name, byte[] value) {<a name="line.457"></a>
<span class="sourceLineNo">458</span> return (Get) super.setAttribute(name, value);<a name="line.458"></a>
<span class="sourceLineNo">459</span> }<a name="line.459"></a>
<span class="sourceLineNo">460</span><a name="line.460"></a>
<span class="sourceLineNo">461</span> @Override<a name="line.461"></a>
<span class="sourceLineNo">462</span> public Get setId(String id) {<a name="line.462"></a>
<span class="sourceLineNo">463</span> return (Get) super.setId(id);<a name="line.463"></a>
<span class="sourceLineNo">464</span> }<a name="line.464"></a>
<span class="sourceLineNo">465</span><a name="line.465"></a>
<span class="sourceLineNo">466</span> @Override<a name="line.466"></a>
<span class="sourceLineNo">467</span> public Get setAuthorizations(Authorizations authorizations) {<a name="line.467"></a>
<span class="sourceLineNo">468</span> return (Get) super.setAuthorizations(authorizations);<a name="line.468"></a>
<span class="sourceLineNo">469</span> }<a name="line.469"></a>
<span class="sourceLineNo">470</span><a name="line.470"></a>
<span class="sourceLineNo">471</span> @Override<a name="line.471"></a>
<span class="sourceLineNo">472</span> public Get setACL(Map&lt;String, Permission&gt; perms) {<a name="line.472"></a>
<span class="sourceLineNo">473</span> return (Get) super.setACL(perms);<a name="line.473"></a>
<span class="sourceLineNo">474</span> }<a name="line.474"></a>
<span class="sourceLineNo">475</span><a name="line.475"></a>
<span class="sourceLineNo">476</span> @Override<a name="line.476"></a>
<span class="sourceLineNo">477</span> public Get setACL(String user, Permission perms) {<a name="line.477"></a>
<span class="sourceLineNo">478</span> return (Get) super.setACL(user, perms);<a name="line.478"></a>
<span class="sourceLineNo">479</span> }<a name="line.479"></a>
<span class="sourceLineNo">480</span><a name="line.480"></a>
<span class="sourceLineNo">481</span> @Override<a name="line.481"></a>
<span class="sourceLineNo">482</span> public Get setConsistency(Consistency consistency) {<a name="line.482"></a>
<span class="sourceLineNo">483</span> return (Get) super.setConsistency(consistency);<a name="line.483"></a>
<span class="sourceLineNo">484</span> }<a name="line.484"></a>
<span class="sourceLineNo">485</span><a name="line.485"></a>
<span class="sourceLineNo">486</span> @Override<a name="line.486"></a>
<span class="sourceLineNo">487</span> public Get setReplicaId(int Id) {<a name="line.487"></a>
<span class="sourceLineNo">488</span> return (Get) super.setReplicaId(Id);<a name="line.488"></a>
<span class="sourceLineNo">489</span> }<a name="line.489"></a>
<span class="sourceLineNo">490</span><a name="line.490"></a>
<span class="sourceLineNo">491</span> @Override<a name="line.491"></a>
<span class="sourceLineNo">492</span> public Get setIsolationLevel(IsolationLevel level) {<a name="line.492"></a>
<span class="sourceLineNo">493</span> return (Get) super.setIsolationLevel(level);<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> @Override<a name="line.496"></a>
<span class="sourceLineNo">497</span> public Get setPriority(int priority) {<a name="line.497"></a>
<span class="sourceLineNo">498</span> return (Get) super.setPriority(priority);<a name="line.498"></a>
<span class="sourceLineNo">499</span> }<a name="line.499"></a>
<span class="sourceLineNo">500</span>}<a name="line.500"></a>
</pre>
</div>
</body>
</html>