blob: 96f213357b57eb55871a7b2e7bcb2b6b69000475 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, class: ScannerContext, class: Builder">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.util.List;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">027</span><span id="line-27"></span>
<span class="source-line-no">028</span><span id="line-28">/**</span>
<span class="source-line-no">029</span><span id="line-29"> * ScannerContext instances encapsulate limit tracking AND progress towards those limits during</span>
<span class="source-line-no">030</span><span id="line-30"> * invocations of {@link InternalScanner#next(java.util.List)} and</span>
<span class="source-line-no">031</span><span id="line-31"> * {@link RegionScanner#next(java.util.List)}.</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;p&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * A ScannerContext instance should be updated periodically throughout execution whenever progress</span>
<span class="source-line-no">034</span><span id="line-34"> * towards a limit has been made. Each limit can be checked via the appropriate checkLimit method.</span>
<span class="source-line-no">035</span><span id="line-35"> * &lt;p&gt;</span>
<span class="source-line-no">036</span><span id="line-36"> * Once a limit has been reached, the scan will stop. The invoker of</span>
<span class="source-line-no">037</span><span id="line-37"> * {@link InternalScanner#next(java.util.List)} or {@link RegionScanner#next(java.util.List)} can</span>
<span class="source-line-no">038</span><span id="line-38"> * use the appropriate check*Limit methods to see exactly which limits have been reached.</span>
<span class="source-line-no">039</span><span id="line-39"> * Alternatively, {@link #checkAnyLimitReached(LimitScope)} is provided to see if ANY limit was</span>
<span class="source-line-no">040</span><span id="line-40"> * reached</span>
<span class="source-line-no">041</span><span id="line-41"> * &lt;p&gt;</span>
<span class="source-line-no">042</span><span id="line-42"> * {@link NoLimitScannerContext#NO_LIMIT} is an immutable static definition that can be used</span>
<span class="source-line-no">043</span><span id="line-43"> * whenever a {@link ScannerContext} is needed but limits do not need to be enforced.</span>
<span class="source-line-no">044</span><span id="line-44"> * &lt;p&gt;</span>
<span class="source-line-no">045</span><span id="line-45"> * NOTE: It is important that this class only ever expose setter methods that can be safely skipped</span>
<span class="source-line-no">046</span><span id="line-46"> * when limits should be NOT enforced. This is because of the necessary immutability of the class</span>
<span class="source-line-no">047</span><span id="line-47"> * {@link NoLimitScannerContext}. If a setter cannot be safely skipped, the immutable nature of</span>
<span class="source-line-no">048</span><span id="line-48"> * {@link NoLimitScannerContext} will lead to incorrect behavior.</span>
<span class="source-line-no">049</span><span id="line-49"> */</span>
<span class="source-line-no">050</span><span id="line-50">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span>
<span class="source-line-no">051</span><span id="line-51">@InterfaceStability.Evolving</span>
<span class="source-line-no">052</span><span id="line-52">public class ScannerContext {</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> LimitFields limits;</span>
<span class="source-line-no">055</span><span id="line-55"> /**</span>
<span class="source-line-no">056</span><span id="line-56"> * A different set of progress fields. Only include batch, dataSize and heapSize. Compare to</span>
<span class="source-line-no">057</span><span id="line-57"> * LimitFields, ProgressFields doesn't contain time field. As we save a deadline in LimitFields,</span>
<span class="source-line-no">058</span><span id="line-58"> * so use {@link EnvironmentEdgeManager#currentTime()} directly when check time limit.</span>
<span class="source-line-no">059</span><span id="line-59"> */</span>
<span class="source-line-no">060</span><span id="line-60"> ProgressFields progress;</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> /**</span>
<span class="source-line-no">063</span><span id="line-63"> * The state of the scanner after the invocation of {@link InternalScanner#next(java.util.List)}</span>
<span class="source-line-no">064</span><span id="line-64"> * or {@link RegionScanner#next(java.util.List)}.</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66"> NextState scannerState;</span>
<span class="source-line-no">067</span><span id="line-67"> private static final NextState DEFAULT_STATE = NextState.MORE_VALUES;</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> /**</span>
<span class="source-line-no">070</span><span id="line-70"> * Used as an indication to invocations of {@link InternalScanner#next(java.util.List)} and</span>
<span class="source-line-no">071</span><span id="line-71"> * {@link RegionScanner#next(java.util.List)} that, if true, the progress tracked within this</span>
<span class="source-line-no">072</span><span id="line-72"> * {@link ScannerContext} instance should be considered while evaluating the limits. Useful for</span>
<span class="source-line-no">073</span><span id="line-73"> * enforcing a set of limits across multiple calls (i.e. the limit may not be reached in a single</span>
<span class="source-line-no">074</span><span id="line-74"> * invocation, but any progress made should be considered in future invocations)</span>
<span class="source-line-no">075</span><span id="line-75"> * &lt;p&gt;</span>
<span class="source-line-no">076</span><span id="line-76"> * Defaulting this value to false means that, by default, any tracked progress will be wiped clean</span>
<span class="source-line-no">077</span><span id="line-77"> * on invocations to {@link InternalScanner#next(java.util.List)} and</span>
<span class="source-line-no">078</span><span id="line-78"> * {@link RegionScanner#next(java.util.List)} and the call will be treated as though no progress</span>
<span class="source-line-no">079</span><span id="line-79"> * has been made towards the limits so far.</span>
<span class="source-line-no">080</span><span id="line-80"> * &lt;p&gt;</span>
<span class="source-line-no">081</span><span id="line-81"> * This is an important mechanism. Users of Internal/Region scanners expect that they can define</span>
<span class="source-line-no">082</span><span id="line-82"> * some limits and then repeatedly invoke {@link InternalScanner#next(List)} or</span>
<span class="source-line-no">083</span><span id="line-83"> * {@link RegionScanner#next(List)} where each invocation respects these limits separately.</span>
<span class="source-line-no">084</span><span id="line-84"> * &lt;p&gt;</span>
<span class="source-line-no">085</span><span id="line-85"> * For example:</span>
<span class="source-line-no">086</span><span id="line-86"> *</span>
<span class="source-line-no">087</span><span id="line-87"> * &lt;pre&gt;</span>
<span class="source-line-no">088</span><span id="line-88"> * {@code</span>
<span class="source-line-no">089</span><span id="line-89"> * ScannerContext context = new ScannerContext.newBuilder().setBatchLimit(5).build();</span>
<span class="source-line-no">090</span><span id="line-90"> * RegionScanner scanner = ...</span>
<span class="source-line-no">091</span><span id="line-91"> * List&lt;Cell&gt; results = new ArrayList&lt;Cell&gt;();</span>
<span class="source-line-no">092</span><span id="line-92"> * while(scanner.next(results, context)) {</span>
<span class="source-line-no">093</span><span id="line-93"> * // Do something with a batch of 5 cells</span>
<span class="source-line-no">094</span><span id="line-94"> * }</span>
<span class="source-line-no">095</span><span id="line-95"> * }</span>
<span class="source-line-no">096</span><span id="line-96"> * &lt;/pre&gt;</span>
<span class="source-line-no">097</span><span id="line-97"> *</span>
<span class="source-line-no">098</span><span id="line-98"> * However, in the case of RPCs, the server wants to be able to define a set of limits for a</span>
<span class="source-line-no">099</span><span id="line-99"> * particular RPC request and have those limits respected across multiple invocations. This means</span>
<span class="source-line-no">100</span><span id="line-100"> * that the progress made towards the limits in earlier calls will be saved and considered in</span>
<span class="source-line-no">101</span><span id="line-101"> * future invocations</span>
<span class="source-line-no">102</span><span id="line-102"> */</span>
<span class="source-line-no">103</span><span id="line-103"> boolean keepProgress;</span>
<span class="source-line-no">104</span><span id="line-104"> private static boolean DEFAULT_KEEP_PROGRESS = false;</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> /**</span>
<span class="source-line-no">107</span><span id="line-107"> * Allows temporarily ignoring limits and skipping tracking of batch and size progress. Used when</span>
<span class="source-line-no">108</span><span id="line-108"> * skipping to the next row, in which case all processed cells are thrown away so should not count</span>
<span class="source-line-no">109</span><span id="line-109"> * towards progress.</span>
<span class="source-line-no">110</span><span id="line-110"> */</span>
<span class="source-line-no">111</span><span id="line-111"> boolean skippingRow = false;</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> private Cell lastPeekedCell = null;</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> // Set this to true will have the same behavior with reaching the time limit.</span>
<span class="source-line-no">116</span><span id="line-116"> // This is used when you want to make the current RSRpcService.scan returns immediately. For</span>
<span class="source-line-no">117</span><span id="line-117"> // example, when we want to switch from pread to stream, we can only do it after the rpc call is</span>
<span class="source-line-no">118</span><span id="line-118"> // returned.</span>
<span class="source-line-no">119</span><span id="line-119"> private boolean returnImmediately;</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> /**</span>
<span class="source-line-no">122</span><span id="line-122"> * Tracks the relevant server side metrics during scans. null when metrics should not be tracked</span>
<span class="source-line-no">123</span><span id="line-123"> */</span>
<span class="source-line-no">124</span><span id="line-124"> final ServerSideScanMetrics metrics;</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> ScannerContext(boolean keepProgress, LimitFields limitsToCopy, boolean trackMetrics) {</span>
<span class="source-line-no">127</span><span id="line-127"> this.limits = new LimitFields();</span>
<span class="source-line-no">128</span><span id="line-128"> if (limitsToCopy != null) {</span>
<span class="source-line-no">129</span><span id="line-129"> this.limits.copy(limitsToCopy);</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> // Progress fields are initialized to 0</span>
<span class="source-line-no">133</span><span id="line-133"> progress = new ProgressFields(0, 0, 0, 0);</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> this.keepProgress = keepProgress;</span>
<span class="source-line-no">136</span><span id="line-136"> this.scannerState = DEFAULT_STATE;</span>
<span class="source-line-no">137</span><span id="line-137"> this.metrics = trackMetrics ? new ServerSideScanMetrics() : null;</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140"> public boolean isTrackingMetrics() {</span>
<span class="source-line-no">141</span><span id="line-141"> return this.metrics != null;</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> /**</span>
<span class="source-line-no">145</span><span id="line-145"> * Get the metrics instance. Should only be called after a call to {@link #isTrackingMetrics()}</span>
<span class="source-line-no">146</span><span id="line-146"> * has been made to confirm that metrics are indeed being tracked.</span>
<span class="source-line-no">147</span><span id="line-147"> * @return {@link ServerSideScanMetrics} instance that is tracking metrics for this scan</span>
<span class="source-line-no">148</span><span id="line-148"> */</span>
<span class="source-line-no">149</span><span id="line-149"> public ServerSideScanMetrics getMetrics() {</span>
<span class="source-line-no">150</span><span id="line-150"> assert isTrackingMetrics();</span>
<span class="source-line-no">151</span><span id="line-151"> return this.metrics;</span>
<span class="source-line-no">152</span><span id="line-152"> }</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> /**</span>
<span class="source-line-no">155</span><span id="line-155"> * @return true if the progress tracked so far in this instance will be considered during an</span>
<span class="source-line-no">156</span><span id="line-156"> * invocation of {@link InternalScanner#next(java.util.List)} or</span>
<span class="source-line-no">157</span><span id="line-157"> * {@link RegionScanner#next(java.util.List)}. false when the progress tracked so far</span>
<span class="source-line-no">158</span><span id="line-158"> * should not be considered and should instead be wiped away via {@link #clearProgress()}.</span>
<span class="source-line-no">159</span><span id="line-159"> * This only applies to per-row progress, like batch and data/heap size. Block size is</span>
<span class="source-line-no">160</span><span id="line-160"> * never reset because it tracks all of the blocks scanned for an entire request.</span>
<span class="source-line-no">161</span><span id="line-161"> */</span>
<span class="source-line-no">162</span><span id="line-162"> boolean getKeepProgress() {</span>
<span class="source-line-no">163</span><span id="line-163"> return keepProgress;</span>
<span class="source-line-no">164</span><span id="line-164"> }</span>
<span class="source-line-no">165</span><span id="line-165"></span>
<span class="source-line-no">166</span><span id="line-166"> void setKeepProgress(boolean keepProgress) {</span>
<span class="source-line-no">167</span><span id="line-167"> this.keepProgress = keepProgress;</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169"></span>
<span class="source-line-no">170</span><span id="line-170"> /**</span>
<span class="source-line-no">171</span><span id="line-171"> * In this mode, only block size progress is tracked, and limits are ignored. We set this mode</span>
<span class="source-line-no">172</span><span id="line-172"> * when skipping to next row, in which case all cells returned a thrown away so should not count</span>
<span class="source-line-no">173</span><span id="line-173"> * towards progress.</span>
<span class="source-line-no">174</span><span id="line-174"> * @return true if we are in skipping row mode.</span>
<span class="source-line-no">175</span><span id="line-175"> */</span>
<span class="source-line-no">176</span><span id="line-176"> public boolean getSkippingRow() {</span>
<span class="source-line-no">177</span><span id="line-177"> return skippingRow;</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180"> /**</span>
<span class="source-line-no">181</span><span id="line-181"> * @param skippingRow set true to cause disabling of collecting per-cell progress or enforcing any</span>
<span class="source-line-no">182</span><span id="line-182"> * limits. This is used when trying to skip over all cells in a row, in which</span>
<span class="source-line-no">183</span><span id="line-183"> * case those cells are thrown away so should not count towards progress.</span>
<span class="source-line-no">184</span><span id="line-184"> */</span>
<span class="source-line-no">185</span><span id="line-185"> void setSkippingRow(boolean skippingRow) {</span>
<span class="source-line-no">186</span><span id="line-186"> this.skippingRow = skippingRow;</span>
<span class="source-line-no">187</span><span id="line-187"> }</span>
<span class="source-line-no">188</span><span id="line-188"></span>
<span class="source-line-no">189</span><span id="line-189"> /**</span>
<span class="source-line-no">190</span><span id="line-190"> * Progress towards the batch limit has been made. Increment internal tracking of batch progress</span>
<span class="source-line-no">191</span><span id="line-191"> */</span>
<span class="source-line-no">192</span><span id="line-192"> void incrementBatchProgress(int batch) {</span>
<span class="source-line-no">193</span><span id="line-193"> if (skippingRow) {</span>
<span class="source-line-no">194</span><span id="line-194"> return;</span>
<span class="source-line-no">195</span><span id="line-195"> }</span>
<span class="source-line-no">196</span><span id="line-196"> int currentBatch = progress.getBatch();</span>
<span class="source-line-no">197</span><span id="line-197"> progress.setBatch(currentBatch + batch);</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> /**</span>
<span class="source-line-no">201</span><span id="line-201"> * Progress towards the size limit has been made. Increment internal tracking of size progress</span>
<span class="source-line-no">202</span><span id="line-202"> */</span>
<span class="source-line-no">203</span><span id="line-203"> void incrementSizeProgress(long dataSize, long heapSize) {</span>
<span class="source-line-no">204</span><span id="line-204"> if (skippingRow) {</span>
<span class="source-line-no">205</span><span id="line-205"> return;</span>
<span class="source-line-no">206</span><span id="line-206"> }</span>
<span class="source-line-no">207</span><span id="line-207"> long curDataSize = progress.getDataSize();</span>
<span class="source-line-no">208</span><span id="line-208"> progress.setDataSize(curDataSize + dataSize);</span>
<span class="source-line-no">209</span><span id="line-209"> long curHeapSize = progress.getHeapSize();</span>
<span class="source-line-no">210</span><span id="line-210"> progress.setHeapSize(curHeapSize + heapSize);</span>
<span class="source-line-no">211</span><span id="line-211"> }</span>
<span class="source-line-no">212</span><span id="line-212"></span>
<span class="source-line-no">213</span><span id="line-213"> /**</span>
<span class="source-line-no">214</span><span id="line-214"> * Progress towards the block limit has been made. Increment internal track of block progress</span>
<span class="source-line-no">215</span><span id="line-215"> */</span>
<span class="source-line-no">216</span><span id="line-216"> void incrementBlockProgress(int blockSize) {</span>
<span class="source-line-no">217</span><span id="line-217"> if (blockSize &gt; 0) {</span>
<span class="source-line-no">218</span><span id="line-218"> long curBlockSize = progress.getBlockSize();</span>
<span class="source-line-no">219</span><span id="line-219"> progress.setBlockSize(curBlockSize + blockSize);</span>
<span class="source-line-no">220</span><span id="line-220"> }</span>
<span class="source-line-no">221</span><span id="line-221"> }</span>
<span class="source-line-no">222</span><span id="line-222"></span>
<span class="source-line-no">223</span><span id="line-223"> int getBatchProgress() {</span>
<span class="source-line-no">224</span><span id="line-224"> return progress.getBatch();</span>
<span class="source-line-no">225</span><span id="line-225"> }</span>
<span class="source-line-no">226</span><span id="line-226"></span>
<span class="source-line-no">227</span><span id="line-227"> long getDataSizeProgress() {</span>
<span class="source-line-no">228</span><span id="line-228"> return progress.getDataSize();</span>
<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230"></span>
<span class="source-line-no">231</span><span id="line-231"> long getHeapSizeProgress() {</span>
<span class="source-line-no">232</span><span id="line-232"> return progress.getHeapSize();</span>
<span class="source-line-no">233</span><span id="line-233"> }</span>
<span class="source-line-no">234</span><span id="line-234"></span>
<span class="source-line-no">235</span><span id="line-235"> long getBlockSizeProgress() {</span>
<span class="source-line-no">236</span><span id="line-236"> return progress.getBlockSize();</span>
<span class="source-line-no">237</span><span id="line-237"> }</span>
<span class="source-line-no">238</span><span id="line-238"></span>
<span class="source-line-no">239</span><span id="line-239"> void setProgress(int batchProgress, long sizeProgress, long heapSizeProgress) {</span>
<span class="source-line-no">240</span><span id="line-240"> setBatchProgress(batchProgress);</span>
<span class="source-line-no">241</span><span id="line-241"> setSizeProgress(sizeProgress, heapSizeProgress);</span>
<span class="source-line-no">242</span><span id="line-242"> }</span>
<span class="source-line-no">243</span><span id="line-243"></span>
<span class="source-line-no">244</span><span id="line-244"> void setSizeProgress(long dataSizeProgress, long heapSizeProgress) {</span>
<span class="source-line-no">245</span><span id="line-245"> progress.setDataSize(dataSizeProgress);</span>
<span class="source-line-no">246</span><span id="line-246"> progress.setHeapSize(heapSizeProgress);</span>
<span class="source-line-no">247</span><span id="line-247"> }</span>
<span class="source-line-no">248</span><span id="line-248"></span>
<span class="source-line-no">249</span><span id="line-249"> void setBatchProgress(int batchProgress) {</span>
<span class="source-line-no">250</span><span id="line-250"> progress.setBatch(batchProgress);</span>
<span class="source-line-no">251</span><span id="line-251"> }</span>
<span class="source-line-no">252</span><span id="line-252"></span>
<span class="source-line-no">253</span><span id="line-253"> /**</span>
<span class="source-line-no">254</span><span id="line-254"> * Clear away any progress that has been made so far. All progress fields are reset to initial</span>
<span class="source-line-no">255</span><span id="line-255"> * values. Only clears progress that should reset between rows. {@link #getBlockSizeProgress()} is</span>
<span class="source-line-no">256</span><span id="line-256"> * not reset because it increments for all blocks scanned whether the result is included or</span>
<span class="source-line-no">257</span><span id="line-257"> * filtered.</span>
<span class="source-line-no">258</span><span id="line-258"> */</span>
<span class="source-line-no">259</span><span id="line-259"> void clearProgress() {</span>
<span class="source-line-no">260</span><span id="line-260"> progress.setFields(0, 0, 0, getBlockSizeProgress());</span>
<span class="source-line-no">261</span><span id="line-261"> }</span>
<span class="source-line-no">262</span><span id="line-262"></span>
<span class="source-line-no">263</span><span id="line-263"> /**</span>
<span class="source-line-no">264</span><span id="line-264"> * Note that this is not a typical setter. This setter returns the {@link NextState} that was</span>
<span class="source-line-no">265</span><span id="line-265"> * passed in so that methods can be invoked against the new state. Furthermore, this pattern</span>
<span class="source-line-no">266</span><span id="line-266"> * allows the {@link NoLimitScannerContext} to cleanly override this setter and simply return the</span>
<span class="source-line-no">267</span><span id="line-267"> * new state, thus preserving the immutability of {@link NoLimitScannerContext}</span>
<span class="source-line-no">268</span><span id="line-268"> * @return The state that was passed in.</span>
<span class="source-line-no">269</span><span id="line-269"> */</span>
<span class="source-line-no">270</span><span id="line-270"> NextState setScannerState(NextState state) {</span>
<span class="source-line-no">271</span><span id="line-271"> if (!NextState.isValidState(state)) {</span>
<span class="source-line-no">272</span><span id="line-272"> throw new IllegalArgumentException("Cannot set to invalid state: " + state);</span>
<span class="source-line-no">273</span><span id="line-273"> }</span>
<span class="source-line-no">274</span><span id="line-274"></span>
<span class="source-line-no">275</span><span id="line-275"> this.scannerState = state;</span>
<span class="source-line-no">276</span><span id="line-276"> return state;</span>
<span class="source-line-no">277</span><span id="line-277"> }</span>
<span class="source-line-no">278</span><span id="line-278"></span>
<span class="source-line-no">279</span><span id="line-279"> /**</span>
<span class="source-line-no">280</span><span id="line-280"> * @return true when we have more cells for the current row. This usually because we have reached</span>
<span class="source-line-no">281</span><span id="line-281"> * a limit in the middle of a row</span>
<span class="source-line-no">282</span><span id="line-282"> */</span>
<span class="source-line-no">283</span><span id="line-283"> boolean mayHaveMoreCellsInRow() {</span>
<span class="source-line-no">284</span><span id="line-284"> return scannerState == NextState.SIZE_LIMIT_REACHED_MID_ROW</span>
<span class="source-line-no">285</span><span id="line-285"> || scannerState == NextState.TIME_LIMIT_REACHED_MID_ROW</span>
<span class="source-line-no">286</span><span id="line-286"> || scannerState == NextState.BATCH_LIMIT_REACHED;</span>
<span class="source-line-no">287</span><span id="line-287"> }</span>
<span class="source-line-no">288</span><span id="line-288"></span>
<span class="source-line-no">289</span><span id="line-289"> /** Returns true if the batch limit can be enforced in the checker's scope */</span>
<span class="source-line-no">290</span><span id="line-290"> boolean hasBatchLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">291</span><span id="line-291"> return limits.canEnforceBatchLimitFromScope(checkerScope) &amp;&amp; limits.getBatch() &gt; 0;</span>
<span class="source-line-no">292</span><span id="line-292"> }</span>
<span class="source-line-no">293</span><span id="line-293"></span>
<span class="source-line-no">294</span><span id="line-294"> /** Returns true if the size limit can be enforced in the checker's scope */</span>
<span class="source-line-no">295</span><span id="line-295"> boolean hasSizeLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">296</span><span id="line-296"> return limits.canEnforceSizeLimitFromScope(checkerScope)</span>
<span class="source-line-no">297</span><span id="line-297"> &amp;&amp; (limits.getDataSize() &gt; 0 || limits.getHeapSize() &gt; 0 || limits.getBlockSize() &gt; 0);</span>
<span class="source-line-no">298</span><span id="line-298"> }</span>
<span class="source-line-no">299</span><span id="line-299"></span>
<span class="source-line-no">300</span><span id="line-300"> /** Returns true if the time limit can be enforced in the checker's scope */</span>
<span class="source-line-no">301</span><span id="line-301"> boolean hasTimeLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">302</span><span id="line-302"> return limits.canEnforceTimeLimitFromScope(checkerScope)</span>
<span class="source-line-no">303</span><span id="line-303"> &amp;&amp; (limits.getTime() &gt; 0 || returnImmediately);</span>
<span class="source-line-no">304</span><span id="line-304"> }</span>
<span class="source-line-no">305</span><span id="line-305"></span>
<span class="source-line-no">306</span><span id="line-306"> /** Returns true if any limit can be enforced within the checker's scope */</span>
<span class="source-line-no">307</span><span id="line-307"> boolean hasAnyLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">308</span><span id="line-308"> return hasBatchLimit(checkerScope) || hasSizeLimit(checkerScope) || hasTimeLimit(checkerScope);</span>
<span class="source-line-no">309</span><span id="line-309"> }</span>
<span class="source-line-no">310</span><span id="line-310"></span>
<span class="source-line-no">311</span><span id="line-311"> /**</span>
<span class="source-line-no">312</span><span id="line-312"> * @param scope The scope in which the size limit will be enforced</span>
<span class="source-line-no">313</span><span id="line-313"> */</span>
<span class="source-line-no">314</span><span id="line-314"> void setSizeLimitScope(LimitScope scope) {</span>
<span class="source-line-no">315</span><span id="line-315"> limits.setSizeScope(scope);</span>
<span class="source-line-no">316</span><span id="line-316"> }</span>
<span class="source-line-no">317</span><span id="line-317"></span>
<span class="source-line-no">318</span><span id="line-318"> /**</span>
<span class="source-line-no">319</span><span id="line-319"> * @param scope The scope in which the time limit will be enforced</span>
<span class="source-line-no">320</span><span id="line-320"> */</span>
<span class="source-line-no">321</span><span id="line-321"> void setTimeLimitScope(LimitScope scope) {</span>
<span class="source-line-no">322</span><span id="line-322"> limits.setTimeScope(scope);</span>
<span class="source-line-no">323</span><span id="line-323"> }</span>
<span class="source-line-no">324</span><span id="line-324"></span>
<span class="source-line-no">325</span><span id="line-325"> int getBatchLimit() {</span>
<span class="source-line-no">326</span><span id="line-326"> return limits.getBatch();</span>
<span class="source-line-no">327</span><span id="line-327"> }</span>
<span class="source-line-no">328</span><span id="line-328"></span>
<span class="source-line-no">329</span><span id="line-329"> long getDataSizeLimit() {</span>
<span class="source-line-no">330</span><span id="line-330"> return limits.getDataSize();</span>
<span class="source-line-no">331</span><span id="line-331"> }</span>
<span class="source-line-no">332</span><span id="line-332"></span>
<span class="source-line-no">333</span><span id="line-333"> long getTimeLimit() {</span>
<span class="source-line-no">334</span><span id="line-334"> return limits.getTime();</span>
<span class="source-line-no">335</span><span id="line-335"> }</span>
<span class="source-line-no">336</span><span id="line-336"></span>
<span class="source-line-no">337</span><span id="line-337"> /**</span>
<span class="source-line-no">338</span><span id="line-338"> * @param checkerScope The scope that the limit is being checked from</span>
<span class="source-line-no">339</span><span id="line-339"> * @return true when the limit is enforceable from the checker's scope and it has been reached</span>
<span class="source-line-no">340</span><span id="line-340"> */</span>
<span class="source-line-no">341</span><span id="line-341"> boolean checkBatchLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">342</span><span id="line-342"> return !skippingRow &amp;&amp; hasBatchLimit(checkerScope) &amp;&amp; progress.getBatch() &gt;= limits.getBatch();</span>
<span class="source-line-no">343</span><span id="line-343"> }</span>
<span class="source-line-no">344</span><span id="line-344"></span>
<span class="source-line-no">345</span><span id="line-345"> /**</span>
<span class="source-line-no">346</span><span id="line-346"> * @param checkerScope The scope that the limit is being checked from</span>
<span class="source-line-no">347</span><span id="line-347"> * @return true when the limit is enforceable from the checker's scope and it has been reached</span>
<span class="source-line-no">348</span><span id="line-348"> */</span>
<span class="source-line-no">349</span><span id="line-349"> boolean checkSizeLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">350</span><span id="line-350"> return !skippingRow &amp;&amp; hasSizeLimit(checkerScope)</span>
<span class="source-line-no">351</span><span id="line-351"> &amp;&amp; (progress.getDataSize() &gt;= limits.getDataSize()</span>
<span class="source-line-no">352</span><span id="line-352"> || progress.getHeapSize() &gt;= limits.getHeapSize()</span>
<span class="source-line-no">353</span><span id="line-353"> || progress.getBlockSize() &gt;= limits.getBlockSize());</span>
<span class="source-line-no">354</span><span id="line-354"> }</span>
<span class="source-line-no">355</span><span id="line-355"></span>
<span class="source-line-no">356</span><span id="line-356"> /**</span>
<span class="source-line-no">357</span><span id="line-357"> * @param checkerScope The scope that the limit is being checked from. The time limit is always</span>
<span class="source-line-no">358</span><span id="line-358"> * checked against {@link EnvironmentEdgeManager.currentTime}</span>
<span class="source-line-no">359</span><span id="line-359"> * @return true when the limit is enforceable from the checker's scope and it has been reached</span>
<span class="source-line-no">360</span><span id="line-360"> */</span>
<span class="source-line-no">361</span><span id="line-361"> boolean checkTimeLimit(LimitScope checkerScope) {</span>
<span class="source-line-no">362</span><span id="line-362"> return !skippingRow &amp;&amp; hasTimeLimit(checkerScope)</span>
<span class="source-line-no">363</span><span id="line-363"> &amp;&amp; (returnImmediately || EnvironmentEdgeManager.currentTime() &gt;= limits.getTime());</span>
<span class="source-line-no">364</span><span id="line-364"> }</span>
<span class="source-line-no">365</span><span id="line-365"></span>
<span class="source-line-no">366</span><span id="line-366"> /**</span>
<span class="source-line-no">367</span><span id="line-367"> * @param checkerScope The scope that the limits are being checked from</span>
<span class="source-line-no">368</span><span id="line-368"> * @return true when some limit is enforceable from the checker's scope and it has been reached</span>
<span class="source-line-no">369</span><span id="line-369"> */</span>
<span class="source-line-no">370</span><span id="line-370"> boolean checkAnyLimitReached(LimitScope checkerScope) {</span>
<span class="source-line-no">371</span><span id="line-371"> return checkSizeLimit(checkerScope) || checkBatchLimit(checkerScope)</span>
<span class="source-line-no">372</span><span id="line-372"> || checkTimeLimit(checkerScope);</span>
<span class="source-line-no">373</span><span id="line-373"> }</span>
<span class="source-line-no">374</span><span id="line-374"></span>
<span class="source-line-no">375</span><span id="line-375"> Cell getLastPeekedCell() {</span>
<span class="source-line-no">376</span><span id="line-376"> return lastPeekedCell;</span>
<span class="source-line-no">377</span><span id="line-377"> }</span>
<span class="source-line-no">378</span><span id="line-378"></span>
<span class="source-line-no">379</span><span id="line-379"> void setLastPeekedCell(Cell lastPeekedCell) {</span>
<span class="source-line-no">380</span><span id="line-380"> this.lastPeekedCell = lastPeekedCell;</span>
<span class="source-line-no">381</span><span id="line-381"> }</span>
<span class="source-line-no">382</span><span id="line-382"></span>
<span class="source-line-no">383</span><span id="line-383"> void returnImmediately() {</span>
<span class="source-line-no">384</span><span id="line-384"> this.returnImmediately = true;</span>
<span class="source-line-no">385</span><span id="line-385"> }</span>
<span class="source-line-no">386</span><span id="line-386"></span>
<span class="source-line-no">387</span><span id="line-387"> @Override</span>
<span class="source-line-no">388</span><span id="line-388"> public String toString() {</span>
<span class="source-line-no">389</span><span id="line-389"> StringBuilder sb = new StringBuilder();</span>
<span class="source-line-no">390</span><span id="line-390"> sb.append("{");</span>
<span class="source-line-no">391</span><span id="line-391"></span>
<span class="source-line-no">392</span><span id="line-392"> sb.append("limits:");</span>
<span class="source-line-no">393</span><span id="line-393"> sb.append(limits);</span>
<span class="source-line-no">394</span><span id="line-394"></span>
<span class="source-line-no">395</span><span id="line-395"> sb.append(", progress:");</span>
<span class="source-line-no">396</span><span id="line-396"> sb.append(progress);</span>
<span class="source-line-no">397</span><span id="line-397"></span>
<span class="source-line-no">398</span><span id="line-398"> sb.append(", keepProgress:");</span>
<span class="source-line-no">399</span><span id="line-399"> sb.append(keepProgress);</span>
<span class="source-line-no">400</span><span id="line-400"></span>
<span class="source-line-no">401</span><span id="line-401"> sb.append(", state:");</span>
<span class="source-line-no">402</span><span id="line-402"> sb.append(scannerState);</span>
<span class="source-line-no">403</span><span id="line-403"></span>
<span class="source-line-no">404</span><span id="line-404"> sb.append("}");</span>
<span class="source-line-no">405</span><span id="line-405"> return sb.toString();</span>
<span class="source-line-no">406</span><span id="line-406"> }</span>
<span class="source-line-no">407</span><span id="line-407"></span>
<span class="source-line-no">408</span><span id="line-408"> public static Builder newBuilder() {</span>
<span class="source-line-no">409</span><span id="line-409"> return new Builder();</span>
<span class="source-line-no">410</span><span id="line-410"> }</span>
<span class="source-line-no">411</span><span id="line-411"></span>
<span class="source-line-no">412</span><span id="line-412"> public static Builder newBuilder(boolean keepProgress) {</span>
<span class="source-line-no">413</span><span id="line-413"> return new Builder(keepProgress);</span>
<span class="source-line-no">414</span><span id="line-414"> }</span>
<span class="source-line-no">415</span><span id="line-415"></span>
<span class="source-line-no">416</span><span id="line-416"> public static final class Builder {</span>
<span class="source-line-no">417</span><span id="line-417"> boolean keepProgress = DEFAULT_KEEP_PROGRESS;</span>
<span class="source-line-no">418</span><span id="line-418"> boolean trackMetrics = false;</span>
<span class="source-line-no">419</span><span id="line-419"> LimitFields limits = new LimitFields();</span>
<span class="source-line-no">420</span><span id="line-420"></span>
<span class="source-line-no">421</span><span id="line-421"> private Builder() {</span>
<span class="source-line-no">422</span><span id="line-422"> }</span>
<span class="source-line-no">423</span><span id="line-423"></span>
<span class="source-line-no">424</span><span id="line-424"> private Builder(boolean keepProgress) {</span>
<span class="source-line-no">425</span><span id="line-425"> this.keepProgress = keepProgress;</span>
<span class="source-line-no">426</span><span id="line-426"> }</span>
<span class="source-line-no">427</span><span id="line-427"></span>
<span class="source-line-no">428</span><span id="line-428"> public Builder setKeepProgress(boolean keepProgress) {</span>
<span class="source-line-no">429</span><span id="line-429"> this.keepProgress = keepProgress;</span>
<span class="source-line-no">430</span><span id="line-430"> return this;</span>
<span class="source-line-no">431</span><span id="line-431"> }</span>
<span class="source-line-no">432</span><span id="line-432"></span>
<span class="source-line-no">433</span><span id="line-433"> public Builder setTrackMetrics(boolean trackMetrics) {</span>
<span class="source-line-no">434</span><span id="line-434"> this.trackMetrics = trackMetrics;</span>
<span class="source-line-no">435</span><span id="line-435"> return this;</span>
<span class="source-line-no">436</span><span id="line-436"> }</span>
<span class="source-line-no">437</span><span id="line-437"></span>
<span class="source-line-no">438</span><span id="line-438"> public Builder setSizeLimit(LimitScope sizeScope, long dataSizeLimit, long heapSizeLimit,</span>
<span class="source-line-no">439</span><span id="line-439"> long blockSizeLimit) {</span>
<span class="source-line-no">440</span><span id="line-440"> limits.setDataSize(dataSizeLimit);</span>
<span class="source-line-no">441</span><span id="line-441"> limits.setHeapSize(heapSizeLimit);</span>
<span class="source-line-no">442</span><span id="line-442"> limits.setSizeScope(sizeScope);</span>
<span class="source-line-no">443</span><span id="line-443"> limits.setBlockSize(blockSizeLimit);</span>
<span class="source-line-no">444</span><span id="line-444"> return this;</span>
<span class="source-line-no">445</span><span id="line-445"> }</span>
<span class="source-line-no">446</span><span id="line-446"></span>
<span class="source-line-no">447</span><span id="line-447"> public Builder setTimeLimit(LimitScope timeScope, long timeLimit) {</span>
<span class="source-line-no">448</span><span id="line-448"> limits.setTime(timeLimit);</span>
<span class="source-line-no">449</span><span id="line-449"> limits.setTimeScope(timeScope);</span>
<span class="source-line-no">450</span><span id="line-450"> return this;</span>
<span class="source-line-no">451</span><span id="line-451"> }</span>
<span class="source-line-no">452</span><span id="line-452"></span>
<span class="source-line-no">453</span><span id="line-453"> public Builder setBatchLimit(int batchLimit) {</span>
<span class="source-line-no">454</span><span id="line-454"> limits.setBatch(batchLimit);</span>
<span class="source-line-no">455</span><span id="line-455"> return this;</span>
<span class="source-line-no">456</span><span id="line-456"> }</span>
<span class="source-line-no">457</span><span id="line-457"></span>
<span class="source-line-no">458</span><span id="line-458"> public ScannerContext build() {</span>
<span class="source-line-no">459</span><span id="line-459"> return new ScannerContext(keepProgress, limits, trackMetrics);</span>
<span class="source-line-no">460</span><span id="line-460"> }</span>
<span class="source-line-no">461</span><span id="line-461"> }</span>
<span class="source-line-no">462</span><span id="line-462"></span>
<span class="source-line-no">463</span><span id="line-463"> /**</span>
<span class="source-line-no">464</span><span id="line-464"> * The possible states a scanner may be in following a call to {@link InternalScanner#next(List)}</span>
<span class="source-line-no">465</span><span id="line-465"> */</span>
<span class="source-line-no">466</span><span id="line-466"> public enum NextState {</span>
<span class="source-line-no">467</span><span id="line-467"> MORE_VALUES(true, false),</span>
<span class="source-line-no">468</span><span id="line-468"> NO_MORE_VALUES(false, false),</span>
<span class="source-line-no">469</span><span id="line-469"> SIZE_LIMIT_REACHED(true, true),</span>
<span class="source-line-no">470</span><span id="line-470"></span>
<span class="source-line-no">471</span><span id="line-471"> /**</span>
<span class="source-line-no">472</span><span id="line-472"> * Special case of size limit reached to indicate that the size limit was reached in the middle</span>
<span class="source-line-no">473</span><span id="line-473"> * of a row and thus a partial results was formed</span>
<span class="source-line-no">474</span><span id="line-474"> */</span>
<span class="source-line-no">475</span><span id="line-475"> SIZE_LIMIT_REACHED_MID_ROW(true, true),</span>
<span class="source-line-no">476</span><span id="line-476"> TIME_LIMIT_REACHED(true, true),</span>
<span class="source-line-no">477</span><span id="line-477"></span>
<span class="source-line-no">478</span><span id="line-478"> /**</span>
<span class="source-line-no">479</span><span id="line-479"> * Special case of time limit reached to indicate that the time limit was reached in the middle</span>
<span class="source-line-no">480</span><span id="line-480"> * of a row and thus a partial results was formed</span>
<span class="source-line-no">481</span><span id="line-481"> */</span>
<span class="source-line-no">482</span><span id="line-482"> TIME_LIMIT_REACHED_MID_ROW(true, true),</span>
<span class="source-line-no">483</span><span id="line-483"> BATCH_LIMIT_REACHED(true, true);</span>
<span class="source-line-no">484</span><span id="line-484"></span>
<span class="source-line-no">485</span><span id="line-485"> private final boolean moreValues;</span>
<span class="source-line-no">486</span><span id="line-486"> private final boolean limitReached;</span>
<span class="source-line-no">487</span><span id="line-487"></span>
<span class="source-line-no">488</span><span id="line-488"> private NextState(boolean moreValues, boolean limitReached) {</span>
<span class="source-line-no">489</span><span id="line-489"> this.moreValues = moreValues;</span>
<span class="source-line-no">490</span><span id="line-490"> this.limitReached = limitReached;</span>
<span class="source-line-no">491</span><span id="line-491"> }</span>
<span class="source-line-no">492</span><span id="line-492"></span>
<span class="source-line-no">493</span><span id="line-493"> /**</span>
<span class="source-line-no">494</span><span id="line-494"> * @return true when the state indicates that more values may follow those that have been</span>
<span class="source-line-no">495</span><span id="line-495"> * returned</span>
<span class="source-line-no">496</span><span id="line-496"> */</span>
<span class="source-line-no">497</span><span id="line-497"> public boolean hasMoreValues() {</span>
<span class="source-line-no">498</span><span id="line-498"> return this.moreValues;</span>
<span class="source-line-no">499</span><span id="line-499"> }</span>
<span class="source-line-no">500</span><span id="line-500"></span>
<span class="source-line-no">501</span><span id="line-501"> /** Returns true when the state indicates that a limit has been reached and scan should stop */</span>
<span class="source-line-no">502</span><span id="line-502"> public boolean limitReached() {</span>
<span class="source-line-no">503</span><span id="line-503"> return this.limitReached;</span>
<span class="source-line-no">504</span><span id="line-504"> }</span>
<span class="source-line-no">505</span><span id="line-505"></span>
<span class="source-line-no">506</span><span id="line-506"> public static boolean isValidState(NextState state) {</span>
<span class="source-line-no">507</span><span id="line-507"> return state != null;</span>
<span class="source-line-no">508</span><span id="line-508"> }</span>
<span class="source-line-no">509</span><span id="line-509"></span>
<span class="source-line-no">510</span><span id="line-510"> public static boolean hasMoreValues(NextState state) {</span>
<span class="source-line-no">511</span><span id="line-511"> return isValidState(state) &amp;&amp; state.hasMoreValues();</span>
<span class="source-line-no">512</span><span id="line-512"> }</span>
<span class="source-line-no">513</span><span id="line-513"> }</span>
<span class="source-line-no">514</span><span id="line-514"></span>
<span class="source-line-no">515</span><span id="line-515"> /**</span>
<span class="source-line-no">516</span><span id="line-516"> * The various scopes where a limit can be enforced. Used to differentiate when a limit should be</span>
<span class="source-line-no">517</span><span id="line-517"> * enforced or not.</span>
<span class="source-line-no">518</span><span id="line-518"> */</span>
<span class="source-line-no">519</span><span id="line-519"> public enum LimitScope {</span>
<span class="source-line-no">520</span><span id="line-520"> /**</span>
<span class="source-line-no">521</span><span id="line-521"> * Enforcing a limit between rows means that the limit will not be considered until all the</span>
<span class="source-line-no">522</span><span id="line-522"> * cells for a particular row have been retrieved</span>
<span class="source-line-no">523</span><span id="line-523"> */</span>
<span class="source-line-no">524</span><span id="line-524"> BETWEEN_ROWS(0),</span>
<span class="source-line-no">525</span><span id="line-525"></span>
<span class="source-line-no">526</span><span id="line-526"> /**</span>
<span class="source-line-no">527</span><span id="line-527"> * Enforcing a limit between cells means that the limit will be considered after each full cell</span>
<span class="source-line-no">528</span><span id="line-528"> * has been retrieved</span>
<span class="source-line-no">529</span><span id="line-529"> */</span>
<span class="source-line-no">530</span><span id="line-530"> BETWEEN_CELLS(1);</span>
<span class="source-line-no">531</span><span id="line-531"></span>
<span class="source-line-no">532</span><span id="line-532"> /**</span>
<span class="source-line-no">533</span><span id="line-533"> * When enforcing a limit, we must check that the scope is appropriate for enforcement.</span>
<span class="source-line-no">534</span><span id="line-534"> * &lt;p&gt;</span>
<span class="source-line-no">535</span><span id="line-535"> * To communicate this concept, each scope has a depth. A limit will be enforced if the depth of</span>
<span class="source-line-no">536</span><span id="line-536"> * the checker's scope is less than or equal to the limit's scope. This means that when checking</span>
<span class="source-line-no">537</span><span id="line-537"> * limits, the checker must know their own scope (i.e. are they checking the limits between</span>
<span class="source-line-no">538</span><span id="line-538"> * rows, between cells, etc...)</span>
<span class="source-line-no">539</span><span id="line-539"> */</span>
<span class="source-line-no">540</span><span id="line-540"> final int depth;</span>
<span class="source-line-no">541</span><span id="line-541"></span>
<span class="source-line-no">542</span><span id="line-542"> LimitScope(int depth) {</span>
<span class="source-line-no">543</span><span id="line-543"> this.depth = depth;</span>
<span class="source-line-no">544</span><span id="line-544"> }</span>
<span class="source-line-no">545</span><span id="line-545"></span>
<span class="source-line-no">546</span><span id="line-546"> final int depth() {</span>
<span class="source-line-no">547</span><span id="line-547"> return depth;</span>
<span class="source-line-no">548</span><span id="line-548"> }</span>
<span class="source-line-no">549</span><span id="line-549"></span>
<span class="source-line-no">550</span><span id="line-550"> /**</span>
<span class="source-line-no">551</span><span id="line-551"> * @param checkerScope The scope in which the limit is being checked</span>
<span class="source-line-no">552</span><span id="line-552"> * @return true when the checker is in a scope that indicates the limit can be enforced. Limits</span>
<span class="source-line-no">553</span><span id="line-553"> * can be enforced from "higher or equal" scopes (i.e. the checker's scope is at a</span>
<span class="source-line-no">554</span><span id="line-554"> * lesser depth than the limit)</span>
<span class="source-line-no">555</span><span id="line-555"> */</span>
<span class="source-line-no">556</span><span id="line-556"> boolean canEnforceLimitFromScope(LimitScope checkerScope) {</span>
<span class="source-line-no">557</span><span id="line-557"> return checkerScope != null &amp;&amp; checkerScope.depth() &lt;= depth;</span>
<span class="source-line-no">558</span><span id="line-558"> }</span>
<span class="source-line-no">559</span><span id="line-559"> }</span>
<span class="source-line-no">560</span><span id="line-560"></span>
<span class="source-line-no">561</span><span id="line-561"> /**</span>
<span class="source-line-no">562</span><span id="line-562"> * The different fields that can be used as limits in calls to</span>
<span class="source-line-no">563</span><span id="line-563"> * {@link InternalScanner#next(java.util.List)} and {@link RegionScanner#next(java.util.List)}</span>
<span class="source-line-no">564</span><span id="line-564"> */</span>
<span class="source-line-no">565</span><span id="line-565"> private static class LimitFields {</span>
<span class="source-line-no">566</span><span id="line-566"> /**</span>
<span class="source-line-no">567</span><span id="line-567"> * Default values of the limit fields. Defined such that if a field does NOT change from its</span>
<span class="source-line-no">568</span><span id="line-568"> * default, it will not be enforced</span>
<span class="source-line-no">569</span><span id="line-569"> */</span>
<span class="source-line-no">570</span><span id="line-570"> private static int DEFAULT_BATCH = -1;</span>
<span class="source-line-no">571</span><span id="line-571"> private static long DEFAULT_SIZE = -1L;</span>
<span class="source-line-no">572</span><span id="line-572"> private static long DEFAULT_TIME = -1L;</span>
<span class="source-line-no">573</span><span id="line-573"></span>
<span class="source-line-no">574</span><span id="line-574"> /**</span>
<span class="source-line-no">575</span><span id="line-575"> * Default scope that is assigned to a limit if a scope is not specified.</span>
<span class="source-line-no">576</span><span id="line-576"> */</span>
<span class="source-line-no">577</span><span id="line-577"> private static final LimitScope DEFAULT_SCOPE = LimitScope.BETWEEN_ROWS;</span>
<span class="source-line-no">578</span><span id="line-578"></span>
<span class="source-line-no">579</span><span id="line-579"> // The batch limit will always be enforced between cells, thus, there isn't a field to hold the</span>
<span class="source-line-no">580</span><span id="line-580"> // batch scope</span>
<span class="source-line-no">581</span><span id="line-581"> int batch = DEFAULT_BATCH;</span>
<span class="source-line-no">582</span><span id="line-582"></span>
<span class="source-line-no">583</span><span id="line-583"> LimitScope sizeScope = DEFAULT_SCOPE;</span>
<span class="source-line-no">584</span><span id="line-584"> // The sum of cell data sizes(key + value). The Cell data might be in on heap or off heap area.</span>
<span class="source-line-no">585</span><span id="line-585"> long dataSize = DEFAULT_SIZE;</span>
<span class="source-line-no">586</span><span id="line-586"> // The sum of heap space occupied by all tracked cells. This includes Cell POJO's overhead as</span>
<span class="source-line-no">587</span><span id="line-587"> // such AND data cells of Cells which are in on heap area.</span>
<span class="source-line-no">588</span><span id="line-588"> long heapSize = DEFAULT_SIZE;</span>
<span class="source-line-no">589</span><span id="line-589"> // The total amount of block bytes that have been loaded in order to process cells for the</span>
<span class="source-line-no">590</span><span id="line-590"> // request.</span>
<span class="source-line-no">591</span><span id="line-591"> long blockSize = DEFAULT_SIZE;</span>
<span class="source-line-no">592</span><span id="line-592"></span>
<span class="source-line-no">593</span><span id="line-593"> LimitScope timeScope = DEFAULT_SCOPE;</span>
<span class="source-line-no">594</span><span id="line-594"> long time = DEFAULT_TIME;</span>
<span class="source-line-no">595</span><span id="line-595"></span>
<span class="source-line-no">596</span><span id="line-596"> /**</span>
<span class="source-line-no">597</span><span id="line-597"> * Fields keep their default values.</span>
<span class="source-line-no">598</span><span id="line-598"> */</span>
<span class="source-line-no">599</span><span id="line-599"> LimitFields() {</span>
<span class="source-line-no">600</span><span id="line-600"> }</span>
<span class="source-line-no">601</span><span id="line-601"></span>
<span class="source-line-no">602</span><span id="line-602"> void copy(LimitFields limitsToCopy) {</span>
<span class="source-line-no">603</span><span id="line-603"> if (limitsToCopy != null) {</span>
<span class="source-line-no">604</span><span id="line-604"> setFields(limitsToCopy.getBatch(), limitsToCopy.getSizeScope(), limitsToCopy.getDataSize(),</span>
<span class="source-line-no">605</span><span id="line-605"> limitsToCopy.getHeapSize(), limitsToCopy.getBlockSize(), limitsToCopy.getTimeScope(),</span>
<span class="source-line-no">606</span><span id="line-606"> limitsToCopy.getTime());</span>
<span class="source-line-no">607</span><span id="line-607"> }</span>
<span class="source-line-no">608</span><span id="line-608"> }</span>
<span class="source-line-no">609</span><span id="line-609"></span>
<span class="source-line-no">610</span><span id="line-610"> /**</span>
<span class="source-line-no">611</span><span id="line-611"> * Set all fields together.</span>
<span class="source-line-no">612</span><span id="line-612"> */</span>
<span class="source-line-no">613</span><span id="line-613"> void setFields(int batch, LimitScope sizeScope, long dataSize, long heapSize, long blockSize,</span>
<span class="source-line-no">614</span><span id="line-614"> LimitScope timeScope, long time) {</span>
<span class="source-line-no">615</span><span id="line-615"> setBatch(batch);</span>
<span class="source-line-no">616</span><span id="line-616"> setSizeScope(sizeScope);</span>
<span class="source-line-no">617</span><span id="line-617"> setDataSize(dataSize);</span>
<span class="source-line-no">618</span><span id="line-618"> setHeapSize(heapSize);</span>
<span class="source-line-no">619</span><span id="line-619"> setBlockSize(blockSize);</span>
<span class="source-line-no">620</span><span id="line-620"> setTimeScope(timeScope);</span>
<span class="source-line-no">621</span><span id="line-621"> setTime(time);</span>
<span class="source-line-no">622</span><span id="line-622"> }</span>
<span class="source-line-no">623</span><span id="line-623"></span>
<span class="source-line-no">624</span><span id="line-624"> int getBatch() {</span>
<span class="source-line-no">625</span><span id="line-625"> return this.batch;</span>
<span class="source-line-no">626</span><span id="line-626"> }</span>
<span class="source-line-no">627</span><span id="line-627"></span>
<span class="source-line-no">628</span><span id="line-628"> void setBatch(int batch) {</span>
<span class="source-line-no">629</span><span id="line-629"> this.batch = batch;</span>
<span class="source-line-no">630</span><span id="line-630"> }</span>
<span class="source-line-no">631</span><span id="line-631"></span>
<span class="source-line-no">632</span><span id="line-632"> /** Returns true when the limit can be enforced from the scope of the checker */</span>
<span class="source-line-no">633</span><span id="line-633"> boolean canEnforceBatchLimitFromScope(LimitScope checkerScope) {</span>
<span class="source-line-no">634</span><span id="line-634"> return LimitScope.BETWEEN_CELLS.canEnforceLimitFromScope(checkerScope);</span>
<span class="source-line-no">635</span><span id="line-635"> }</span>
<span class="source-line-no">636</span><span id="line-636"></span>
<span class="source-line-no">637</span><span id="line-637"> long getDataSize() {</span>
<span class="source-line-no">638</span><span id="line-638"> return this.dataSize;</span>
<span class="source-line-no">639</span><span id="line-639"> }</span>
<span class="source-line-no">640</span><span id="line-640"></span>
<span class="source-line-no">641</span><span id="line-641"> long getHeapSize() {</span>
<span class="source-line-no">642</span><span id="line-642"> return this.heapSize;</span>
<span class="source-line-no">643</span><span id="line-643"> }</span>
<span class="source-line-no">644</span><span id="line-644"></span>
<span class="source-line-no">645</span><span id="line-645"> long getBlockSize() {</span>
<span class="source-line-no">646</span><span id="line-646"> return this.blockSize;</span>
<span class="source-line-no">647</span><span id="line-647"> }</span>
<span class="source-line-no">648</span><span id="line-648"></span>
<span class="source-line-no">649</span><span id="line-649"> void setDataSize(long dataSize) {</span>
<span class="source-line-no">650</span><span id="line-650"> this.dataSize = dataSize;</span>
<span class="source-line-no">651</span><span id="line-651"> }</span>
<span class="source-line-no">652</span><span id="line-652"></span>
<span class="source-line-no">653</span><span id="line-653"> void setHeapSize(long heapSize) {</span>
<span class="source-line-no">654</span><span id="line-654"> this.heapSize = heapSize;</span>
<span class="source-line-no">655</span><span id="line-655"> }</span>
<span class="source-line-no">656</span><span id="line-656"></span>
<span class="source-line-no">657</span><span id="line-657"> void setBlockSize(long blockSize) {</span>
<span class="source-line-no">658</span><span id="line-658"> this.blockSize = blockSize;</span>
<span class="source-line-no">659</span><span id="line-659"> }</span>
<span class="source-line-no">660</span><span id="line-660"></span>
<span class="source-line-no">661</span><span id="line-661"> /** Returns {@link LimitScope} indicating scope in which the size limit is enforced */</span>
<span class="source-line-no">662</span><span id="line-662"> LimitScope getSizeScope() {</span>
<span class="source-line-no">663</span><span id="line-663"> return this.sizeScope;</span>
<span class="source-line-no">664</span><span id="line-664"> }</span>
<span class="source-line-no">665</span><span id="line-665"></span>
<span class="source-line-no">666</span><span id="line-666"> /**</span>
<span class="source-line-no">667</span><span id="line-667"> * Change the scope in which the size limit is enforced</span>
<span class="source-line-no">668</span><span id="line-668"> */</span>
<span class="source-line-no">669</span><span id="line-669"> void setSizeScope(LimitScope scope) {</span>
<span class="source-line-no">670</span><span id="line-670"> this.sizeScope = scope;</span>
<span class="source-line-no">671</span><span id="line-671"> }</span>
<span class="source-line-no">672</span><span id="line-672"></span>
<span class="source-line-no">673</span><span id="line-673"> /** Returns true when the limit can be enforced from the scope of the checker */</span>
<span class="source-line-no">674</span><span id="line-674"> boolean canEnforceSizeLimitFromScope(LimitScope checkerScope) {</span>
<span class="source-line-no">675</span><span id="line-675"> return this.sizeScope.canEnforceLimitFromScope(checkerScope);</span>
<span class="source-line-no">676</span><span id="line-676"> }</span>
<span class="source-line-no">677</span><span id="line-677"></span>
<span class="source-line-no">678</span><span id="line-678"> long getTime() {</span>
<span class="source-line-no">679</span><span id="line-679"> return this.time;</span>
<span class="source-line-no">680</span><span id="line-680"> }</span>
<span class="source-line-no">681</span><span id="line-681"></span>
<span class="source-line-no">682</span><span id="line-682"> void setTime(long time) {</span>
<span class="source-line-no">683</span><span id="line-683"> this.time = time;</span>
<span class="source-line-no">684</span><span id="line-684"> }</span>
<span class="source-line-no">685</span><span id="line-685"></span>
<span class="source-line-no">686</span><span id="line-686"> /** Returns {@link LimitScope} indicating scope in which the time limit is enforced */</span>
<span class="source-line-no">687</span><span id="line-687"> LimitScope getTimeScope() {</span>
<span class="source-line-no">688</span><span id="line-688"> return this.timeScope;</span>
<span class="source-line-no">689</span><span id="line-689"> }</span>
<span class="source-line-no">690</span><span id="line-690"></span>
<span class="source-line-no">691</span><span id="line-691"> /**</span>
<span class="source-line-no">692</span><span id="line-692"> * Change the scope in which the time limit is enforced</span>
<span class="source-line-no">693</span><span id="line-693"> */</span>
<span class="source-line-no">694</span><span id="line-694"> void setTimeScope(LimitScope scope) {</span>
<span class="source-line-no">695</span><span id="line-695"> this.timeScope = scope;</span>
<span class="source-line-no">696</span><span id="line-696"> }</span>
<span class="source-line-no">697</span><span id="line-697"></span>
<span class="source-line-no">698</span><span id="line-698"> /** Returns true when the limit can be enforced from the scope of the checker */</span>
<span class="source-line-no">699</span><span id="line-699"> boolean canEnforceTimeLimitFromScope(LimitScope checkerScope) {</span>
<span class="source-line-no">700</span><span id="line-700"> return this.timeScope.canEnforceLimitFromScope(checkerScope);</span>
<span class="source-line-no">701</span><span id="line-701"> }</span>
<span class="source-line-no">702</span><span id="line-702"></span>
<span class="source-line-no">703</span><span id="line-703"> @Override</span>
<span class="source-line-no">704</span><span id="line-704"> public String toString() {</span>
<span class="source-line-no">705</span><span id="line-705"> StringBuilder sb = new StringBuilder();</span>
<span class="source-line-no">706</span><span id="line-706"> sb.append("{");</span>
<span class="source-line-no">707</span><span id="line-707"></span>
<span class="source-line-no">708</span><span id="line-708"> sb.append("batch:");</span>
<span class="source-line-no">709</span><span id="line-709"> sb.append(batch);</span>
<span class="source-line-no">710</span><span id="line-710"></span>
<span class="source-line-no">711</span><span id="line-711"> sb.append(", dataSize:");</span>
<span class="source-line-no">712</span><span id="line-712"> sb.append(dataSize);</span>
<span class="source-line-no">713</span><span id="line-713"></span>
<span class="source-line-no">714</span><span id="line-714"> sb.append(", heapSize:");</span>
<span class="source-line-no">715</span><span id="line-715"> sb.append(heapSize);</span>
<span class="source-line-no">716</span><span id="line-716"></span>
<span class="source-line-no">717</span><span id="line-717"> sb.append(", blockSize:");</span>
<span class="source-line-no">718</span><span id="line-718"> sb.append(blockSize);</span>
<span class="source-line-no">719</span><span id="line-719"></span>
<span class="source-line-no">720</span><span id="line-720"> sb.append(", sizeScope:");</span>
<span class="source-line-no">721</span><span id="line-721"> sb.append(sizeScope);</span>
<span class="source-line-no">722</span><span id="line-722"></span>
<span class="source-line-no">723</span><span id="line-723"> sb.append(", time:");</span>
<span class="source-line-no">724</span><span id="line-724"> sb.append(time);</span>
<span class="source-line-no">725</span><span id="line-725"></span>
<span class="source-line-no">726</span><span id="line-726"> sb.append(", timeScope:");</span>
<span class="source-line-no">727</span><span id="line-727"> sb.append(timeScope);</span>
<span class="source-line-no">728</span><span id="line-728"></span>
<span class="source-line-no">729</span><span id="line-729"> sb.append("}");</span>
<span class="source-line-no">730</span><span id="line-730"> return sb.toString();</span>
<span class="source-line-no">731</span><span id="line-731"> }</span>
<span class="source-line-no">732</span><span id="line-732"> }</span>
<span class="source-line-no">733</span><span id="line-733"></span>
<span class="source-line-no">734</span><span id="line-734"> private static class ProgressFields {</span>
<span class="source-line-no">735</span><span id="line-735"></span>
<span class="source-line-no">736</span><span id="line-736"> private static int DEFAULT_BATCH = -1;</span>
<span class="source-line-no">737</span><span id="line-737"> private static long DEFAULT_SIZE = -1L;</span>
<span class="source-line-no">738</span><span id="line-738"></span>
<span class="source-line-no">739</span><span id="line-739"> // The batch limit will always be enforced between cells, thus, there isn't a field to hold the</span>
<span class="source-line-no">740</span><span id="line-740"> // batch scope</span>
<span class="source-line-no">741</span><span id="line-741"> int batch = DEFAULT_BATCH;</span>
<span class="source-line-no">742</span><span id="line-742"></span>
<span class="source-line-no">743</span><span id="line-743"> // The sum of cell data sizes(key + value). The Cell data might be in on heap or off heap area.</span>
<span class="source-line-no">744</span><span id="line-744"> long dataSize = DEFAULT_SIZE;</span>
<span class="source-line-no">745</span><span id="line-745"> // The sum of heap space occupied by all tracked cells. This includes Cell POJO's overhead as</span>
<span class="source-line-no">746</span><span id="line-746"> // such AND data cells of Cells which are in on heap area.</span>
<span class="source-line-no">747</span><span id="line-747"> long heapSize = DEFAULT_SIZE;</span>
<span class="source-line-no">748</span><span id="line-748"> // The total amount of block bytes that have been loaded in order to process cells for the</span>
<span class="source-line-no">749</span><span id="line-749"> // request.</span>
<span class="source-line-no">750</span><span id="line-750"> long blockSize = DEFAULT_SIZE;</span>
<span class="source-line-no">751</span><span id="line-751"></span>
<span class="source-line-no">752</span><span id="line-752"> ProgressFields(int batch, long size, long heapSize, long blockSize) {</span>
<span class="source-line-no">753</span><span id="line-753"> setFields(batch, size, heapSize, blockSize);</span>
<span class="source-line-no">754</span><span id="line-754"> }</span>
<span class="source-line-no">755</span><span id="line-755"></span>
<span class="source-line-no">756</span><span id="line-756"> /**</span>
<span class="source-line-no">757</span><span id="line-757"> * Set all fields together.</span>
<span class="source-line-no">758</span><span id="line-758"> */</span>
<span class="source-line-no">759</span><span id="line-759"> void setFields(int batch, long dataSize, long heapSize, long blockSize) {</span>
<span class="source-line-no">760</span><span id="line-760"> setBatch(batch);</span>
<span class="source-line-no">761</span><span id="line-761"> setDataSize(dataSize);</span>
<span class="source-line-no">762</span><span id="line-762"> setHeapSize(heapSize);</span>
<span class="source-line-no">763</span><span id="line-763"> setBlockSize(blockSize);</span>
<span class="source-line-no">764</span><span id="line-764"> }</span>
<span class="source-line-no">765</span><span id="line-765"></span>
<span class="source-line-no">766</span><span id="line-766"> int getBatch() {</span>
<span class="source-line-no">767</span><span id="line-767"> return this.batch;</span>
<span class="source-line-no">768</span><span id="line-768"> }</span>
<span class="source-line-no">769</span><span id="line-769"></span>
<span class="source-line-no">770</span><span id="line-770"> void setBatch(int batch) {</span>
<span class="source-line-no">771</span><span id="line-771"> this.batch = batch;</span>
<span class="source-line-no">772</span><span id="line-772"> }</span>
<span class="source-line-no">773</span><span id="line-773"></span>
<span class="source-line-no">774</span><span id="line-774"> long getDataSize() {</span>
<span class="source-line-no">775</span><span id="line-775"> return this.dataSize;</span>
<span class="source-line-no">776</span><span id="line-776"> }</span>
<span class="source-line-no">777</span><span id="line-777"></span>
<span class="source-line-no">778</span><span id="line-778"> long getHeapSize() {</span>
<span class="source-line-no">779</span><span id="line-779"> return this.heapSize;</span>
<span class="source-line-no">780</span><span id="line-780"> }</span>
<span class="source-line-no">781</span><span id="line-781"></span>
<span class="source-line-no">782</span><span id="line-782"> long getBlockSize() {</span>
<span class="source-line-no">783</span><span id="line-783"> return this.blockSize;</span>
<span class="source-line-no">784</span><span id="line-784"> }</span>
<span class="source-line-no">785</span><span id="line-785"></span>
<span class="source-line-no">786</span><span id="line-786"> void setDataSize(long dataSize) {</span>
<span class="source-line-no">787</span><span id="line-787"> this.dataSize = dataSize;</span>
<span class="source-line-no">788</span><span id="line-788"> }</span>
<span class="source-line-no">789</span><span id="line-789"></span>
<span class="source-line-no">790</span><span id="line-790"> void setBlockSize(long blockSize) {</span>
<span class="source-line-no">791</span><span id="line-791"> this.blockSize = blockSize;</span>
<span class="source-line-no">792</span><span id="line-792"> }</span>
<span class="source-line-no">793</span><span id="line-793"></span>
<span class="source-line-no">794</span><span id="line-794"> void setHeapSize(long heapSize) {</span>
<span class="source-line-no">795</span><span id="line-795"> this.heapSize = heapSize;</span>
<span class="source-line-no">796</span><span id="line-796"> }</span>
<span class="source-line-no">797</span><span id="line-797"></span>
<span class="source-line-no">798</span><span id="line-798"> @Override</span>
<span class="source-line-no">799</span><span id="line-799"> public String toString() {</span>
<span class="source-line-no">800</span><span id="line-800"> StringBuilder sb = new StringBuilder();</span>
<span class="source-line-no">801</span><span id="line-801"> sb.append("{");</span>
<span class="source-line-no">802</span><span id="line-802"></span>
<span class="source-line-no">803</span><span id="line-803"> sb.append("batch:");</span>
<span class="source-line-no">804</span><span id="line-804"> sb.append(batch);</span>
<span class="source-line-no">805</span><span id="line-805"></span>
<span class="source-line-no">806</span><span id="line-806"> sb.append(", dataSize:");</span>
<span class="source-line-no">807</span><span id="line-807"> sb.append(dataSize);</span>
<span class="source-line-no">808</span><span id="line-808"></span>
<span class="source-line-no">809</span><span id="line-809"> sb.append(", heapSize:");</span>
<span class="source-line-no">810</span><span id="line-810"> sb.append(heapSize);</span>
<span class="source-line-no">811</span><span id="line-811"></span>
<span class="source-line-no">812</span><span id="line-812"> sb.append(", blockSize:");</span>
<span class="source-line-no">813</span><span id="line-813"> sb.append(blockSize);</span>
<span class="source-line-no">814</span><span id="line-814"></span>
<span class="source-line-no">815</span><span id="line-815"> sb.append("}");</span>
<span class="source-line-no">816</span><span id="line-816"> return sb.toString();</span>
<span class="source-line-no">817</span><span id="line-817"> }</span>
<span class="source-line-no">818</span><span id="line-818"> }</span>
<span class="source-line-no">819</span><span id="line-819">}</span>
</pre>
</div>
</main>
</body>
</html>