| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.regionserver;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.Closeable;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Internal scanners differ from client-side scanners in that they operate on<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * HStoreKeys and byte[] instead of RowResults. This is because they are<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * actually close to how the data is physically stored, and therefore it is more<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * convenient to interact with them that way. It is also much easier to merge<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * the results across SortedMaps than RowResults.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <p>Additionally, we need to be able to determine if the scanner is doing<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * wildcard column matches (when only a column family is specified or if a<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * column regex is specified) or if multiple members of the same column family<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * were specified. If so, we need to ignore the timestamp to ensure that we get<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * all the family members, as they may have been last updated at different<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * times.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>@InterfaceStability.Evolving<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public interface InternalScanner extends Closeable {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Grab the next row's worth of values.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param result return output array<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @return true if more rows exist after this one, false if scanner is done<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @throws IOException e<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> default boolean next(List<Cell> result) throws IOException {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> return next(result, NoLimitScannerContext.getInstance());<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Grab the next row's worth of values.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param result return output array<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @param scannerContext<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @return true if more rows exist after this one, false if scanner is done<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @throws IOException e<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> boolean next(List<Cell> result, ScannerContext scannerContext) throws IOException;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Closes the scanner and releases any resources it has allocated<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @throws IOException<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> @Override<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> void close() throws IOException;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span>}<a name="line.72"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
