http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b44796ef/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html index b7c90be..f26f8aa 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html @@ -193,992 +193,1035 @@ <span class="sourceLineNo">185</span> * Control whether to use pread at server side.<a name="line.185"></a> <span class="sourceLineNo">186</span> */<a name="line.186"></a> <span class="sourceLineNo">187</span> private ReadType readType = ReadType.DEFAULT;<a name="line.187"></a> -<span class="sourceLineNo">188</span> /**<a name="line.188"></a> -<span class="sourceLineNo">189</span> * Create a Scan operation across all rows.<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> public Scan() {}<a name="line.191"></a> -<span class="sourceLineNo">192</span><a name="line.192"></a> -<span class="sourceLineNo">193</span> /**<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @deprecated use {@code new Scan().withStartRow(startRow).setFilter(filter)} instead.<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> @Deprecated<a name="line.196"></a> -<span class="sourceLineNo">197</span> public Scan(byte[] startRow, Filter filter) {<a name="line.197"></a> -<span class="sourceLineNo">198</span> this(startRow);<a name="line.198"></a> -<span class="sourceLineNo">199</span> this.filter = filter;<a name="line.199"></a> -<span class="sourceLineNo">200</span> }<a name="line.200"></a> -<span class="sourceLineNo">201</span><a name="line.201"></a> -<span class="sourceLineNo">202</span> /**<a name="line.202"></a> -<span class="sourceLineNo">203</span> * Create a Scan operation starting at the specified row.<a name="line.203"></a> -<span class="sourceLineNo">204</span> * <p><a name="line.204"></a> -<span class="sourceLineNo">205</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.205"></a> -<span class="sourceLineNo">206</span> * specified row.<a name="line.206"></a> -<span class="sourceLineNo">207</span> * @param startRow row to start scanner at or after<a name="line.207"></a> -<span class="sourceLineNo">208</span> * @deprecated use {@code new Scan().withStartRow(startRow)} instead.<a name="line.208"></a> -<span class="sourceLineNo">209</span> */<a name="line.209"></a> -<span class="sourceLineNo">210</span> @Deprecated<a name="line.210"></a> -<span class="sourceLineNo">211</span> public Scan(byte[] startRow) {<a name="line.211"></a> -<span class="sourceLineNo">212</span> setStartRow(startRow);<a name="line.212"></a> -<span class="sourceLineNo">213</span> }<a name="line.213"></a> -<span class="sourceLineNo">214</span><a name="line.214"></a> -<span class="sourceLineNo">215</span> /**<a name="line.215"></a> -<span class="sourceLineNo">216</span> * Create a Scan operation for the range of rows specified.<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param startRow row to start scanner at or after (inclusive)<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @param stopRow row to stop scanner before (exclusive)<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @deprecated use {@code new Scan().withStartRow(startRow).withStopRow(stopRow)} instead.<a name="line.219"></a> -<span class="sourceLineNo">220</span> */<a name="line.220"></a> -<span class="sourceLineNo">221</span> @Deprecated<a name="line.221"></a> -<span class="sourceLineNo">222</span> public Scan(byte[] startRow, byte[] stopRow) {<a name="line.222"></a> -<span class="sourceLineNo">223</span> setStartRow(startRow);<a name="line.223"></a> -<span class="sourceLineNo">224</span> setStopRow(stopRow);<a name="line.224"></a> -<span class="sourceLineNo">225</span> }<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> * Creates a new instance of this class while copying all values.<a name="line.228"></a> -<span class="sourceLineNo">229</span> *<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @param scan The scan instance to copy from.<a name="line.230"></a> -<span class="sourceLineNo">231</span> * @throws IOException When copying the values fails.<a name="line.231"></a> -<span class="sourceLineNo">232</span> */<a name="line.232"></a> -<span class="sourceLineNo">233</span> public Scan(Scan scan) throws IOException {<a name="line.233"></a> -<span class="sourceLineNo">234</span> startRow = scan.getStartRow();<a name="line.234"></a> -<span class="sourceLineNo">235</span> includeStartRow = scan.includeStartRow();<a name="line.235"></a> -<span class="sourceLineNo">236</span> stopRow = scan.getStopRow();<a name="line.236"></a> -<span class="sourceLineNo">237</span> includeStopRow = scan.includeStopRow();<a name="line.237"></a> -<span class="sourceLineNo">238</span> maxVersions = scan.getMaxVersions();<a name="line.238"></a> -<span class="sourceLineNo">239</span> batch = scan.getBatch();<a name="line.239"></a> -<span class="sourceLineNo">240</span> storeLimit = scan.getMaxResultsPerColumnFamily();<a name="line.240"></a> -<span class="sourceLineNo">241</span> storeOffset = scan.getRowOffsetPerColumnFamily();<a name="line.241"></a> -<span class="sourceLineNo">242</span> caching = scan.getCaching();<a name="line.242"></a> -<span class="sourceLineNo">243</span> maxResultSize = scan.getMaxResultSize();<a name="line.243"></a> -<span class="sourceLineNo">244</span> cacheBlocks = scan.getCacheBlocks();<a name="line.244"></a> -<span class="sourceLineNo">245</span> filter = scan.getFilter(); // clone?<a name="line.245"></a> -<span class="sourceLineNo">246</span> loadColumnFamiliesOnDemand = scan.getLoadColumnFamiliesOnDemandValue();<a name="line.246"></a> -<span class="sourceLineNo">247</span> consistency = scan.getConsistency();<a name="line.247"></a> -<span class="sourceLineNo">248</span> this.setIsolationLevel(scan.getIsolationLevel());<a name="line.248"></a> -<span class="sourceLineNo">249</span> reversed = scan.isReversed();<a name="line.249"></a> -<span class="sourceLineNo">250</span> asyncPrefetch = scan.isAsyncPrefetch();<a name="line.250"></a> -<span class="sourceLineNo">251</span> small = scan.isSmall();<a name="line.251"></a> -<span class="sourceLineNo">252</span> allowPartialResults = scan.getAllowPartialResults();<a name="line.252"></a> -<span class="sourceLineNo">253</span> tr = scan.getTimeRange(); // TimeRange is immutable<a name="line.253"></a> -<span class="sourceLineNo">254</span> Map<byte[], NavigableSet<byte[]>> fams = scan.getFamilyMap();<a name="line.254"></a> -<span class="sourceLineNo">255</span> for (Map.Entry<byte[],NavigableSet<byte[]>> entry : fams.entrySet()) {<a name="line.255"></a> -<span class="sourceLineNo">256</span> byte [] fam = entry.getKey();<a name="line.256"></a> -<span class="sourceLineNo">257</span> NavigableSet<byte[]> cols = entry.getValue();<a name="line.257"></a> -<span class="sourceLineNo">258</span> if (cols != null && cols.size() > 0) {<a name="line.258"></a> -<span class="sourceLineNo">259</span> for (byte[] col : cols) {<a name="line.259"></a> -<span class="sourceLineNo">260</span> addColumn(fam, col);<a name="line.260"></a> -<span class="sourceLineNo">261</span> }<a name="line.261"></a> -<span class="sourceLineNo">262</span> } else {<a name="line.262"></a> -<span class="sourceLineNo">263</span> addFamily(fam);<a name="line.263"></a> -<span class="sourceLineNo">264</span> }<a name="line.264"></a> -<span class="sourceLineNo">265</span> }<a name="line.265"></a> -<span class="sourceLineNo">266</span> for (Map.Entry<String, byte[]> attr : scan.getAttributesMap().entrySet()) {<a name="line.266"></a> -<span class="sourceLineNo">267</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.267"></a> +<span class="sourceLineNo">188</span><a name="line.188"></a> +<span class="sourceLineNo">189</span> private boolean needCursorResult = false;<a name="line.189"></a> +<span class="sourceLineNo">190</span><a name="line.190"></a> +<span class="sourceLineNo">191</span> /**<a name="line.191"></a> +<span class="sourceLineNo">192</span> * Create a Scan operation across all rows.<a name="line.192"></a> +<span class="sourceLineNo">193</span> */<a name="line.193"></a> +<span class="sourceLineNo">194</span> public Scan() {}<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @deprecated use {@code new Scan().withStartRow(startRow).setFilter(filter)} instead.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> @Deprecated<a name="line.199"></a> +<span class="sourceLineNo">200</span> public Scan(byte[] startRow, Filter filter) {<a name="line.200"></a> +<span class="sourceLineNo">201</span> this(startRow);<a name="line.201"></a> +<span class="sourceLineNo">202</span> this.filter = filter;<a name="line.202"></a> +<span class="sourceLineNo">203</span> }<a name="line.203"></a> +<span class="sourceLineNo">204</span><a name="line.204"></a> +<span class="sourceLineNo">205</span> /**<a name="line.205"></a> +<span class="sourceLineNo">206</span> * Create a Scan operation starting at the specified row.<a name="line.206"></a> +<span class="sourceLineNo">207</span> * <p><a name="line.207"></a> +<span class="sourceLineNo">208</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.208"></a> +<span class="sourceLineNo">209</span> * specified row.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * @param startRow row to start scanner at or after<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @deprecated use {@code new Scan().withStartRow(startRow)} instead.<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> @Deprecated<a name="line.213"></a> +<span class="sourceLineNo">214</span> public Scan(byte[] startRow) {<a name="line.214"></a> +<span class="sourceLineNo">215</span> setStartRow(startRow);<a name="line.215"></a> +<span class="sourceLineNo">216</span> }<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> * Create a Scan operation for the range of rows specified.<a name="line.219"></a> +<span class="sourceLineNo">220</span> * @param startRow row to start scanner at or after (inclusive)<a name="line.220"></a> +<span class="sourceLineNo">221</span> * @param stopRow row to stop scanner before (exclusive)<a name="line.221"></a> +<span class="sourceLineNo">222</span> * @deprecated use {@code new Scan().withStartRow(startRow).withStopRow(stopRow)} instead.<a name="line.222"></a> +<span class="sourceLineNo">223</span> */<a name="line.223"></a> +<span class="sourceLineNo">224</span> @Deprecated<a name="line.224"></a> +<span class="sourceLineNo">225</span> public Scan(byte[] startRow, byte[] stopRow) {<a name="line.225"></a> +<span class="sourceLineNo">226</span> setStartRow(startRow);<a name="line.226"></a> +<span class="sourceLineNo">227</span> setStopRow(stopRow);<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Creates a new instance of this class while copying all values.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param scan The scan instance to copy from.<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @throws IOException When copying the values fails.<a name="line.234"></a> +<span class="sourceLineNo">235</span> */<a name="line.235"></a> +<span class="sourceLineNo">236</span> public Scan(Scan scan) throws IOException {<a name="line.236"></a> +<span class="sourceLineNo">237</span> startRow = scan.getStartRow();<a name="line.237"></a> +<span class="sourceLineNo">238</span> includeStartRow = scan.includeStartRow();<a name="line.238"></a> +<span class="sourceLineNo">239</span> stopRow = scan.getStopRow();<a name="line.239"></a> +<span class="sourceLineNo">240</span> includeStopRow = scan.includeStopRow();<a name="line.240"></a> +<span class="sourceLineNo">241</span> maxVersions = scan.getMaxVersions();<a name="line.241"></a> +<span class="sourceLineNo">242</span> batch = scan.getBatch();<a name="line.242"></a> +<span class="sourceLineNo">243</span> storeLimit = scan.getMaxResultsPerColumnFamily();<a name="line.243"></a> +<span class="sourceLineNo">244</span> storeOffset = scan.getRowOffsetPerColumnFamily();<a name="line.244"></a> +<span class="sourceLineNo">245</span> caching = scan.getCaching();<a name="line.245"></a> +<span class="sourceLineNo">246</span> maxResultSize = scan.getMaxResultSize();<a name="line.246"></a> +<span class="sourceLineNo">247</span> cacheBlocks = scan.getCacheBlocks();<a name="line.247"></a> +<span class="sourceLineNo">248</span> filter = scan.getFilter(); // clone?<a name="line.248"></a> +<span class="sourceLineNo">249</span> loadColumnFamiliesOnDemand = scan.getLoadColumnFamiliesOnDemandValue();<a name="line.249"></a> +<span class="sourceLineNo">250</span> consistency = scan.getConsistency();<a name="line.250"></a> +<span class="sourceLineNo">251</span> this.setIsolationLevel(scan.getIsolationLevel());<a name="line.251"></a> +<span class="sourceLineNo">252</span> reversed = scan.isReversed();<a name="line.252"></a> +<span class="sourceLineNo">253</span> asyncPrefetch = scan.isAsyncPrefetch();<a name="line.253"></a> +<span class="sourceLineNo">254</span> small = scan.isSmall();<a name="line.254"></a> +<span class="sourceLineNo">255</span> allowPartialResults = scan.getAllowPartialResults();<a name="line.255"></a> +<span class="sourceLineNo">256</span> tr = scan.getTimeRange(); // TimeRange is immutable<a name="line.256"></a> +<span class="sourceLineNo">257</span> Map<byte[], NavigableSet<byte[]>> fams = scan.getFamilyMap();<a name="line.257"></a> +<span class="sourceLineNo">258</span> for (Map.Entry<byte[],NavigableSet<byte[]>> entry : fams.entrySet()) {<a name="line.258"></a> +<span class="sourceLineNo">259</span> byte [] fam = entry.getKey();<a name="line.259"></a> +<span class="sourceLineNo">260</span> NavigableSet<byte[]> cols = entry.getValue();<a name="line.260"></a> +<span class="sourceLineNo">261</span> if (cols != null && cols.size() > 0) {<a name="line.261"></a> +<span class="sourceLineNo">262</span> for (byte[] col : cols) {<a name="line.262"></a> +<span class="sourceLineNo">263</span> addColumn(fam, col);<a name="line.263"></a> +<span class="sourceLineNo">264</span> }<a name="line.264"></a> +<span class="sourceLineNo">265</span> } else {<a name="line.265"></a> +<span class="sourceLineNo">266</span> addFamily(fam);<a name="line.266"></a> +<span class="sourceLineNo">267</span> }<a name="line.267"></a> <span class="sourceLineNo">268</span> }<a name="line.268"></a> -<span class="sourceLineNo">269</span> for (Map.Entry<byte[], TimeRange> entry : scan.getColumnFamilyTimeRange().entrySet()) {<a name="line.269"></a> -<span class="sourceLineNo">270</span> TimeRange tr = entry.getValue();<a name="line.270"></a> -<span class="sourceLineNo">271</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span> this.mvccReadPoint = scan.getMvccReadPoint();<a name="line.273"></a> -<span class="sourceLineNo">274</span> this.limit = scan.getLimit();<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> /**<a name="line.277"></a> -<span class="sourceLineNo">278</span> * Builds a scan object with the same specs as get.<a name="line.278"></a> -<span class="sourceLineNo">279</span> * @param get get to model scan after<a name="line.279"></a> -<span class="sourceLineNo">280</span> */<a name="line.280"></a> -<span class="sourceLineNo">281</span> public Scan(Get get) {<a name="line.281"></a> -<span class="sourceLineNo">282</span> this.startRow = get.getRow();<a name="line.282"></a> -<span class="sourceLineNo">283</span> this.includeStartRow = true;<a name="line.283"></a> -<span class="sourceLineNo">284</span> this.stopRow = get.getRow();<a name="line.284"></a> -<span class="sourceLineNo">285</span> this.includeStopRow = true;<a name="line.285"></a> -<span class="sourceLineNo">286</span> this.filter = get.getFilter();<a name="line.286"></a> -<span class="sourceLineNo">287</span> this.cacheBlocks = get.getCacheBlocks();<a name="line.287"></a> -<span class="sourceLineNo">288</span> this.maxVersions = get.getMaxVersions();<a name="line.288"></a> -<span class="sourceLineNo">289</span> this.storeLimit = get.getMaxResultsPerColumnFamily();<a name="line.289"></a> -<span class="sourceLineNo">290</span> this.storeOffset = get.getRowOffsetPerColumnFamily();<a name="line.290"></a> -<span class="sourceLineNo">291</span> this.tr = get.getTimeRange();<a name="line.291"></a> -<span class="sourceLineNo">292</span> this.familyMap = get.getFamilyMap();<a name="line.292"></a> -<span class="sourceLineNo">293</span> this.asyncPrefetch = false;<a name="line.293"></a> -<span class="sourceLineNo">294</span> this.consistency = get.getConsistency();<a name="line.294"></a> -<span class="sourceLineNo">295</span> this.setIsolationLevel(get.getIsolationLevel());<a name="line.295"></a> -<span class="sourceLineNo">296</span> this.loadColumnFamiliesOnDemand = get.getLoadColumnFamiliesOnDemandValue();<a name="line.296"></a> -<span class="sourceLineNo">297</span> for (Map.Entry<String, byte[]> attr : get.getAttributesMap().entrySet()) {<a name="line.297"></a> -<span class="sourceLineNo">298</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.298"></a> -<span class="sourceLineNo">299</span> }<a name="line.299"></a> -<span class="sourceLineNo">300</span> for (Map.Entry<byte[], TimeRange> entry : get.getColumnFamilyTimeRange().entrySet()) {<a name="line.300"></a> -<span class="sourceLineNo">301</span> TimeRange tr = entry.getValue();<a name="line.301"></a> -<span class="sourceLineNo">302</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.302"></a> +<span class="sourceLineNo">269</span> for (Map.Entry<String, byte[]> attr : scan.getAttributesMap().entrySet()) {<a name="line.269"></a> +<span class="sourceLineNo">270</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.270"></a> +<span class="sourceLineNo">271</span> }<a name="line.271"></a> +<span class="sourceLineNo">272</span> for (Map.Entry<byte[], TimeRange> entry : scan.getColumnFamilyTimeRange().entrySet()) {<a name="line.272"></a> +<span class="sourceLineNo">273</span> TimeRange tr = entry.getValue();<a name="line.273"></a> +<span class="sourceLineNo">274</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.274"></a> +<span class="sourceLineNo">275</span> }<a name="line.275"></a> +<span class="sourceLineNo">276</span> this.mvccReadPoint = scan.getMvccReadPoint();<a name="line.276"></a> +<span class="sourceLineNo">277</span> this.limit = scan.getLimit();<a name="line.277"></a> +<span class="sourceLineNo">278</span> this.needCursorResult = scan.isNeedCursorResult();<a name="line.278"></a> +<span class="sourceLineNo">279</span> }<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> * Builds a scan object with the same specs as get.<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @param get get to model scan after<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> public Scan(Get get) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> this.startRow = get.getRow();<a name="line.286"></a> +<span class="sourceLineNo">287</span> this.includeStartRow = true;<a name="line.287"></a> +<span class="sourceLineNo">288</span> this.stopRow = get.getRow();<a name="line.288"></a> +<span class="sourceLineNo">289</span> this.includeStopRow = true;<a name="line.289"></a> +<span class="sourceLineNo">290</span> this.filter = get.getFilter();<a name="line.290"></a> +<span class="sourceLineNo">291</span> this.cacheBlocks = get.getCacheBlocks();<a name="line.291"></a> +<span class="sourceLineNo">292</span> this.maxVersions = get.getMaxVersions();<a name="line.292"></a> +<span class="sourceLineNo">293</span> this.storeLimit = get.getMaxResultsPerColumnFamily();<a name="line.293"></a> +<span class="sourceLineNo">294</span> this.storeOffset = get.getRowOffsetPerColumnFamily();<a name="line.294"></a> +<span class="sourceLineNo">295</span> this.tr = get.getTimeRange();<a name="line.295"></a> +<span class="sourceLineNo">296</span> this.familyMap = get.getFamilyMap();<a name="line.296"></a> +<span class="sourceLineNo">297</span> this.asyncPrefetch = false;<a name="line.297"></a> +<span class="sourceLineNo">298</span> this.consistency = get.getConsistency();<a name="line.298"></a> +<span class="sourceLineNo">299</span> this.setIsolationLevel(get.getIsolationLevel());<a name="line.299"></a> +<span class="sourceLineNo">300</span> this.loadColumnFamiliesOnDemand = get.getLoadColumnFamiliesOnDemandValue();<a name="line.300"></a> +<span class="sourceLineNo">301</span> for (Map.Entry<String, byte[]> attr : get.getAttributesMap().entrySet()) {<a name="line.301"></a> +<span class="sourceLineNo">302</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.302"></a> <span class="sourceLineNo">303</span> }<a name="line.303"></a> -<span class="sourceLineNo">304</span> this.mvccReadPoint = -1L;<a name="line.304"></a> -<span class="sourceLineNo">305</span> }<a name="line.305"></a> -<span class="sourceLineNo">306</span><a name="line.306"></a> -<span class="sourceLineNo">307</span> public boolean isGetScan() {<a name="line.307"></a> -<span class="sourceLineNo">308</span> return includeStartRow && includeStopRow<a name="line.308"></a> -<span class="sourceLineNo">309</span> && ClientUtil.areScanStartRowAndStopRowEqual(this.startRow, this.stopRow);<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> * Get all columns from the specified family.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * <p><a name="line.314"></a> -<span class="sourceLineNo">315</span> * Overrides previous calls to addColumn for this family.<a name="line.315"></a> -<span class="sourceLineNo">316</span> * @param family family name<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @return this<a name="line.317"></a> -<span class="sourceLineNo">318</span> */<a name="line.318"></a> -<span class="sourceLineNo">319</span> public Scan addFamily(byte [] family) {<a name="line.319"></a> -<span class="sourceLineNo">320</span> familyMap.remove(family);<a name="line.320"></a> -<span class="sourceLineNo">321</span> familyMap.put(family, null);<a name="line.321"></a> -<span class="sourceLineNo">322</span> return this;<a name="line.322"></a> -<span class="sourceLineNo">323</span> }<a name="line.323"></a> -<span class="sourceLineNo">324</span><a name="line.324"></a> -<span class="sourceLineNo">325</span> /**<a name="line.325"></a> -<span class="sourceLineNo">326</span> * Get the column from the specified family with the specified qualifier.<a name="line.326"></a> -<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> -<span class="sourceLineNo">328</span> * Overrides previous calls to addFamily for this family.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @param family family name<a name="line.329"></a> -<span class="sourceLineNo">330</span> * @param qualifier column qualifier<a name="line.330"></a> -<span class="sourceLineNo">331</span> * @return this<a name="line.331"></a> -<span class="sourceLineNo">332</span> */<a name="line.332"></a> -<span class="sourceLineNo">333</span> public Scan addColumn(byte [] family, byte [] qualifier) {<a name="line.333"></a> -<span class="sourceLineNo">334</span> NavigableSet<byte []> set = familyMap.get(family);<a name="line.334"></a> -<span class="sourceLineNo">335</span> if(set == null) {<a name="line.335"></a> -<span class="sourceLineNo">336</span> set = new TreeSet<>(Bytes.BYTES_COMPARATOR);<a name="line.336"></a> -<span class="sourceLineNo">337</span> }<a name="line.337"></a> -<span class="sourceLineNo">338</span> if (qualifier == null) {<a name="line.338"></a> -<span class="sourceLineNo">339</span> qualifier = HConstants.EMPTY_BYTE_ARRAY;<a name="line.339"></a> -<span class="sourceLineNo">340</span> }<a name="line.340"></a> -<span class="sourceLineNo">341</span> set.add(qualifier);<a name="line.341"></a> -<span class="sourceLineNo">342</span> familyMap.put(family, set);<a name="line.342"></a> -<span class="sourceLineNo">343</span> return this;<a name="line.343"></a> -<span class="sourceLineNo">344</span> }<a name="line.344"></a> -<span class="sourceLineNo">345</span><a name="line.345"></a> -<span class="sourceLineNo">346</span> /**<a name="line.346"></a> -<span class="sourceLineNo">347</span> * Set versions of columns only within the specified timestamp range,<a name="line.347"></a> -<span class="sourceLineNo">348</span> * [minStamp, maxStamp). Note, default maximum versions to return is 1. If<a name="line.348"></a> -<span class="sourceLineNo">349</span> * your time range spans more than one version and you want all versions<a name="line.349"></a> -<span class="sourceLineNo">350</span> * returned, up the number of versions beyond the default.<a name="line.350"></a> -<span class="sourceLineNo">351</span> * @param minStamp minimum timestamp value, inclusive<a name="line.351"></a> -<span class="sourceLineNo">352</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.352"></a> -<span class="sourceLineNo">353</span> * @see #setMaxVersions()<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @see #setMaxVersions(int)<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @return this<a name="line.355"></a> -<span class="sourceLineNo">356</span> */<a name="line.356"></a> -<span class="sourceLineNo">357</span> @Override<a name="line.357"></a> -<span class="sourceLineNo">358</span> public Scan setTimeRange(long minStamp, long maxStamp) throws IOException {<a name="line.358"></a> -<span class="sourceLineNo">359</span> return (Scan) super.setTimeRange(minStamp, maxStamp);<a name="line.359"></a> -<span class="sourceLineNo">360</span> }<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> * Set versions of columns only within the specified timestamp range,<a name="line.363"></a> -<span class="sourceLineNo">364</span> * @param tr Input TimeRange<a name="line.364"></a> -<span class="sourceLineNo">365</span> * @return this for invocation chaining<a name="line.365"></a> -<span class="sourceLineNo">366</span> */<a name="line.366"></a> -<span class="sourceLineNo">367</span> public Scan setTimeRange(TimeRange tr) {<a name="line.367"></a> -<span class="sourceLineNo">368</span> return (Scan) super.setTimeRange(tr);<a name="line.368"></a> -<span class="sourceLineNo">369</span> }<a name="line.369"></a> -<span class="sourceLineNo">370</span><a name="line.370"></a> -<span class="sourceLineNo">371</span> /**<a name="line.371"></a> -<span class="sourceLineNo">372</span> * Get versions of columns with the specified timestamp. Note, default maximum<a name="line.372"></a> -<span class="sourceLineNo">373</span> * versions to return is 1. If your time range spans more than one version<a name="line.373"></a> -<span class="sourceLineNo">374</span> * and you want all versions returned, up the number of versions beyond the<a name="line.374"></a> -<span class="sourceLineNo">375</span> * defaut.<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @param timestamp version timestamp<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @see #setMaxVersions()<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @see #setMaxVersions(int)<a name="line.378"></a> -<span class="sourceLineNo">379</span> * @return this<a name="line.379"></a> -<span class="sourceLineNo">380</span> */<a name="line.380"></a> -<span class="sourceLineNo">381</span> public Scan setTimeStamp(long timestamp)<a name="line.381"></a> -<span class="sourceLineNo">382</span> throws IOException {<a name="line.382"></a> -<span class="sourceLineNo">383</span> try {<a name="line.383"></a> -<span class="sourceLineNo">384</span> super.setTimeRange(timestamp, timestamp + 1);<a name="line.384"></a> -<span class="sourceLineNo">385</span> } catch(Exception e) {<a name="line.385"></a> -<span class="sourceLineNo">386</span> // This should never happen, unless integer overflow or something extremely wrong...<a name="line.386"></a> -<span class="sourceLineNo">387</span> LOG.error("TimeRange failed, likely caused by integer overflow. ", e);<a name="line.387"></a> -<span class="sourceLineNo">388</span> throw e;<a name="line.388"></a> -<span class="sourceLineNo">389</span> }<a name="line.389"></a> -<span class="sourceLineNo">390</span> return this;<a name="line.390"></a> -<span class="sourceLineNo">391</span> }<a name="line.391"></a> -<span class="sourceLineNo">392</span><a name="line.392"></a> -<span class="sourceLineNo">393</span> @Override<a name="line.393"></a> -<span class="sourceLineNo">394</span> public Scan setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.394"></a> -<span class="sourceLineNo">395</span> return (Scan) super.setColumnFamilyTimeRange(cf, minStamp, maxStamp);<a name="line.395"></a> -<span class="sourceLineNo">396</span> }<a name="line.396"></a> -<span class="sourceLineNo">397</span><a name="line.397"></a> -<span class="sourceLineNo">398</span> @Override<a name="line.398"></a> -<span class="sourceLineNo">399</span> public Scan setColumnFamilyTimeRange(byte[] cf, TimeRange tr) {<a name="line.399"></a> -<span class="sourceLineNo">400</span> return (Scan) super.setColumnFamilyTimeRange(cf, tr);<a name="line.400"></a> -<span class="sourceLineNo">401</span> }<a name="line.401"></a> -<span class="sourceLineNo">402</span><a name="line.402"></a> -<span class="sourceLineNo">403</span> /**<a name="line.403"></a> -<span class="sourceLineNo">404</span> * Set the start row of the scan.<a name="line.404"></a> -<span class="sourceLineNo">405</span> * <p><a name="line.405"></a> -<span class="sourceLineNo">406</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.406"></a> -<span class="sourceLineNo">407</span> * specified row.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * @param startRow row to start scanner at or after<a name="line.408"></a> -<span class="sourceLineNo">409</span> * @return this<a name="line.409"></a> -<span class="sourceLineNo">410</span> * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length<a name="line.410"></a> -<span class="sourceLineNo">411</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.411"></a> -<span class="sourceLineNo">412</span> * @deprecated use {@link #withStartRow(byte[])} instead. This method may change the inclusive of<a name="line.412"></a> -<span class="sourceLineNo">413</span> * the stop row to keep compatible with the old behavior.<a name="line.413"></a> -<span class="sourceLineNo">414</span> */<a name="line.414"></a> -<span class="sourceLineNo">415</span> @Deprecated<a name="line.415"></a> -<span class="sourceLineNo">416</span> public Scan setStartRow(byte[] startRow) {<a name="line.416"></a> -<span class="sourceLineNo">417</span> withStartRow(startRow);<a name="line.417"></a> -<span class="sourceLineNo">418</span> if (ClientUtil.areScanStartRowAndStopRowEqual(this.startRow, this.stopRow)) {<a name="line.418"></a> -<span class="sourceLineNo">419</span> // for keeping the old behavior that a scan with the same start and stop row is a get scan.<a name="line.419"></a> -<span class="sourceLineNo">420</span> this.includeStopRow = true;<a name="line.420"></a> -<span class="sourceLineNo">421</span> }<a name="line.421"></a> -<span class="sourceLineNo">422</span> return this;<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> /**<a name="line.425"></a> -<span class="sourceLineNo">426</span> * Set the start row of the scan.<a name="line.426"></a> -<span class="sourceLineNo">427</span> * <p><a name="line.427"></a> -<span class="sourceLineNo">428</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.428"></a> -<span class="sourceLineNo">429</span> * specified row.<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param startRow row to start scanner at or after<a name="line.430"></a> -<span class="sourceLineNo">431</span> * @return this<a name="line.431"></a> -<span class="sourceLineNo">432</span> * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length<a name="line.432"></a> -<span class="sourceLineNo">433</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.433"></a> -<span class="sourceLineNo">434</span> */<a name="line.434"></a> -<span class="sourceLineNo">435</span> public Scan withStartRow(byte[] startRow) {<a name="line.435"></a> -<span class="sourceLineNo">436</span> return withStartRow(startRow, true);<a name="line.436"></a> -<span class="sourceLineNo">437</span> }<a name="line.437"></a> -<span class="sourceLineNo">438</span><a name="line.438"></a> -<span class="sourceLineNo">439</span> /**<a name="line.439"></a> -<span class="sourceLineNo">440</span> * Set the start row of the scan.<a name="line.440"></a> -<span class="sourceLineNo">441</span> * <p><a name="line.441"></a> -<span class="sourceLineNo">442</span> * If the specified row does not exist, or the {@code inclusive} is {@code false}, the Scanner<a name="line.442"></a> -<span class="sourceLineNo">443</span> * will start from the next closest row after the specified row.<a name="line.443"></a> -<span class="sourceLineNo">444</span> * @param startRow row to start scanner at or after<a name="line.444"></a> -<span class="sourceLineNo">445</span> * @param inclusive whether we should include the start row when scan<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @return this<a name="line.446"></a> -<span class="sourceLineNo">447</span> * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length<a name="line.447"></a> -<span class="sourceLineNo">448</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.448"></a> -<span class="sourceLineNo">449</span> */<a name="line.449"></a> -<span class="sourceLineNo">450</span> public Scan withStartRow(byte[] startRow, boolean inclusive) {<a name="line.450"></a> -<span class="sourceLineNo">451</span> if (Bytes.len(startRow) > HConstants.MAX_ROW_LENGTH) {<a name="line.451"></a> -<span class="sourceLineNo">452</span> throw new IllegalArgumentException("startRow's length must be less than or equal to "<a name="line.452"></a> -<span class="sourceLineNo">453</span> + HConstants.MAX_ROW_LENGTH + " to meet the criteria" + " for a row key.");<a name="line.453"></a> -<span class="sourceLineNo">454</span> }<a name="line.454"></a> -<span class="sourceLineNo">455</span> this.startRow = startRow;<a name="line.455"></a> -<span class="sourceLineNo">456</span> this.includeStartRow = inclusive;<a name="line.456"></a> -<span class="sourceLineNo">457</span> return this;<a name="line.457"></a> -<span class="sourceLineNo">458</span> }<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> * Set the stop row of the scan.<a name="line.461"></a> -<span class="sourceLineNo">462</span> * <p><a name="line.462"></a> -<span class="sourceLineNo">463</span> * The scan will include rows that are lexicographically less than the provided stopRow.<a name="line.463"></a> -<span class="sourceLineNo">464</span> * <p><a name="line.464"></a> -<span class="sourceLineNo">465</span> * <b>Note:</b> When doing a filter for a rowKey <u>Prefix</u> use<a name="line.465"></a> -<span class="sourceLineNo">466</span> * {@link #setRowPrefixFilter(byte[])}. The 'trailing 0' will not yield the desired result.<a name="line.466"></a> -<span class="sourceLineNo">467</span> * </p><a name="line.467"></a> -<span class="sourceLineNo">468</span> * @param stopRow row to end at (exclusive)<a name="line.468"></a> -<span class="sourceLineNo">469</span> * @return this<a name="line.469"></a> -<span class="sourceLineNo">470</span> * @throws IllegalArgumentException if stopRow does not meet criteria for a row key (when length<a name="line.470"></a> -<span class="sourceLineNo">471</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.471"></a> -<span class="sourceLineNo">472</span> * @deprecated use {@link #withStartRow(byte[])} instead. This method may change the inclusive of<a name="line.472"></a> -<span class="sourceLineNo">473</span> * the stop row to keep compatible with the old behavior.<a name="line.473"></a> -<span class="sourceLineNo">474</span> */<a name="line.474"></a> -<span class="sourceLineNo">475</span> @Deprecated<a name="line.475"></a> -<span class="sourceLineNo">476</span> public Scan setStopRow(byte[] stopRow) {<a name="line.476"></a> -<span class="sourceLineNo">477</span> withStopRow(stopRow);<a name="line.477"></a> -<span class="sourceLineNo">478</span> if (ClientUtil.areScanStartRowAndStopRowEqual(this.startRow, this.stopRow)) {<a name="line.478"></a> -<span class="sourceLineNo">479</span> // for keeping the old behavior that a scan with the same start and stop row is a get scan.<a name="line.479"></a> -<span class="sourceLineNo">480</span> this.includeStopRow = true;<a name="line.480"></a> -<span class="sourceLineNo">481</span> }<a name="line.481"></a> -<span class="sourceLineNo">482</span> return this;<a name="line.482"></a> -<span class="sourceLineNo">483</span> }<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> * Set the stop row of the scan.<a name="line.486"></a> -<span class="sourceLineNo">487</span> * <p><a name="line.487"></a> -<span class="sourceLineNo">488</span> * The scan will include rows that are lexicographically less than the provided stopRow.<a name="line.488"></a> -<span class="sourceLineNo">489</span> * <p><a name="line.489"></a> -<span class="sourceLineNo">490</span> * <b>Note:</b> When doing a filter for a rowKey <u>Prefix</u> use<a name="line.490"></a> -<span class="sourceLineNo">491</span> * {@link #setRowPrefixFilter(byte[])}. The 'trailing 0' will not yield the desired result.<a name="line.491"></a> -<span class="sourceLineNo">492</span> * </p><a name="line.492"></a> -<span class="sourceLineNo">493</span> * @param stopRow row to end at (exclusive)<a name="line.493"></a> -<span class="sourceLineNo">494</span> * @return this<a name="line.494"></a> -<span class="sourceLineNo">495</span> * @throws IllegalArgumentException if stopRow does not meet criteria for a row key (when length<a name="line.495"></a> -<span class="sourceLineNo">496</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.496"></a> -<span class="sourceLineNo">497</span> */<a name="line.497"></a> -<span class="sourceLineNo">498</span> public Scan withStopRow(byte[] stopRow) {<a name="line.498"></a> -<span class="sourceLineNo">499</span> return withStopRow(stopRow, false);<a name="line.499"></a> -<span class="sourceLineNo">500</span> }<a name="line.500"></a> -<span class="sourceLineNo">501</span><a name="line.501"></a> -<span class="sourceLineNo">502</span> /**<a name="line.502"></a> -<span class="sourceLineNo">503</span> * Set the stop row of the scan.<a name="line.503"></a> -<span class="sourceLineNo">504</span> * <p><a name="line.504"></a> -<span class="sourceLineNo">505</span> * The scan will include rows that are lexicographically less than (or equal to if<a name="line.505"></a> -<span class="sourceLineNo">506</span> * {@code inclusive} is {@code true}) the provided stopRow.<a name="line.506"></a> -<span class="sourceLineNo">507</span> * @param stopRow row to end at<a name="line.507"></a> -<span class="sourceLineNo">508</span> * @param inclusive whether we should include the stop row when scan<a name="line.508"></a> -<span class="sourceLineNo">509</span> * @return this<a name="line.509"></a> -<span class="sourceLineNo">510</span> * @throws IllegalArgumentException if stopRow does not meet criteria for a row key (when length<a name="line.510"></a> -<span class="sourceLineNo">511</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.511"></a> -<span class="sourceLineNo">512</span> */<a name="line.512"></a> -<span class="sourceLineNo">513</span> public Scan withStopRow(byte[] stopRow, boolean inclusive) {<a name="line.513"></a> -<span class="sourceLineNo">514</span> if (Bytes.len(stopRow) > HConstants.MAX_ROW_LENGTH) {<a name="line.514"></a> -<span class="sourceLineNo">515</span> throw new IllegalArgumentException("stopRow's length must be less than or equal to "<a name="line.515"></a> -<span class="sourceLineNo">516</span> + HConstants.MAX_ROW_LENGTH + " to meet the criteria" + " for a row key.");<a name="line.516"></a> -<span class="sourceLineNo">517</span> }<a name="line.517"></a> -<span class="sourceLineNo">518</span> this.stopRow = stopRow;<a name="line.518"></a> -<span class="sourceLineNo">519</span> this.includeStopRow = inclusive;<a name="line.519"></a> -<span class="sourceLineNo">520</span> return this;<a name="line.520"></a> -<span class="sourceLineNo">521</span> }<a name="line.521"></a> -<span class="sourceLineNo">522</span><a name="line.522"></a> -<span class="sourceLineNo">523</span> /**<a name="line.523"></a> -<span class="sourceLineNo">524</span> * <p>Set a filter (using stopRow and startRow) so the result set only contains rows where the<a name="line.524"></a> -<span class="sourceLineNo">525</span> * rowKey starts with the specified prefix.</p><a name="line.525"></a> -<span class="sourceLineNo">526</span> * <p>This is a utility method that converts the desired rowPrefix into the appropriate values<a name="line.526"></a> -<span class="sourceLineNo">527</span> * for the startRow and stopRow to achieve the desired result.</p><a name="line.527"></a> -<span class="sourceLineNo">528</span> * <p>This can safely be used in combination with setFilter.</p><a name="line.528"></a> -<span class="sourceLineNo">529</span> * <p><b>NOTE: Doing a {@link #setStartRow(byte[])} and/or {@link #setStopRow(byte[])}<a name="line.529"></a> -<span class="sourceLineNo">530</span> * after this method will yield undefined results.</b></p><a name="line.530"></a> -<span class="sourceLineNo">531</span> * @param rowPrefix the prefix all rows must start with. (Set <i>null</i> to remove the filter.)<a name="line.531"></a> -<span class="sourceLineNo">532</span> * @return this<a name="line.532"></a> -<span class="sourceLineNo">533</span> */<a name="line.533"></a> -<span class="sourceLineNo">534</span> public Scan setRowPrefixFilter(byte[] rowPrefix) {<a name="line.534"></a> -<span class="sourceLineNo">535</span> if (rowPrefix == null) {<a name="line.535"></a> -<span class="sourceLineNo">536</span> setStartRow(HConstants.EMPTY_START_ROW);<a name="line.536"></a> -<span class="sourceLineNo">537</span> setStopRow(HConstants.EMPTY_END_ROW);<a name="line.537"></a> -<span class="sourceLineNo">538</span> } else {<a name="line.538"></a> -<span class="sourceLineNo">539</span> this.setStartRow(rowPrefix);<a name="line.539"></a> -<span class="sourceLineNo">540</span> this.setStopRow(calculateTheClosestNextRowKeyForPrefix(rowPrefix));<a name="line.540"></a> -<span class="sourceLineNo">541</span> }<a name="line.541"></a> -<span class="sourceLineNo">542</span> return this;<a name="line.542"></a> -<span class="sourceLineNo">543</span> }<a name="line.543"></a> -<span class="sourceLineNo">544</span><a name="line.544"></a> -<span class="sourceLineNo">545</span> /**<a name="line.545"></a> -<span class="sourceLineNo">546</span> * <p>When scanning for a prefix the scan should stop immediately after the the last row that<a name="line.546"></a> -<span class="sourceLineNo">547</span> * has the specified prefix. This method calculates the closest next rowKey immediately following<a name="line.547"></a> -<span class="sourceLineNo">548</span> * the given rowKeyPrefix.</p><a name="line.548"></a> -<span class="sourceLineNo">549</span> * <p><b>IMPORTANT: This converts a rowKey<u>Prefix</u> into a rowKey</b>.</p><a name="line.549"></a> -<span class="sourceLineNo">550</span> * <p>If the prefix is an 'ASCII' string put into a byte[] then this is easy because you can<a name="line.550"></a> -<span class="sourceLineNo">551</span> * simply increment the last byte of the array.<a name="line.551"></a> -<span class="sourceLineNo">552</span> * But if your application uses real binary rowids you may run into the scenario that your<a name="line.552"></a> -<span class="sourceLineNo">553</span> * prefix is something like:</p><a name="line.553"></a> -<span class="sourceLineNo">554</span> * &nbsp;&nbsp;&nbsp;<b>{ 0x12, 0x23, 0xFF, 0xFF }</b><br/><a name="line.554"></a> -<span class="sourceLineNo">555</span> * Then this stopRow needs to be fed into the actual scan<br/><a name="line.555"></a> -<span class="sourceLineNo">556</span> * &nbsp;&nbsp;&nbsp;<b>{ 0x12, 0x24 }</b> (Notice that it is shorter now)<br/><a name="line.556"></a> -<span class="sourceLineNo">557</span> * This method calculates the correct stop row value for this usecase.<a name="line.557"></a> -<span class="sourceLineNo">558</span> *<a name="line.558"></a> -<span class="sourceLineNo">559</span> * @param rowKeyPrefix the rowKey<u>Prefix</u>.<a name="line.559"></a> -<span class="sourceLineNo">560</span> * @return the closest next rowKey immediately following the given rowKeyPrefix.<a name="line.560"></a> -<span class="sourceLineNo">561</span> */<a name="line.561"></a> -<span class="sourceLineNo">562</span> private byte[] calculateTheClosestNextRowKeyForPrefix(byte[] rowKeyPrefix) {<a name="line.562"></a> -<span class="sourceLineNo">563</span> // Essentially we are treating it like an 'unsigned very very long' and doing +1 manually.<a name="line.563"></a> -<span class="sourceLineNo">564</span> // Search for the place where the trailing 0xFFs start<a name="line.564"></a> -<span class="sourceLineNo">565</span> int offset = rowKeyPrefix.length;<a name="line.565"></a> -<span class="sourceLineNo">566</span> while (offset > 0) {<a name="line.566"></a> -<span class="sourceLineNo">567</span> if (rowKeyPrefix[offset - 1] != (byte) 0xFF) {<a name="line.567"></a> -<span class="sourceLineNo">568</span> break;<a name="line.568"></a> -<span class="sourceLineNo">569</span> }<a name="line.569"></a> -<span class="sourceLineNo">570</span> offset--;<a name="line.570"></a> -<span class="sourceLineNo">571</span> }<a name="line.571"></a> -<span class="sourceLineNo">572</span><a name="line.572"></a> -<span class="sourceLineNo">573</span> if (offset == 0) {<a name="line.573"></a> -<span class="sourceLineNo">574</span> // We got an 0xFFFF... (only FFs) stopRow value which is<a name="line.574"></a> -<span class="sourceLineNo">575</span> // the last possible prefix before the end of the table.<a name="line.575"></a> -<span class="sourceLineNo">576</span> // So set it to stop at the 'end of the table'<a name="line.576"></a> -<span class="sourceLineNo">577</span> return HConstants.EMPTY_END_ROW;<a name="line.577"></a> -<span class="sourceLineNo">578</span> }<a name="line.578"></a> -<span class="sourceLineNo">579</span><a name="line.579"></a> -<span class="sourceLineNo">580</span> // Copy the right length of the original<a name="line.580"></a> -<span class="sourceLineNo">581</span> byte[] newStopRow = Arrays.copyOfRange(rowKeyPrefix, 0, offset);<a name="line.581"></a> -<span class="sourceLineNo">582</span> // And increment the last one<a name="line.582"></a> -<span class="sourceLineNo">583</span> newStopRow[newStopRow.length - 1]++;<a name="line.583"></a> -<span class="sourceLineNo">584</span> return newStopRow;<a name="line.584"></a> -<span class="sourceLineNo">585</span> }<a name="line.585"></a> -<span class="sourceLineNo">586</span><a name="line.586"></a> -<span class="sourceLineNo">587</span> /**<a name="line.587"></a> -<span class="sourceLineNo">588</span> * Get all available versions.<a name="line.588"></a> -<span class="sourceLineNo">589</span> * @return this<a name="line.589"></a> -<span class="sourceLineNo">590</span> */<a name="line.590"></a> -<span class="sourceLineNo">591</span> public Scan setMaxVersions() {<a name="line.591"></a> -<span class="sourceLineNo">592</span> this.maxVersions = Integer.MAX_VALUE;<a name="line.592"></a> -<span class="sourceLineNo">593</span> return this;<a name="line.593"></a> -<span class="sourceLineNo">594</span> }<a name="line.594"></a> -<span class="sourceLineNo">595</span><a name="line.595"></a> -<span class="sourceLineNo">596</span> /**<a name="line.596"></a> -<span class="sourceLineNo">597</span> * Get up to the specified number of versions of each column.<a name="line.597"></a> -<span class="sourceLineNo">598</span> * @param maxVersions maximum versions for each column<a name="line.598"></a> -<span class="sourceLineNo">599</span> * @return this<a name="line.599"></a> -<span class="sourceLineNo">600</span> */<a name="line.600"></a> -<span class="sourceLineNo">601</span> public Scan setMaxVersions(int maxVersions) {<a name="line.601"></a> -<span class="sourceLineNo">602</span> this.maxVersions = maxVersions;<a name="line.602"></a> -<span class="sourceLineNo">603</span> return this;<a name="line.603"></a> -<span class="sourceLineNo">604</span> }<a name="line.604"></a> -<span class="sourceLineNo">605</span><a name="line.605"></a> -<span class="sourceLineNo">606</span> /**<a name="line.606"></a> -<span class="sourceLineNo">607</span> * Set the maximum number of cells to return for each call to next(). Callers should be aware<a name="line.607"></a> -<span class="sourceLineNo">608</span> * that this is not equivalent to calling {@link #setAllowPartialResults(boolean)}.<a name="line.608"></a> -<span class="sourceLineNo">609</span> * If you don't allow partial results, the number of cells in each Result must equal to your<a name="line.609"></a> -<span class="sourceLineNo">610</span> * batch setting unless it is the last Result for current row. So this method is helpful in paging<a name="line.610"></a> -<span class="sourceLineNo">611</span> * queries. If you just want to prevent OOM at client, use setAllowPartialResults(true) is better.<a name="line.611"></a> -<span class="sourceLineNo">612</span> * @param batch the maximum number of values<a name="line.612"></a> -<span class="sourceLineNo">613</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.613"></a> -<span class="sourceLineNo">614</span> */<a name="line.614"></a> -<span class="sourceLineNo">615</span> public Scan setBatch(int batch) {<a name="line.615"></a> -<span class="sourceLineNo">616</span> if (this.hasFilter() && this.filter.hasFilterRow()) {<a name="line.616"></a> -<span class="sourceLineNo">617</span> throw new IncompatibleFilterException(<a name="line.617"></a> -<span class="sourceLineNo">618</span> "Cannot set batch on a scan using a filter" +<a name="line.618"></a> -<span class="sourceLineNo">619</span> " that returns true for filter.hasFilterRow");<a name="line.619"></a> -<span class="sourceLineNo">620</span> }<a name="line.620"></a> -<span class="sourceLineNo">621</span> this.batch = batch;<a name="line.621"></a> -<span class="sourceLineNo">622</span> return this;<a name="line.622"></a> -<span class="sourceLineNo">623</span> }<a name="line.623"></a> -<span class="sourceLineNo">624</span><a name="line.624"></a> -<span class="sourceLineNo">625</span> /**<a name="line.625"></a> -<span class="sourceLineNo">626</span> * Set the maximum number of values to return per row per Column Family<a name="line.626"></a> -<span class="sourceLineNo">627</span> * @param limit the maximum number of values returned / row / CF<a name="line.627"></a> -<span class="sourceLineNo">628</span> */<a name="line.628"></a> -<span class="sourceLineNo">629</span> public Scan setMaxResultsPerColumnFamily(int limit) {<a name="line.629"></a> -<span class="sourceLineNo">630</span> this.storeLimit = limit;<a name="line.630"></a> -<span class="sourceLineNo">631</span> return this;<a name="line.631"></a> -<span class="sourceLineNo">632</span> }<a name="line.632"></a> -<span class="sourceLineNo">633</span><a name="line.633"></a> -<span class="sourceLineNo">634</span> /**<a name="line.634"></a> -<span class="sourceLineNo">635</span> * Set offset for the row per Column Family.<a name="line.635"></a> -<span class="sourceLineNo">636</span> * @param offset is the number of kvs that will be skipped.<a name="line.636"></a> -<span class="sourceLineNo">637</span> */<a name="line.637"></a> -<span class="sourceLineNo">638</span> public Scan setRowOffsetPerColumnFamily(int offset) {<a name="line.638"></a> -<span class="sourceLineNo">639</span> this.storeOffset = offset;<a name="line.639"></a> -<span class="sourceLineNo">640</span> return this;<a name="line.640"></a> -<span class="sourceLineNo">641</span> }<a name="line.641"></a> -<span class="sourceLineNo">642</span><a name="line.642"></a> -<span class="sourceLineNo">643</span> /**<a name="line.643"></a> -<span class="sourceLineNo">644</span> * Set the number of rows for caching that will be passed to scanners.<a name="line.644"></a> -<span class="sourceLineNo">645</span> * If not set, the Configuration setting {@link HConstants#HBASE_CLIENT_SCANNER_CACHING} will<a name="line.645"></a> -<span class="sourceLineNo">646</span> * apply.<a name="line.646"></a> -<span class="sourceLineNo">647</span> * Higher caching values will enable faster scanners but will use more memory.<a name="line.647"></a> -<span class="sourceLineNo">648</span> * @param caching the number of rows for caching<a name="line.648"></a> -<span class="sourceLineNo">649</span> */<a name="line.649"></a> -<span class="sourceLineNo">650</span> public Scan setCaching(int caching) {<a name="line.650"></a> -<span class="sourceLineNo">651</span> this.caching = caching;<a name="line.651"></a> -<span class="sourceLineNo">652</span> return this;<a name="line.652"></a> -<span class="sourceLineNo">653</span> }<a name="line.653"></a> -<span class="sourceLineNo">654</span><a name="line.654"></a> -<span class="sourceLineNo">655</span> /**<a name="line.655"></a> -<span class="sourceLineNo">656</span> * @return the maximum result size in bytes. See {@link #setMaxResultSize(long)}<a name="line.656"></a> -<span class="sourceLineNo">657</span> */<a name="line.657"></a> -<span class="sourceLineNo">658</span> public long getMaxResultSize() {<a name="line.658"></a> -<span class="sourceLineNo">659</span> return maxResultSize;<a name="line.659"></a> -<span class="sourceLineNo">660</span> }<a name="line.660"></a> -<span class="sourceLineNo">661</span><a name="line.661"></a> -<span class="sourceLineNo">662</span> /**<a name="line.662"></a> -<span class="sourceLineNo">663</span> * Set the maximum result size. The default is -1; this means that no specific<a name="line.663"></a> -<span class="sourceLineNo">664</span> * maximum result size will be set for this scan, and the global configured<a name="line.664"></a> -<span class="sourceLineNo">665</span> * value will be used instead. (Defaults to unlimited).<a name="line.665"></a> -<span class="sourceLineNo">666</span> *<a name="line.666"></a> -<span class="sourceLineNo">667</span> * @param maxResultSize The maximum result size in bytes.<a name="line.667"></a> -<span class="sourceLineNo">668</span> */<a name="line.668"></a> -<span class="sourceLineNo">669</span> public Scan setMaxResultSize(long maxResultSize) {<a name="line.669"></a> -<span class="sourceLineNo">670</span> this.maxResultSize = maxResultSize;<a name="line.670"></a> -<span class="sourceLineNo">671</span> return this;<a name="line.671"></a> -<span class="sourceLineNo">672</span> }<a name="line.672"></a> -<span class="sourceLineNo">673</span><a name="line.673"></a> -<span class="sourceLineNo">674</span> @Override<a name="line.674"></a> -<span class="sourceLineNo">675</span> public Scan setFilter(Filter filter) {<a name="line.675"></a> -<span class="sourceLineNo">676</span> super.setFilter(filter);<a name="line.676"></a> -<span class="sourceLineNo">677</span> return this;<a name="line.677"></a> -<span class="sourceLineNo">678</span> }<a name="line.678"></a> -<span class="sourceLineNo">679</span><a name="line.679"></a> -<span class="sourceLineNo">680</span> /**<a name="line.680"></a> -<span class="sourceLineNo">681</span> * Setting the familyMap<a name="line.681"></a> -<span class="sourceLineNo">682</span> * @param familyMap map of family to qualifier<a name="line.682"></a> -<span class="sourceLineNo">683</span> * @return this<a name="line.683"></a> -<span class="sourceLineNo">684</span> */<a name="line.684"></a> -<span class="sourceLineNo">685</span> public Scan setFamilyMap(Map<byte [], NavigableSet<byte []>> familyMap) {<a name="line.685"></a> -<span class="sourceLineNo">686</span> this.familyMap = familyMap;<a name="line.686"></a> -<span class="sourceLineNo">687</span> return this;<a name="line.687"></a> -<span class="sourceLineNo">688</span> }<a name="line.688"></a> -<span class="sourceLineNo">689</span><a name="line.689"></a> -<span class="sourceLineNo">690</span> /**<a name="line.690"></a> -<span class="sourceLineNo">691</span> * Getting the familyMap<a name="line.691"></a> -<span class="sourceLineNo">692</span> * @return familyMap<a name="line.692"></a> -<span class="sourceLineNo">693</span> */<a name="line.693"></a> -<span class="sourceLineNo">694</span> public Map<byte [], NavigableSet<byte []>> getFamilyMap() {<a name="line.694"></a> -<span class="sourceLineNo">695</span> return this.familyMap;<a name="line.695"></a> -<span class="sourceLineNo">696</span> }<a name="line.696"></a> -<span class="sourceLineNo">697</span><a name="line.697"></a> -<span class="sourceLineNo">698</span> /**<a name="line.698"></a> -<span class="sourceLineNo">699</span> * @return the number of families in familyMap<a name="line.699"></a> -<span class="sourceLineNo">700</span> */<a name="line.700"></a> -<span class="sourceLineNo">701</span> public int numFamilies() {<a name="line.701"></a> -<span class="sourceLineNo">702</span> if(hasFamilies()) {<a name="line.702"></a> -<span class="sourceLineNo">703</span> return this.familyMap.size();<a name="line.703"></a> -<span class="sourceLineNo">704</span> }<a name="line.704"></a> -<span class="sourceLineNo">705</span> return 0;<a name="line.705"></a> -<span class="sourceLineNo">706</span> }<a name="line.706"></a> -<span class="sourceLineNo">707</span><a name="line.707"></a> -<span class="sourceLineNo">708</span> /**<a name="line.708"></a> -<span class="sourceLineNo">709</span> * @return true if familyMap is non empty, false otherwise<a name="line.709"></a> -<span class="sourceLineNo">710</span> */<a name="line.710"></a> -<span class="sourceLineNo">711</span> public boolean hasFamilies() {<a name="line.711"></a> -<span class="sourceLineNo">712</span> return !this.familyMap.isEmpty();<a name="line.712"></a> -<span class="sourceLineNo">713</span> }<a name="line.713"></a> -<span class="sourceLineNo">714</span><a name="line.714"></a> -<span class="sourceLineNo">715</span> /**<a name="line.715"></a> -<span class="sourceLineNo">716</span> * @return the keys of the familyMap<a name="line.716"></a> -<span class="sourceLineNo">717</span> */<a name="line.717"></a> -<span class="sourceLineNo">718</span> public byte[][] getFamilies() {<a name="line.718"></a> -<span class="sourceLineNo">719</span> if(hasFamilies()) {<a name="line.719"></a> -<span class="sourceLineNo">720</span> return this.familyMap.keySet().toArray(new byte[0][0]);<a name="line.720"></a> -<span class="sourceLineNo">721</span> }<a name="line.721"></a> -<span class="sourceLineNo">722</span> return null;<a name="line.722"></a> -<span class="sourceLineNo">723</span> }<a name="line.723"></a> -<span class="sourceLineNo">724</span><a name="line.724"></a> -<span class="sourceLineNo">725</span> /**<a name="line.725"></a> -<span class="sourceLineNo">726</span> * @return the startrow<a name="line.726"></a> -<span class="sourceLineNo">727</span> */<a name="line.727"></a> -<span class="sourceLineNo">728</span> public byte [] getStartRow() {<a name="line.728"></a> -<span class="sourceLineNo">729</span> return this.startRow;<a name="line.729"></a> -<span class="sourceLineNo">730</span> }<a name="line.730"></a> -<span class="sourceLineNo">731</span><a name="line.731"></a> -<span class="sourceLineNo">732</span> /**<a name="line.732"></a> -<span class="sourceLineNo">733</span> * @return if we should include start row when scan<a name="line.733"></a> -<span class="sourceLineNo">734</span> */<a name="line.734"></a> -<span class="sourceLineNo">735</span> public boolean includeStartRow() {<a name="line.735"></a> -<span class="sourceLineNo">736</span> return includeStartRow;<a name="line.736"></a> -<span class="sourceLineNo">737</span> }<a name="line.737"></a> -<span class="sourceLineNo">738</span><a name="line.738"></a> -<span class="sourceLineNo">739</span> /**<a name="line.739"></a> -<span class="sourceLineNo">740</span> * @return the stoprow<a name="line.740"></a> -<span class="sourceLineNo">741</span> */<a name="line.741"></a> -<span class="sourceLineNo">742</span> public byte[] getStopRow() {<a name="line.742"></a> -<span class="sourceLineNo">743</span> return this.stopRow;<a name="line.743"></a> -<span class="sourceLineNo">744</span> }<a name="line.744"></a> -<span class="sourceLineNo">745</span><a name="line.745"></a> -<span class="sourceLineNo">746</span> /**<a name="line.746"></a> -<span class="sourceLineNo">747</span> * @return if we should include stop row when scan<a name="line.747"></a> -<span class="sourceLineNo">748</span> */<a name="line.748"></a> -<span class="sourceLineNo">749</span> public boolean includeStopRow() {<a name="line.749"></a> -<span class="sourceLineNo">750</span> return includeStopRow;<a name="line.750"></a> -<span class="sourceLineNo">751</span> }<a name="line.751"></a> -<span class="sourceLineNo">752</span><a name="line.752"></a> -<span class="sourceLineNo">753</span> /**<a name="line.753"></a> -<span class="sourceLineNo">754</span> * @return the max number of versions to fetch<a name="line.754"></a> -<span class="sourceLineNo">755</span> */<a name="line.755"></a> -<span class="sourceLineNo">756</span> public int getMaxVersions() {<a name="line.756"></a> -<span class="sourceLineNo">757</span> return this.maxVersions;<a name="line.757"></a> -<span class="sourceLineNo">758</span> }<a name="line.758"></a> -<span class="sourceLineNo">759</span><a name="line.759"></a> -<span class="sourceLineNo">760</span> /**<a name="line.760"></a> -<span class="sourceLineNo">761</span> * @return maximum number of values to return for a single call to next()<a name="line.761"></a> -<span class="sourceLineNo">762</span> */<a name="line.762"></a> -<span class="sourceLineNo">763</span> public int getBatch() {<a name="line.763"></a> -<span class="sourceLineNo">764</span> return this.batch;<a name="line.764"></a> -<span class="sourceLineNo">765</span> }<a name="line.765"></a> -<span class="sourceLineNo">766</span><a name="line.766"></a> -<span class="sourceLineNo">767</span> /**<a name="line.767"></a> -<span class="sourceLineNo">768</span> * @return maximum number of values to return per row per CF<a name="line.768"></a> -<span class="sourceLineNo">769</span> */<a name="line.769"></a> -<span class="sourceLineNo">770</span> public int getMaxResultsPerColumnFamily() {<a name="line.770"></a> -<span class="sourceLineNo">771</span> return this.storeLimit;<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> * Method for retrieving the scan's offset per row per column<a name="line.775"></a> -<span class="sourceLineNo">776</span> * family (#kvs to be skipped)<a name="line.776"></a> -<span class="sourceLineNo">777</span> * @return row offset<a name="line.777"></a> -<span class="sourceLineNo">778</span> */<a name="line.778"></a> -<span class="sourceLineNo">779</span> public int getRowOffsetPerColumnFamily() {<a name="line.779"></a> -<span class="sourceLineNo">780</span> return this.storeOffset;<a name="line.780"></a> -<span class="sourceLineNo">781</span> }<a name="line.781"></a> -<span class="sourceLineNo">782</span><a name="line.782"></a> -<span class="sourceLineNo">783</span> /**<a name="line.783"></a> -<span class="sourceLineNo">784</span> * @return caching the number of rows fetched when calling next on a scanner<a name="line.784"></a> -<span class="sourceLineNo">785</span> */<a name="line.785"></a> -<span class="sourceLineNo">786</span> public int getCaching() {<a name="line.786"></a> -<span class="sourceLineNo">787</span> return this.caching;<a name="line.787"></a> -<span class="sourceLineNo">788</span> }<a name="line.788"></a> -<span class="sourceLineNo">789</span><a name="line.789"></a> -<span class="sourceLineNo">790</span> /**<a name="line.790"></a> -<span class="sourceLineNo">791</span> * @return RowFilter<a name="line.791"></a> -<span class="sourceLineNo">792</span> */<a name="line.792"></a> -<span class="sourceLineNo">793</span> @Override<a name="line.793"></a> -<span class="sourceLineNo">794</span> public Filter getFilter() {<a name="line.794"></a> -<span class="sourceLineNo">795</span> return filter;<a name="line.795"></a> -<span class="sourceLineNo">796</span> }<a name="line.796"></a> -<span class="sourceLineNo">797</span><a name="line.797"></a> -<span class="sourceLineNo">798</span> /**<a name="line.798"></a> -<span class="sourceLineNo">799</span> * @return true is a filter has been specified, false if not<a name="line.799"></a> -<span class="sourceLineNo">800</span> */<a name="line.800"></a> -<span class="sourceLineNo">801</span> public boolean hasFilter() {<a name="line.801"></a> -<span class="sourceLineNo">802</span> return filter != null;<a name="line.802"></a> -<span class="sourceLineNo">803</span> }<a name="line.803"></a> -<span class="sourceLineNo">804</span><a name="line.804"></a> -<span class="sourceLineNo">805</span> /**<a name="line.805"></a> -<span class="sourceLineNo">806</span> * Set whether blocks should be cached for this Scan.<a name="line.806"></a> -<span class="sourceLineNo">807</span> * <p><a name="line.807"></a> -<span class="sourceLineNo">808</span> * This is true by default. When true, default settings of the table and<a name="line.808"></a> -<span class="sourceLineNo">809</span> * family are used (this will never override caching blocks if the block<a name="line.809"></a> -<span class="sourceLineNo">810</span> * cache is disabled for that family or entirely).<a name="line.810"></a> -<span class="sourceLineNo">811</span> *<a name="line.811"></a> -<span class="sourceLineNo">812</span> * @param cacheBlocks if false, default settings are overridden and blocks<a name="line.812"></a> -<span class="sourceLineNo">813</span> * will not be cached<a name="line.813"></a> -<span class="sourceLineNo">814</span> */<a name="line.814"></a> -<span class="sourceLineNo">815</span> public Scan setCacheBlocks(boolean cacheBlocks) {<a name="line.815"></a> -<span class="sourceLineNo">816</span> this.cacheBlocks = cacheBlocks;<a name="line.816"></a> -<span class="sourceLineNo">817</span> return this;<a name="line.817"></a> -<span class="sourceLineNo">818</span> }<a name="line.818"></a> -<span class="sourceLineNo">819</span><a name="line.819"></a> -<span class="sourceLineNo">820</span> /**<a name="line.820"></a> -<span class="sourceLineNo">821</span> * Get whether blocks should be cached for this Scan.<a name="line.821"></a> -<span class="sourceLineNo">822</span> * @return true if default caching should be used, false if blocks should not<a name="line.822"></a> -<span class="sourceLineNo">823</span> * be cached<a name="line.823"></a> -<span class="sourceLineNo">824</span> */<a name="line.824"></a> -<span class="sourceLineNo">825</span> public boolean getCacheBlocks() {<a name="line.825"></a> -<span class="sourceLineNo">826</span> return cacheBlocks;<a name="line.826"></a> -<span class="sourceLineNo">827</span> }<a name="line.827"></a> -<span class="sourceLineNo">828</span><a name="line.828"></a> -<span class="sourceLineNo">829</span> /**<a name="line.829"></a> -<span class="sourceLineNo">830</span> * Set whether this scan is a reversed one<a name="line.830"></a> -<span class="sourceLineNo">831</span> * <p><a name="line.831"></a> -<span class="sourceLineNo">832</span> * This is false by default which means forward(normal) scan.<a name="line.832"></a> -<span class="sourceLineNo">833</span> *<a name="line.833"></a> -<span class="sourceLineNo">834</span> * @param reversed if true, scan will be backward order<a name="line.834"></a> -<span class="sourceLineNo">835</span> * @return this<a name="line.835"></a> -<span class="sourceLineNo">836</span> */<a name="line.836"></a> -<span class="sourceLineNo">837</span> public Scan setReversed(boolean reversed) {<a name="line.837"></a> -<span class="sourceLineNo">838</span> this.reversed = reversed;<a name="line.838"></a> -<span class="sourceLineNo">839</span> return this;<a name="line.839"></a> -<span class="sourceLineNo">840</span> }<a name="line.840"></a> -<span class="sourceLineNo">841</span><a name="line.841"></a> -<span class="sourceLineNo">842</span> /**<a name="line.842"></a> -<span class="sourceLineNo">843</span> * Get whether this scan is a reversed one.<a name="line.843"></a> -<span class="sourceLineNo">844</span> * @return true if backward scan, false if forward(default) scan<a name="line.844"></a> -<span class="sourceLineNo">845</span> */<a name="line.845"></a> -<span class="sourceLineNo">846</span> public boolean isReversed() {<a name="line.846"></a> -<span class="sourceLineNo">847</span> return reversed;<a name="line.847"></a> -<span class="sourceLineNo">848</span> }<a name="line.848"></a> -<span class="sourceLineNo">849</span><a name="line.849"></a> -<span class="sourceLineNo">850</span> /**<a name="line.850"></a> -<span class="sourceLineNo">851</span> * Setting whether the caller wants to see the partial results when server returns<a name="line.851"></a> -<span class="sourceLineNo">852</span> * less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client.<a name="line.852"></a> -<span class="sourceLineNo">853</span> * By default this value is false and the complete results will be assembled client side<a name="line.853"></a> -<span class="sourceLineNo">854</span> * before being delivered to the caller.<a name="line.854"></a> -<span class="sourceLineNo">855</span> * @param allowPartialResults<a name="line.855"></a> -<span class="sourceLineNo">856</span> * @return this<a name="line.856"></a> -<span class="sourceLineNo">857</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.857"></a> -<span class="sourceLineNo">858</span> * @see #setBatch(int)<a name="line.858"></a> -<span class="sourceLineNo">859</span> */<a name="line.859"></a> -<span class="sourceLineNo">860</span> public Scan setAllowPartialResults(final boolean allowPartialResults) {<a name="line.860"></a> -<span class="sourceLineNo">861</span> this.allowPartialResults = allowPartialResults;<a name="line.861"></a> -<span class="sourceLineNo">862</span> return this;<a name="line.862"></a> -<span class="sourceLineNo">863</span> }<a name="line.863"></a> -<span class="sourceLineNo">864</span><a name="line.864"></a> -<span class="sourceLineNo">865</span> /**<a name="line.865"></a> -<span class="sourceLineNo">866</span> * @return true when the constructor of this scan understands that the results they will see may<a name="line.866"></a> -<span class="sourceLineNo">867</span> * only represent a partial portion of a row. The entire row would be retrieved by<a name="line.867"></a> -<span class="sourceLineNo">868</span> * subsequent calls to {@link ResultScanner#next()}<a name="line.868"></a> -<span class="sourceLineNo">869</span> */<a name="line.869"></a> -<span class="sourceLineNo">870</span> public boolean getAllowPartialResults() {<a name="line.870"></a> -<span class="sourceLineNo">871</span> return allowPartialResults;<a name="line.871"></a> -<span class="sourceLineNo">872</span> }<a name="line.872"></a> -<span class="sourceLineNo">873</span><a name="line.873"></a> -<span class="sourceLineNo">874</span> public Scan setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.874"></a> -<span class="sourceLineNo">875</span> return (Scan) super.setLoadColumnFamiliesOnDemand(value);<a name="line.875"></a> +<span class="sourceLineNo">304</span> for (Map.Entry<byte[], TimeRange> entry : get.getColumnFamilyTimeRange().entrySet()) {<a name="line.304"></a> +<span class="sourceLineNo">305</span> TimeRange tr = entry.getValue();<a name="line.305"></a> +<span class="sourceLineNo">306</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.306"></a> +<span class="sourceLineNo">307</span> }<a name="line.307"></a> +<span class="sourceLineNo">308</span> this.mvccReadPoint = -1L;<a name="line.308"></a> +<span class="sourceLineNo">309</span> }<a name="line.309"></a> +<span class="sourceLineNo">310</span><a name="line.310"></a> +<span class="sourceLineNo">311</span> public boolean isGetScan() {<a name="line.311"></a> +<span class="sourceLineNo">312</span> return includeStartRow && includeStopRow<a name="line.312"></a> +<span class="sourceLineNo">313</span> && ClientUtil.areScanStartRowAndStopRowEqual(this.startRow, this.stopRow);<a name="line.313"></a> +<span class="sourceLineNo">314</span> }<a name="line.314"></a> +<span class="sourceLineNo">315</span><a name="line.315"></a> +<span class="sourceLineNo">316</span> /**<a name="line.316"></a> +<span class="sourceLineNo">317</span> * Get all columns from the specified family.<a name="line.317"></a> +<span class="sourceLineNo">318</span> * <p><a name="line.318"></a> +<span class="sourceLineNo">319</span> * Overrides previous calls to addColumn for this family.<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @param family family name<a name="line.320"></a> +<span class="sourceLineNo">321</span> * @return this<a name="line.321"></a> +<span class="sourceLineNo">322</span> */<a name="line.322"></a> +<span class="sourceLineNo">323</span> public Scan addFamily(byte [] family) {<a name="line.323"></a> +<span class="sourceLineNo">324</span> familyMap.remove(family);<a name="line.324"></a> +<span class="sourceLineNo">325</span> familyMap.put(family, null);<a name="line.325"></a> +<span class="sourceLineNo">326</span> return this;<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> /**<a name="line.329"></a> +<span class="sourceLineNo">330</span> * Get the column from the specified family with the specified qualifier.<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <p><a name="line.331"></a> +<span class="sourceLineNo">332</span> * Overrides previous calls to addFamily for this family.<a name="line.332"></a> +<span class="sourceLineNo">333</span> * @param family family name<a name="line.333"></a> +<span class="sourceLineNo">334</span> * @param qualifier column qualifier<a name="line.334"></a> +<span class="sourceLineNo">335</span> * @return this<a name="line.335"></a> +<span class="sourceLineNo">336</span> */<a name="line.336"></a> +<span class="sourceLineNo">337</span> public Scan addColumn(byte [] family, byte [] qualifier) {<a name="line.337"></a> +<span class="sourceLineNo">338</span> NavigableSet<byte []> set = familyMap.get(family);<a name="line.338"></a> +<span class="sourceLineNo">339</span> if(set == null) {<a name="line.339"></a> +<span class="sourceLineNo">340</span> set = new TreeSet<>(Bytes.BYTES_COMPARATOR);<a name="line.340"></a> +<span class="sourceLineNo">341</span> }<a name="line.341"></a> +<span class="sourceLineNo">342</span> if (qualifier == null) {<a name="line.342"></a> +<span class="sourceLineNo">343</span> qualifier = HConstants.EMPTY_BYTE_ARRAY;<a name="line.343"></a> +<span class="sourceLineNo">344</span> }<a name="line.344"></a> +<span class="sourceLineNo">345</span> set.add(qualifier);<a name="line.345"></a> +<span class="sourceLineNo">346</span> familyMap.put(family, set);<a name="line.346"></a> +<span class="sourceLineNo">347</span> return this;<a name="line.347"></a> +<span class="sourceLineNo">348</span> }<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> * Set versions of columns only within the specified timestamp range,<a name="line.351"></a> +<span class="sourceLineNo">352</span> * [minStamp, maxStamp). Note, default maximum versions to return is 1. If<a name="line.352"></a> +<span class="sourceLineNo">353</span> * your time range spans more than one version and you want all versions<a name="line.353"></a> +<span class="sourceLineNo">354</span> * returned, up the number of versions beyond the default.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @param minStamp minimum timestamp value, inclusive<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @see #setMaxVersions()<a name="line.357"></a> +<span class="sourceLineNo">358</span> * @see #setMaxVersions(int)<a name="line.358"></a> +<span class="sourceLineNo">359</span> * @return this<a name="line.359"></a> +<span class="sourceLineNo">360</span> */<a name="line.360"></a> +<span class="sourceLineNo">361</span> @Override<a name="line.361"></a> +<span class="sourceLineNo">362</span> public Scan setTimeRange(long minStamp, long maxStamp) throws IOException {<a name="line.362"></a> +<span class="sourceLineNo">363</span> return (Scan) super.setTimeRange(minStamp, maxStamp);<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> * Set versions of columns only within the specified timestamp range,<a name="line.367"></a> +<span class="sourceLineNo">368</span> * @param tr Input TimeRange<a name="line.368"></a> +<span class="sourceLineNo">369</span> * @return this for invocation chaining<a name="line.369"></a> +<span class="sourceLineNo">370</span> */<a name="line.370"></a> +<span class="sourceLineNo">371</span> public Scan setTimeRange(TimeRange tr) {<a name="line.371"></a> +<span class="sourceLineNo">372</span> return (Scan) super.setTimeRange(tr);<a name="line.372"></a> +<span class="sourceLineNo">373</span> }<a name="line.373"></a> +<span class="sourceLineNo">374</span><a name="line.374"></a> +<span class="sourceLineNo">375</span> /**<a name="line.375"></a> +<span class="sourceLineNo">376</span> * Get versions of columns with the specified timestamp. Note, default maximum<a name="line.376"></a> +<span class="sourceLineNo">377</span> * versions to return is 1. If your time range spans more than one version<a name="line.377"></a> +<span class="sourceLineNo">378</span> * and you want all versions returned, up the number of versions beyond the<a name="line.378"></a> +<span class="sourceLineNo">379</span> * defaut.<a name="line.379"></a> +<span class="sourceLineNo">380</span> * @param timestamp version timestamp<a name="line.380"></a> +<span class="sourceLineNo">381</span> * @see #setMaxVersions()<a name="line.381"></a> +<span class="sourceLineNo">382</span> * @see #setMaxVersions(int)<a name="line.382"></a> +<span class="sourceLineNo">383</span> * @return this<a name="line.383"></a> +<span class="sourceLineNo">384</span> */<a name="line.384"></a> +<span class="sourceLineNo">385</span> public Scan setTimeStamp(long timestamp)<a name="line.385"></a> +<span class="sourceLineNo">386</span> throws IOException {<a name="line.386"></a> +<span class="sourceLineNo">387</span> try {<a name="line.387"></a> +<span class="sourceLineNo">388</span> super.setTimeRange(timestamp, timestamp + 1);<a name="line.388"></a> +<span class="sourceLineNo">389</span> } catch(Exception e) {<a name="line.389"></a> +<span class="sourceLineNo">390</span> // This should never happen, unless integer overflow or something extremely wrong...<a name="line.390"></a> +<span class="sourceLineNo">391</span> LOG.error("TimeRange failed, likely caused by integer overflow. ", e);<a name="line.391"></a> +<span class="sourceLineNo">392</span> throw e;<a name="line.392"></a> +<span class="sourceLineNo">393</span> }<a name="line.393"></a> +<span class="sourceLineNo">394</span> return this;<a name="line.394"></a> +<span class="sourceLineNo">395</span> }<a name="line.395"></a> +<span class="sourceLineNo">396</span><a name="line.396"></a> +<span class="sourceLineNo">397</span> @Override<a name="line.397"></a> +<span class="sourceLineNo">398</span> public Scan setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.398"></a> +<span class="sourceLineNo">399</span> return (Scan) super.setColumnFamilyTimeRange(cf, minStamp, maxStamp);<a name="line.399"></a> +<span class="sourceLineNo">400</span> }<a name="line.400"></a> +<span class="sourceLineNo">401</span><a name="line.401"></a> +<span class="sourceLineNo">402</span> @Override<a name="line.402"></a> +<span class="sourceLineNo">403</span> public Scan setColumnFamilyTimeRange(byte[] cf, TimeRange tr) {<a name="line.403"></a> +<span class="sourceLineNo">404</span> return (Scan) super.setColumnFamilyTimeRange(cf, tr);<a name="line.404"></a> +<span class="sourceLineNo">405</span> }<a name="line.405"></a> +<span class="sourceLineNo">406</span><a name="line.406"></a> +<span class="sourceLineNo">407</span> /**<a name="line.407"></a> +<span class="sourceLineNo">408</span> * Set the start row of the scan.<a name="line.408"></a> +<span class="sourceLineNo">409</span> * <p><a name="line.409"></a> +<span class="sourceLineNo">410</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.410"></a> +<span class="sourceLineNo">411</span> * specified row.<a name="line.411"></a> +<span class="sourceLineNo">412</span> * @param startRow row to start scanner at or after<a name="line.412"></a> +<span class="sourceLineNo">413</span> * @return this<a name="line.413"></a> +<span class="sourceLineNo">414</span> * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length<a name="line.414"></a> +<span class="sourceLineNo">415</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.415"></a> +<span class="sourceLineNo">416</span> * @deprecated use {@link #withStartRow(byte[])} instead. This method may change the inclusive of<a name="line.416"></a> +<span class="sourceLineNo">417</span> * the stop row to keep compatible with the old behavior.<a name="line.417"></a> +<span class="sourceLineNo">418</span> */<a name="line.418"></a> +<span class="sourceLineNo">419</span> @Deprecated<a name="line.419"></a> +<span class="sourceLineNo">420</span> public Scan setStartRow(byte[] startRow) {<a name="line.420"></a> +<span class="sourceLineNo">421</span> withStartRow(startRow);<a name="line.421"></a> +<span class="sourceLineNo">422</span> if (ClientUtil.areScanStartRowAndStopRowEqual(this.startRow, this.stopRow)) {<a name="line.422"></a> +<span class="sourceLineNo">423</span> // for keeping the old behavior that a scan with the same start and stop row is a get scan.<a name="line.423"></a> +<span class="sourceLineNo">424</span> this.includeStopRow = true;<a name="line.424"></a> +<span class="sourceLineNo">425</span> }<a name="line.425"></a> +<span class="sourceLineNo">426</span> return this;<a name="line.426"></a> +<span class="sourceLineNo">427</span> }<a name="line.427"></a> +<span class="sourceLineNo">428</span><a name="line.428"></a> +<span class="sourceLineNo">429</span> /**<a name="line.429"></a> +<span class="sourceLineNo">430</span> * Set the start row of the scan.<a name="line.430"></a> +<span class="sourceLineNo">431</span> * <p><a name="line.431"></a> +<span class="sourceLineNo">432</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.432"></a> +<span class="sourceLineNo">433</span> * specified row.<a name="line.433"></a> +<span class="sourceLineNo">434</span> * @param startRow row to start scanner at or after<a name="line.434"></a> +<span class="sourceLineNo">435</span> * @return this<a name="line.435"></a> +<span class="sourceLineNo">436</span>
<TRUNCATED>
