http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html b/apidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html deleted file mode 100644 index b1841ca..0000000 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html +++ /dev/null @@ -1,209 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> -<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> -<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> -<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> -<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> -<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> -<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> -<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> -<span class="sourceLineNo">009</span> *<a name="line.9"></a> -<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> -<span class="sourceLineNo">011</span> *<a name="line.11"></a> -<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> -<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> -<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> -<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> -<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> -<span class="sourceLineNo">017</span> */<a name="line.17"></a> -<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.util.Optional;<a name="line.20"></a> -<span class="sourceLineNo">021</span><a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.Result;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>/**<a name="line.26"></a> -<span class="sourceLineNo">027</span> * Receives {@link Result} for an asynchronous scan.<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> -<span class="sourceLineNo">029</span> * Notice that, the {@link #onNext(Result[], ScanController)} method will be called in the thread<a name="line.29"></a> -<span class="sourceLineNo">030</span> * which we send request to HBase service. So if you want the asynchronous scanner fetch data from<a name="line.30"></a> -<span class="sourceLineNo">031</span> * HBase in background while you process the returned data, you need to move the processing work to<a name="line.31"></a> -<span class="sourceLineNo">032</span> * another thread to make the {@code onNext} call return immediately. And please do NOT do any time<a name="line.32"></a> -<span class="sourceLineNo">033</span> * consuming tasks in all methods below unless you know what you are doing.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * @since 2.0.0<a name="line.34"></a> -<span class="sourceLineNo">035</span> */<a name="line.35"></a> -<span class="sourceLineNo">036</span>@InterfaceAudience.Public<a name="line.36"></a> -<span class="sourceLineNo">037</span>public interface RawScanResultConsumer {<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span> /**<a name="line.39"></a> -<span class="sourceLineNo">040</span> * Used to resume a scan.<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span> @InterfaceAudience.Public<a name="line.42"></a> -<span class="sourceLineNo">043</span> interface ScanResumer {<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Resume the scan. You are free to call it multiple time but only the first call will take<a name="line.46"></a> -<span class="sourceLineNo">047</span> * effect.<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> void resume();<a name="line.49"></a> -<span class="sourceLineNo">050</span> }<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * Used to suspend or stop a scan, or get a scan cursor if available.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> -<span class="sourceLineNo">055</span> * Notice that, you should only call the {@link #suspend()} or {@link #terminate()} inside onNext<a name="line.55"></a> -<span class="sourceLineNo">056</span> * or onHeartbeat method. A IllegalStateException will be thrown if you call them at other places.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * <p><a name="line.57"></a> -<span class="sourceLineNo">058</span> * You can only call one of the {@link #suspend()} and {@link #terminate()} methods(of course you<a name="line.58"></a> -<span class="sourceLineNo">059</span> * are free to not call them both), and the methods are not reentrant. An IllegalStateException<a name="line.59"></a> -<span class="sourceLineNo">060</span> * will be thrown if you have already called one of the methods.<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> @InterfaceAudience.Public<a name="line.62"></a> -<span class="sourceLineNo">063</span> interface ScanController {<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> /**<a name="line.65"></a> -<span class="sourceLineNo">066</span> * Suspend the scan.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> -<span class="sourceLineNo">068</span> * This means we will stop fetching data in background, i.e., will not call onNext any more<a name="line.68"></a> -<span class="sourceLineNo">069</span> * before you resume the scan.<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @return A resumer used to resume the scan later.<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> ScanResumer suspend();<a name="line.72"></a> -<span class="sourceLineNo">073</span><a name="line.73"></a> -<span class="sourceLineNo">074</span> /**<a name="line.74"></a> -<span class="sourceLineNo">075</span> * Terminate the scan.<a name="line.75"></a> -<span class="sourceLineNo">076</span> * <p><a name="line.76"></a> -<span class="sourceLineNo">077</span> * This is useful when you have got enough results and want to stop the scan in onNext method,<a name="line.77"></a> -<span class="sourceLineNo">078</span> * or you want to stop the scan in onHeartbeat method because it has spent too many time.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> void terminate();<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> /**<a name="line.82"></a> -<span class="sourceLineNo">083</span> * Get the scan cursor if available.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @return The scan cursor.<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> Optional<Cursor> cursor();<a name="line.86"></a> -<span class="sourceLineNo">087</span> }<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Indicate that we have receive some data.<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @param results the data fetched from HBase service.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.92"></a> -<span class="sourceLineNo">093</span> * instance is only valid within scope of onNext method. You can only call its method in<a name="line.93"></a> -<span class="sourceLineNo">094</span> * onNext, do NOT store it and call it later outside onNext.<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> void onNext(Result[] results, ScanController controller);<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * Indicate that there is a heartbeat message but we have not cumulated enough cells to call<a name="line.99"></a> -<span class="sourceLineNo">100</span> * {@link #onNext(Result[], ScanController)}.<a name="line.100"></a> -<span class="sourceLineNo">101</span> * <p><a name="line.101"></a> -<span class="sourceLineNo">102</span> * Note that this method will always be called when RS returns something to us but we do not have<a name="line.102"></a> -<span class="sourceLineNo">103</span> * enough cells to call {@link #onNext(Result[], ScanController)}. Sometimes it may not be a<a name="line.103"></a> -<span class="sourceLineNo">104</span> * 'heartbeat' message for RS, for example, we have a large row with many cells and size limit is<a name="line.104"></a> -<span class="sourceLineNo">105</span> * exceeded before sending all the cells for this row. For RS it does send some data to us and the<a name="line.105"></a> -<span class="sourceLineNo">106</span> * time limit has not been reached, but we can not return the data to client so here we call this<a name="line.106"></a> -<span class="sourceLineNo">107</span> * method to tell client we have already received something.<a name="line.107"></a> -<span class="sourceLineNo">108</span> * <p><a name="line.108"></a> -<span class="sourceLineNo">109</span> * This method give you a chance to terminate a slow scan operation.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.110"></a> -<span class="sourceLineNo">111</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.111"></a> -<span class="sourceLineNo">112</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> default void onHeartbeat(ScanController controller) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> }<a name="line.115"></a> -<span class="sourceLineNo">116</span><a name="line.116"></a> -<span class="sourceLineNo">117</span> /**<a name="line.117"></a> -<span class="sourceLineNo">118</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * <p><a name="line.119"></a> -<span class="sourceLineNo">120</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.120"></a> -<span class="sourceLineNo">121</span> */<a name="line.121"></a> -<span class="sourceLineNo">122</span> void onError(Throwable error);<a name="line.122"></a> -<span class="sourceLineNo">123</span><a name="line.123"></a> -<span class="sourceLineNo">124</span> /**<a name="line.124"></a> -<span class="sourceLineNo">125</span> * Indicate that the scan operation is completed normally.<a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> void onComplete();<a name="line.127"></a> -<span class="sourceLineNo">128</span><a name="line.128"></a> -<span class="sourceLineNo">129</span> /**<a name="line.129"></a> -<span class="sourceLineNo">130</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.130"></a> -<span class="sourceLineNo">131</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.131"></a> -<span class="sourceLineNo">132</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.132"></a> -<span class="sourceLineNo">133</span> * store it somewhere to get the metrics at any time if you want.<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.135"></a> -<span class="sourceLineNo">136</span> }<a name="line.136"></a> -<span class="sourceLineNo">137</span>}<a name="line.137"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html b/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html index 1b29966..08ef67b 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html @@ -26,41 +26,23 @@ <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Receives {@link Result} for an asynchronous scan.<a name="line.24"></a> -<span class="sourceLineNo">025</span> */<a name="line.25"></a> -<span class="sourceLineNo">026</span>@InterfaceAudience.Public<a name="line.26"></a> -<span class="sourceLineNo">027</span>public interface ScanResultConsumer {<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * @param result the data fetched from HBase service.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * @return {@code false} if you want to terminate the scan process. Otherwise {@code true}<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span> boolean onNext(Result result);<a name="line.33"></a> -<span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span> /**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> -<span class="sourceLineNo">038</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.38"></a> -<span class="sourceLineNo">039</span> */<a name="line.39"></a> -<span class="sourceLineNo">040</span> void onError(Throwable error);<a name="line.40"></a> -<span class="sourceLineNo">041</span><a name="line.41"></a> -<span class="sourceLineNo">042</span> /**<a name="line.42"></a> -<span class="sourceLineNo">043</span> * Indicate that the scan operation is completed normally.<a name="line.43"></a> -<span class="sourceLineNo">044</span> */<a name="line.44"></a> -<span class="sourceLineNo">045</span> void onComplete();<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span> /**<a name="line.47"></a> -<span class="sourceLineNo">048</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.48"></a> -<span class="sourceLineNo">049</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.49"></a> -<span class="sourceLineNo">050</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.50"></a> -<span class="sourceLineNo">051</span> * store it somewhere to get the metrics at any time if you want.<a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.53"></a> -<span class="sourceLineNo">054</span> }<a name="line.54"></a> -<span class="sourceLineNo">055</span>}<a name="line.55"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Receives {@link Result} for an asynchronous scan.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * All results that match the given scan object will be passed to this class by calling<a name="line.25"></a> +<span class="sourceLineNo">026</span> * {@link #onNext(Result)}. {@link #onComplete()} means the scan is finished, and<a name="line.26"></a> +<span class="sourceLineNo">027</span> * {@link #onError(Throwable)} means we hit an unrecoverable error and the scan is terminated.<a name="line.27"></a> +<span class="sourceLineNo">028</span> */<a name="line.28"></a> +<span class="sourceLineNo">029</span>@InterfaceAudience.Public<a name="line.29"></a> +<span class="sourceLineNo">030</span>public interface ScanResultConsumer extends ScanResultConsumerBase {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> /**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * @param result the data fetched from HBase service.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @return {@code false} if you want to terminate the scan process. Otherwise {@code true}<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span> boolean onNext(Result result);<a name="line.36"></a> +<span class="sourceLineNo">037</span>}<a name="line.37"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumerBase.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumerBase.html b/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumerBase.html new file mode 100644 index 0000000..7eb6e90 --- /dev/null +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/ScanResultConsumerBase.html @@ -0,0 +1,120 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * The base interface for scan result consumer.<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>@InterfaceAudience.Public<a name="line.26"></a> +<span class="sourceLineNo">027</span>public interface ScanResultConsumerBase {<a name="line.27"></a> +<span class="sourceLineNo">028</span> /**<a name="line.28"></a> +<span class="sourceLineNo">029</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> +<span class="sourceLineNo">031</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span> void onError(Throwable error);<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> /**<a name="line.35"></a> +<span class="sourceLineNo">036</span> * Indicate that the scan operation is completed normally.<a name="line.36"></a> +<span class="sourceLineNo">037</span> */<a name="line.37"></a> +<span class="sourceLineNo">038</span> void onComplete();<a name="line.38"></a> +<span class="sourceLineNo">039</span><a name="line.39"></a> +<span class="sourceLineNo">040</span> /**<a name="line.40"></a> +<span class="sourceLineNo">041</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.41"></a> +<span class="sourceLineNo">042</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.42"></a> +<span class="sourceLineNo">043</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.43"></a> +<span class="sourceLineNo">044</span> * store it somewhere to get the metrics at any time if you want.<a name="line.44"></a> +<span class="sourceLineNo">045</span> */<a name="line.45"></a> +<span class="sourceLineNo">046</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.46"></a> +<span class="sourceLineNo">047</span> }<a name="line.47"></a> +<span class="sourceLineNo">048</span>}<a name="line.48"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/src-html/org/apache/hadoop/hbase/client/ServiceCaller.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/ServiceCaller.html b/apidocs/src-html/org/apache/hadoop/hbase/client/ServiceCaller.html new file mode 100644 index 0000000..ea3434b --- /dev/null +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/ServiceCaller.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import com.google.protobuf.RpcCallback;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import com.google.protobuf.RpcController;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a> +<span class="sourceLineNo">024</span><a name="line.24"></a> +<span class="sourceLineNo">025</span>/**<a name="line.25"></a> +<span class="sourceLineNo">026</span> * Delegate to a protobuf rpc call.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * Usually, it is just a simple lambda expression, like:<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <pre><a name="line.30"></a> +<span class="sourceLineNo">031</span> * <code><a name="line.31"></a> +<span class="sourceLineNo">032</span> * (stub, controller, rpcCallback) -> {<a name="line.32"></a> +<span class="sourceLineNo">033</span> * XXXRequest request = ...; // prepare the request<a name="line.33"></a> +<span class="sourceLineNo">034</span> * stub.xxx(controller, request, rpcCallback);<a name="line.34"></a> +<span class="sourceLineNo">035</span> * }<a name="line.35"></a> +<span class="sourceLineNo">036</span> * </code><a name="line.36"></a> +<span class="sourceLineNo">037</span> * </pre><a name="line.37"></a> +<span class="sourceLineNo">038</span> *<a name="line.38"></a> +<span class="sourceLineNo">039</span> * And if already have the {@code request}, the lambda expression will be:<a name="line.39"></a> +<span class="sourceLineNo">040</span> *<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <pre><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <code><a name="line.42"></a> +<span class="sourceLineNo">043</span> * (stub, controller, rpcCallback) -> stub.xxx(controller, request, rpcCallback)<a name="line.43"></a> +<span class="sourceLineNo">044</span> * </code><a name="line.44"></a> +<span class="sourceLineNo">045</span> * </pre><a name="line.45"></a> +<span class="sourceLineNo">046</span> *<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @param <S> the type of the protobuf Service you want to call.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @param <R> the type of the return value.<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span>@InterfaceAudience.Public<a name="line.50"></a> +<span class="sourceLineNo">051</span>@FunctionalInterface<a name="line.51"></a> +<span class="sourceLineNo">052</span>public interface ServiceCaller<S, R> {<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Represent the actual protobuf rpc call.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param stub the asynchronous stub<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param controller the rpc controller, has already been prepared for you<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param rpcCallback the rpc callback, has already been prepared for you<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> void call(S stub, RpcController controller, RpcCallback<R> rpcCallback);<a name="line.60"></a> +<span class="sourceLineNo">061</span>}<a name="line.61"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/src-html/org/apache/hadoop/hbase/client/TableDescriptor.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/TableDescriptor.html b/apidocs/src-html/org/apache/hadoop/hbase/client/TableDescriptor.html index 83e3088..483763e 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/TableDescriptor.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/TableDescriptor.html @@ -32,249 +32,284 @@ <span class="sourceLineNo">024</span>import java.util.Iterator;<a name="line.24"></a> <span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a> <span class="sourceLineNo">026</span>import java.util.Set;<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.hadoop.hbase.TableName;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.29"></a> -<span class="sourceLineNo">030</span><a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span>/**<a name="line.32"></a> -<span class="sourceLineNo">033</span> * TableDescriptor contains the details about an HBase table such as the descriptors of<a name="line.33"></a> -<span class="sourceLineNo">034</span> * all the column families, is the table a catalog table, <code> hbase:meta </code>,<a name="line.34"></a> -<span class="sourceLineNo">035</span> * if the table is read only, the maximum size of the memstore,<a name="line.35"></a> -<span class="sourceLineNo">036</span> * when the region split should occur, coprocessors associated with it etc...<a name="line.36"></a> -<span class="sourceLineNo">037</span> */<a name="line.37"></a> -<span class="sourceLineNo">038</span>@InterfaceAudience.Public<a name="line.38"></a> -<span class="sourceLineNo">039</span>public interface TableDescriptor {<a name="line.39"></a> -<span class="sourceLineNo">040</span><a name="line.40"></a> -<span class="sourceLineNo">041</span> @InterfaceAudience.Private<a name="line.41"></a> -<span class="sourceLineNo">042</span> static final Comparator<TableDescriptor> COMPARATOR<a name="line.42"></a> -<span class="sourceLineNo">043</span> = (TableDescriptor lhs, TableDescriptor rhs) -> {<a name="line.43"></a> -<span class="sourceLineNo">044</span> int result = lhs.getTableName().compareTo(rhs.getTableName());<a name="line.44"></a> -<span class="sourceLineNo">045</span> if (result != 0) {<a name="line.45"></a> -<span class="sourceLineNo">046</span> return result;<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span> Collection<ColumnFamilyDescriptor> lhsFamilies = Arrays.asList(lhs.getColumnFamilies());<a name="line.48"></a> -<span class="sourceLineNo">049</span> Collection<ColumnFamilyDescriptor> rhsFamilies = Arrays.asList(rhs.getColumnFamilies());<a name="line.49"></a> -<span class="sourceLineNo">050</span> result = Integer.compare(lhsFamilies.size(), rhsFamilies.size());<a name="line.50"></a> -<span class="sourceLineNo">051</span> if (result != 0) {<a name="line.51"></a> -<span class="sourceLineNo">052</span> return result;<a name="line.52"></a> -<span class="sourceLineNo">053</span> }<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> for (Iterator<ColumnFamilyDescriptor> it = lhsFamilies.iterator(),<a name="line.55"></a> -<span class="sourceLineNo">056</span> it2 = rhsFamilies.iterator(); it.hasNext();) {<a name="line.56"></a> -<span class="sourceLineNo">057</span> result = ColumnFamilyDescriptor.COMPARATOR.compare(it.next(), it2.next());<a name="line.57"></a> -<span class="sourceLineNo">058</span> if (result != 0) {<a name="line.58"></a> -<span class="sourceLineNo">059</span> return result;<a name="line.59"></a> -<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HConstants;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span>/**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * TableDescriptor contains the details about an HBase table such as the descriptors of<a name="line.34"></a> +<span class="sourceLineNo">035</span> * all the column families, is the table a catalog table, <code> hbase:meta </code>,<a name="line.35"></a> +<span class="sourceLineNo">036</span> * if the table is read only, the maximum size of the memstore,<a name="line.36"></a> +<span class="sourceLineNo">037</span> * when the region split should occur, coprocessors associated with it etc...<a name="line.37"></a> +<span class="sourceLineNo">038</span> */<a name="line.38"></a> +<span class="sourceLineNo">039</span>@InterfaceAudience.Public<a name="line.39"></a> +<span class="sourceLineNo">040</span>public interface TableDescriptor {<a name="line.40"></a> +<span class="sourceLineNo">041</span><a name="line.41"></a> +<span class="sourceLineNo">042</span> @InterfaceAudience.Private<a name="line.42"></a> +<span class="sourceLineNo">043</span> Comparator<TableDescriptor> COMPARATOR = getComparator(ColumnFamilyDescriptor.COMPARATOR);<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> @InterfaceAudience.Private<a name="line.45"></a> +<span class="sourceLineNo">046</span> Comparator<TableDescriptor> COMPARATOR_IGNORE_REPLICATION =<a name="line.46"></a> +<span class="sourceLineNo">047</span> getComparator(ColumnFamilyDescriptor.COMPARATOR_IGNORE_REPLICATION);<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span> static Comparator<TableDescriptor><a name="line.49"></a> +<span class="sourceLineNo">050</span> getComparator(Comparator<ColumnFamilyDescriptor> cfComparator) {<a name="line.50"></a> +<span class="sourceLineNo">051</span> return (TableDescriptor lhs, TableDescriptor rhs) -> {<a name="line.51"></a> +<span class="sourceLineNo">052</span> int result = lhs.getTableName().compareTo(rhs.getTableName());<a name="line.52"></a> +<span class="sourceLineNo">053</span> if (result != 0) {<a name="line.53"></a> +<span class="sourceLineNo">054</span> return result;<a name="line.54"></a> +<span class="sourceLineNo">055</span> }<a name="line.55"></a> +<span class="sourceLineNo">056</span> Collection<ColumnFamilyDescriptor> lhsFamilies = Arrays.asList(lhs.getColumnFamilies());<a name="line.56"></a> +<span class="sourceLineNo">057</span> Collection<ColumnFamilyDescriptor> rhsFamilies = Arrays.asList(rhs.getColumnFamilies());<a name="line.57"></a> +<span class="sourceLineNo">058</span> result = Integer.compare(lhsFamilies.size(), rhsFamilies.size());<a name="line.58"></a> +<span class="sourceLineNo">059</span> if (result != 0) {<a name="line.59"></a> +<span class="sourceLineNo">060</span> return result;<a name="line.60"></a> <span class="sourceLineNo">061</span> }<a name="line.61"></a> -<span class="sourceLineNo">062</span> // punt on comparison for ordering, just calculate difference<a name="line.62"></a> -<span class="sourceLineNo">063</span> return Integer.compare(lhs.getValues().hashCode(), rhs.getValues().hashCode());<a name="line.63"></a> -<span class="sourceLineNo">064</span> };<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> * Returns the count of the column families of the table.<a name="line.67"></a> -<span class="sourceLineNo">068</span> *<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @return Count of column families of the table<a name="line.69"></a> -<span class="sourceLineNo">070</span> */<a name="line.70"></a> -<span class="sourceLineNo">071</span> int getColumnFamilyCount();<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> /**<a name="line.73"></a> -<span class="sourceLineNo">074</span> * Return the list of attached co-processor represented by their name<a name="line.74"></a> -<span class="sourceLineNo">075</span> * className<a name="line.75"></a> -<span class="sourceLineNo">076</span> *<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @return The list of co-processors classNames<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> Collection<String> getCoprocessors();<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * Returns the durability setting for the table.<a name="line.82"></a> -<span class="sourceLineNo">083</span> *<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @return durability setting for the table.<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> Durability getDurability();<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Returns an unmodifiable collection of all the {@link ColumnFamilyDescriptor} of<a name="line.89"></a> -<span class="sourceLineNo">090</span> * all the column families of the table.<a name="line.90"></a> -<span class="sourceLineNo">091</span> *<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @return An array of {@link ColumnFamilyDescriptor} of all the column<a name="line.92"></a> -<span class="sourceLineNo">093</span> * families.<a name="line.93"></a> +<span class="sourceLineNo">062</span><a name="line.62"></a> +<span class="sourceLineNo">063</span> for (Iterator<ColumnFamilyDescriptor> it = lhsFamilies.iterator(), it2 =<a name="line.63"></a> +<span class="sourceLineNo">064</span> rhsFamilies.iterator(); it.hasNext();) {<a name="line.64"></a> +<span class="sourceLineNo">065</span> result = cfComparator.compare(it.next(), it2.next());<a name="line.65"></a> +<span class="sourceLineNo">066</span> if (result != 0) {<a name="line.66"></a> +<span class="sourceLineNo">067</span> return result;<a name="line.67"></a> +<span class="sourceLineNo">068</span> }<a name="line.68"></a> +<span class="sourceLineNo">069</span> }<a name="line.69"></a> +<span class="sourceLineNo">070</span> // punt on comparison for ordering, just calculate difference<a name="line.70"></a> +<span class="sourceLineNo">071</span> return Integer.compare(lhs.getValues().hashCode(), rhs.getValues().hashCode());<a name="line.71"></a> +<span class="sourceLineNo">072</span> };<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * Returns the count of the column families of the table.<a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @return Count of column families of the table<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span> int getColumnFamilyCount();<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> /**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * Return the list of attached co-processor represented by their name<a name="line.83"></a> +<span class="sourceLineNo">084</span> * className<a name="line.84"></a> +<span class="sourceLineNo">085</span> *<a name="line.85"></a> +<span class="sourceLineNo">086</span> * @return The list of co-processors classNames<a name="line.86"></a> +<span class="sourceLineNo">087</span> */<a name="line.87"></a> +<span class="sourceLineNo">088</span> Collection<String> getCoprocessors();<a name="line.88"></a> +<span class="sourceLineNo">089</span><a name="line.89"></a> +<span class="sourceLineNo">090</span> /**<a name="line.90"></a> +<span class="sourceLineNo">091</span> * Returns the durability setting for the table.<a name="line.91"></a> +<span class="sourceLineNo">092</span> *<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @return durability setting for the table.<a name="line.93"></a> <span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> ColumnFamilyDescriptor[] getColumnFamilies();<a name="line.95"></a> +<span class="sourceLineNo">095</span> Durability getDurability();<a name="line.95"></a> <span class="sourceLineNo">096</span><a name="line.96"></a> <span class="sourceLineNo">097</span> /**<a name="line.97"></a> -<span class="sourceLineNo">098</span> * Returns all the column family names of the current table. The map of<a name="line.98"></a> -<span class="sourceLineNo">099</span> * TableDescriptor contains mapping of family name to ColumnDescriptor.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * This returns all the keys of the family map which represents the column<a name="line.100"></a> -<span class="sourceLineNo">101</span> * family names of the table.<a name="line.101"></a> -<span class="sourceLineNo">102</span> *<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @return Immutable sorted set of the keys of the families.<a name="line.103"></a> -<span class="sourceLineNo">104</span> */<a name="line.104"></a> -<span class="sourceLineNo">105</span> Set<byte[]> getColumnFamilyNames();<a name="line.105"></a> -<span class="sourceLineNo">106</span><a name="line.106"></a> -<span class="sourceLineNo">107</span> /**<a name="line.107"></a> -<span class="sourceLineNo">108</span> * Returns the ColumnDescriptor for a specific column family with name as<a name="line.108"></a> -<span class="sourceLineNo">109</span> * specified by the parameter column.<a name="line.109"></a> -<span class="sourceLineNo">110</span> *<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @param name Column family name<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @return Column descriptor for the passed family name or the family on<a name="line.112"></a> -<span class="sourceLineNo">113</span> * passed in column.<a name="line.113"></a> -<span class="sourceLineNo">114</span> */<a name="line.114"></a> -<span class="sourceLineNo">115</span> ColumnFamilyDescriptor getColumnFamily(final byte[] name);<a name="line.115"></a> -<span class="sourceLineNo">116</span><a name="line.116"></a> -<span class="sourceLineNo">117</span> /**<a name="line.117"></a> -<span class="sourceLineNo">118</span> * This gets the class associated with the flush policy which determines the<a name="line.118"></a> -<span class="sourceLineNo">119</span> * stores need to be flushed when flushing a region. The class used by default<a name="line.119"></a> -<span class="sourceLineNo">120</span> * is defined in org.apache.hadoop.hbase.regionserver.FlushPolicy.<a name="line.120"></a> -<span class="sourceLineNo">121</span> *<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @return the class name of the flush policy for this table. If this returns<a name="line.122"></a> -<span class="sourceLineNo">123</span> * null, the default flush policy is used.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> String getFlushPolicyClassName();<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * Returns the maximum size upto which a region can grow to after which a<a name="line.128"></a> -<span class="sourceLineNo">129</span> * region split is triggered. The region size is represented by the size of<a name="line.129"></a> -<span class="sourceLineNo">130</span> * the biggest store file in that region.<a name="line.130"></a> -<span class="sourceLineNo">131</span> *<a name="line.131"></a> -<span class="sourceLineNo">132</span> * @return max hregion size for table, -1 if not set.<a name="line.132"></a> +<span class="sourceLineNo">098</span> * Returns an unmodifiable collection of all the {@link ColumnFamilyDescriptor} of<a name="line.98"></a> +<span class="sourceLineNo">099</span> * all the column families of the table.<a name="line.99"></a> +<span class="sourceLineNo">100</span> *<a name="line.100"></a> +<span class="sourceLineNo">101</span> * @return An array of {@link ColumnFamilyDescriptor} of all the column<a name="line.101"></a> +<span class="sourceLineNo">102</span> * families.<a name="line.102"></a> +<span class="sourceLineNo">103</span> */<a name="line.103"></a> +<span class="sourceLineNo">104</span> ColumnFamilyDescriptor[] getColumnFamilies();<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> /**<a name="line.106"></a> +<span class="sourceLineNo">107</span> * Returns all the column family names of the current table. The map of<a name="line.107"></a> +<span class="sourceLineNo">108</span> * TableDescriptor contains mapping of family name to ColumnDescriptor.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * This returns all the keys of the family map which represents the column<a name="line.109"></a> +<span class="sourceLineNo">110</span> * family names of the table.<a name="line.110"></a> +<span class="sourceLineNo">111</span> *<a name="line.111"></a> +<span class="sourceLineNo">112</span> * @return Immutable sorted set of the keys of the families.<a name="line.112"></a> +<span class="sourceLineNo">113</span> */<a name="line.113"></a> +<span class="sourceLineNo">114</span> Set<byte[]> getColumnFamilyNames();<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * Returns the ColumnDescriptor for a specific column family with name as<a name="line.117"></a> +<span class="sourceLineNo">118</span> * specified by the parameter column.<a name="line.118"></a> +<span class="sourceLineNo">119</span> *<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param name Column family name<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return Column descriptor for the passed family name or the family on<a name="line.121"></a> +<span class="sourceLineNo">122</span> * passed in column.<a name="line.122"></a> +<span class="sourceLineNo">123</span> */<a name="line.123"></a> +<span class="sourceLineNo">124</span> ColumnFamilyDescriptor getColumnFamily(final byte[] name);<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> /**<a name="line.126"></a> +<span class="sourceLineNo">127</span> * This gets the class associated with the flush policy which determines the<a name="line.127"></a> +<span class="sourceLineNo">128</span> * stores need to be flushed when flushing a region. The class used by default<a name="line.128"></a> +<span class="sourceLineNo">129</span> * is defined in org.apache.hadoop.hbase.regionserver.FlushPolicy.<a name="line.129"></a> +<span class="sourceLineNo">130</span> *<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @return the class name of the flush policy for this table. If this returns<a name="line.131"></a> +<span class="sourceLineNo">132</span> * null, the default flush policy is used.<a name="line.132"></a> <span class="sourceLineNo">133</span> */<a name="line.133"></a> -<span class="sourceLineNo">134</span> long getMaxFileSize();<a name="line.134"></a> +<span class="sourceLineNo">134</span> String getFlushPolicyClassName();<a name="line.134"></a> <span class="sourceLineNo">135</span><a name="line.135"></a> <span class="sourceLineNo">136</span> /**<a name="line.136"></a> -<span class="sourceLineNo">137</span> * Returns the size of the memstore after which a flush to filesystem is<a name="line.137"></a> -<span class="sourceLineNo">138</span> * triggered.<a name="line.138"></a> -<span class="sourceLineNo">139</span> *<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @return memory cache flush size for each hregion, -1 if not set.<a name="line.140"></a> -<span class="sourceLineNo">141</span> */<a name="line.141"></a> -<span class="sourceLineNo">142</span> long getMemStoreFlushSize();<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> // TODO: Currently this is used RPC scheduling only. Make it more generic than this; allow it<a name="line.144"></a> -<span class="sourceLineNo">145</span> // to also be priority when scheduling procedures that pertain to this table scheduling first<a name="line.145"></a> -<span class="sourceLineNo">146</span> // those tables with the highest priority (From Yi Liang over on HBASE-18109).<a name="line.146"></a> -<span class="sourceLineNo">147</span> int getPriority();<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> /**<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @return Returns the configured replicas per region<a name="line.150"></a> -<span class="sourceLineNo">151</span> */<a name="line.151"></a> -<span class="sourceLineNo">152</span> int getRegionReplication();<a name="line.152"></a> -<span class="sourceLineNo">153</span><a name="line.153"></a> -<span class="sourceLineNo">154</span> /**<a name="line.154"></a> -<span class="sourceLineNo">155</span> * This gets the class associated with the region split policy which<a name="line.155"></a> -<span class="sourceLineNo">156</span> * determines when a region split should occur. The class used by default is<a name="line.156"></a> -<span class="sourceLineNo">157</span> * defined in org.apache.hadoop.hbase.regionserver.RegionSplitPolicy<a name="line.157"></a> -<span class="sourceLineNo">158</span> *<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @return the class name of the region split policy for this table. If this<a name="line.159"></a> -<span class="sourceLineNo">160</span> * returns null, the default split policy is used.<a name="line.160"></a> -<span class="sourceLineNo">161</span> */<a name="line.161"></a> -<span class="sourceLineNo">162</span> String getRegionSplitPolicyClassName();<a name="line.162"></a> -<span class="sourceLineNo">163</span><a name="line.163"></a> -<span class="sourceLineNo">164</span> /**<a name="line.164"></a> -<span class="sourceLineNo">165</span> * Get the name of the table<a name="line.165"></a> -<span class="sourceLineNo">166</span> *<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @return TableName<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> TableName getTableName();<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> @Deprecated<a name="line.171"></a> -<span class="sourceLineNo">172</span> String getOwnerString();<a name="line.172"></a> -<span class="sourceLineNo">173</span><a name="line.173"></a> -<span class="sourceLineNo">174</span> /**<a name="line.174"></a> -<span class="sourceLineNo">175</span> * Getter for accessing the metadata associated with the key.<a name="line.175"></a> -<span class="sourceLineNo">176</span> *<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @param key The key.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @return A clone value. Null if no mapping for the key<a name="line.178"></a> -<span class="sourceLineNo">179</span> */<a name="line.179"></a> -<span class="sourceLineNo">180</span> Bytes getValue(Bytes key);<a name="line.180"></a> -<span class="sourceLineNo">181</span><a name="line.181"></a> -<span class="sourceLineNo">182</span> /**<a name="line.182"></a> -<span class="sourceLineNo">183</span> * Getter for accessing the metadata associated with the key.<a name="line.183"></a> -<span class="sourceLineNo">184</span> *<a name="line.184"></a> -<span class="sourceLineNo">185</span> * @param key The key.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @return A clone value. Null if no mapping for the key<a name="line.186"></a> -<span class="sourceLineNo">187</span> */<a name="line.187"></a> -<span class="sourceLineNo">188</span> byte[] getValue(byte[] key);<a name="line.188"></a> -<span class="sourceLineNo">189</span><a name="line.189"></a> -<span class="sourceLineNo">190</span> /**<a name="line.190"></a> -<span class="sourceLineNo">191</span> * Getter for accessing the metadata associated with the key.<a name="line.191"></a> -<span class="sourceLineNo">192</span> *<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param key The key.<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @return Null if no mapping for the key<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> String getValue(String key);<a name="line.196"></a> -<span class="sourceLineNo">197</span><a name="line.197"></a> -<span class="sourceLineNo">198</span> /**<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return Getter for fetching an unmodifiable map.<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> Map<Bytes, Bytes> getValues();<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /**<a name="line.203"></a> -<span class="sourceLineNo">204</span> * Check if the table has an attached co-processor represented by the name<a name="line.204"></a> -<span class="sourceLineNo">205</span> * className<a name="line.205"></a> -<span class="sourceLineNo">206</span> *<a name="line.206"></a> -<span class="sourceLineNo">207</span> * @param classNameToMatch - Class name of the co-processor<a name="line.207"></a> -<span class="sourceLineNo">208</span> * @return true of the table has a co-processor className<a name="line.208"></a> +<span class="sourceLineNo">137</span> * Returns the maximum size upto which a region can grow to after which a<a name="line.137"></a> +<span class="sourceLineNo">138</span> * region split is triggered. The region size is represented by the size of<a name="line.138"></a> +<span class="sourceLineNo">139</span> * the biggest store file in that region.<a name="line.139"></a> +<span class="sourceLineNo">140</span> *<a name="line.140"></a> +<span class="sourceLineNo">141</span> * @return max hregion size for table, -1 if not set.<a name="line.141"></a> +<span class="sourceLineNo">142</span> */<a name="line.142"></a> +<span class="sourceLineNo">143</span> long getMaxFileSize();<a name="line.143"></a> +<span class="sourceLineNo">144</span><a name="line.144"></a> +<span class="sourceLineNo">145</span> /**<a name="line.145"></a> +<span class="sourceLineNo">146</span> * Returns the size of the memstore after which a flush to filesystem is<a name="line.146"></a> +<span class="sourceLineNo">147</span> * triggered.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @return memory cache flush size for each hregion, -1 if not set.<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> long getMemStoreFlushSize();<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> // TODO: Currently this is used RPC scheduling only. Make it more generic than this; allow it<a name="line.153"></a> +<span class="sourceLineNo">154</span> // to also be priority when scheduling procedures that pertain to this table scheduling first<a name="line.154"></a> +<span class="sourceLineNo">155</span> // those tables with the highest priority (From Yi Liang over on HBASE-18109).<a name="line.155"></a> +<span class="sourceLineNo">156</span> int getPriority();<a name="line.156"></a> +<span class="sourceLineNo">157</span><a name="line.157"></a> +<span class="sourceLineNo">158</span> /**<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @return Returns the configured replicas per region<a name="line.159"></a> +<span class="sourceLineNo">160</span> */<a name="line.160"></a> +<span class="sourceLineNo">161</span> int getRegionReplication();<a name="line.161"></a> +<span class="sourceLineNo">162</span><a name="line.162"></a> +<span class="sourceLineNo">163</span> /**<a name="line.163"></a> +<span class="sourceLineNo">164</span> * This gets the class associated with the region split policy which<a name="line.164"></a> +<span class="sourceLineNo">165</span> * determines when a region split should occur. The class used by default is<a name="line.165"></a> +<span class="sourceLineNo">166</span> * defined in org.apache.hadoop.hbase.regionserver.RegionSplitPolicy<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return the class name of the region split policy for this table. If this<a name="line.168"></a> +<span class="sourceLineNo">169</span> * returns null, the default split policy is used.<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> String getRegionSplitPolicyClassName();<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Get the name of the table<a name="line.174"></a> +<span class="sourceLineNo">175</span> *<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @return TableName<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> TableName getTableName();<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> @Deprecated<a name="line.180"></a> +<span class="sourceLineNo">181</span> String getOwnerString();<a name="line.181"></a> +<span class="sourceLineNo">182</span><a name="line.182"></a> +<span class="sourceLineNo">183</span> /**<a name="line.183"></a> +<span class="sourceLineNo">184</span> * Getter for accessing the metadata associated with the key.<a name="line.184"></a> +<span class="sourceLineNo">185</span> *<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param key The key.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @return A clone value. Null if no mapping for the key<a name="line.187"></a> +<span class="sourceLineNo">188</span> */<a name="line.188"></a> +<span class="sourceLineNo">189</span> Bytes getValue(Bytes key);<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> * Getter for accessing the metadata associated with the key.<a name="line.192"></a> +<span class="sourceLineNo">193</span> *<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param key The key.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @return A clone value. Null if no mapping for the key<a name="line.195"></a> +<span class="sourceLineNo">196</span> */<a name="line.196"></a> +<span class="sourceLineNo">197</span> byte[] getValue(byte[] key);<a name="line.197"></a> +<span class="sourceLineNo">198</span><a name="line.198"></a> +<span class="sourceLineNo">199</span> /**<a name="line.199"></a> +<span class="sourceLineNo">200</span> * Getter for accessing the metadata associated with the key.<a name="line.200"></a> +<span class="sourceLineNo">201</span> *<a name="line.201"></a> +<span class="sourceLineNo">202</span> * @param key The key.<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @return Null if no mapping for the key<a name="line.203"></a> +<span class="sourceLineNo">204</span> */<a name="line.204"></a> +<span class="sourceLineNo">205</span> String getValue(String key);<a name="line.205"></a> +<span class="sourceLineNo">206</span><a name="line.206"></a> +<span class="sourceLineNo">207</span> /**<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @return Getter for fetching an unmodifiable map.<a name="line.208"></a> <span class="sourceLineNo">209</span> */<a name="line.209"></a> -<span class="sourceLineNo">210</span> boolean hasCoprocessor(String classNameToMatch);<a name="line.210"></a> +<span class="sourceLineNo">210</span> Map<Bytes, Bytes> getValues();<a name="line.210"></a> <span class="sourceLineNo">211</span><a name="line.211"></a> <span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * Checks to see if this table contains the given column family<a name="line.213"></a> -<span class="sourceLineNo">214</span> *<a name="line.214"></a> -<span class="sourceLineNo">215</span> * @param name Family name or column name.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @return true if the table contains the specified family name<a name="line.216"></a> -<span class="sourceLineNo">217</span> */<a name="line.217"></a> -<span class="sourceLineNo">218</span> boolean hasColumnFamily(final byte[] name);<a name="line.218"></a> -<span class="sourceLineNo">219</span><a name="line.219"></a> -<span class="sourceLineNo">220</span> /**<a name="line.220"></a> -<span class="sourceLineNo">221</span> * @return true if the read-replicas memstore replication is enabled.<a name="line.221"></a> -<span class="sourceLineNo">222</span> */<a name="line.222"></a> -<span class="sourceLineNo">223</span> boolean hasRegionMemStoreReplication();<a name="line.223"></a> -<span class="sourceLineNo">224</span><a name="line.224"></a> -<span class="sourceLineNo">225</span> /**<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @return true if there are at least one cf whose replication scope is<a name="line.226"></a> -<span class="sourceLineNo">227</span> * serial.<a name="line.227"></a> -<span class="sourceLineNo">228</span> */<a name="line.228"></a> -<span class="sourceLineNo">229</span> boolean hasSerialReplicationScope();<a name="line.229"></a> -<span class="sourceLineNo">230</span><a name="line.230"></a> -<span class="sourceLineNo">231</span> /**<a name="line.231"></a> -<span class="sourceLineNo">232</span> * Check if the compaction enable flag of the table is true. If flag is false<a name="line.232"></a> -<span class="sourceLineNo">233</span> * then no minor/major compactions will be done in real.<a name="line.233"></a> -<span class="sourceLineNo">234</span> *<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @return true if table compaction enabled<a name="line.235"></a> -<span class="sourceLineNo">236</span> */<a name="line.236"></a> -<span class="sourceLineNo">237</span> boolean isCompactionEnabled();<a name="line.237"></a> -<span class="sourceLineNo">238</span><a name="line.238"></a> -<span class="sourceLineNo">239</span> /**<a name="line.239"></a> -<span class="sourceLineNo">240</span> * Checks if this table is <code> hbase:meta </code> region.<a name="line.240"></a> -<span class="sourceLineNo">241</span> *<a name="line.241"></a> -<span class="sourceLineNo">242</span> * @return true if this table is <code> hbase:meta </code> region<a name="line.242"></a> -<span class="sourceLineNo">243</span> */<a name="line.243"></a> -<span class="sourceLineNo">244</span> boolean isMetaRegion();<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Checks if the table is a <code>hbase:meta</code> table<a name="line.247"></a> -<span class="sourceLineNo">248</span> *<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @return true if table is <code> hbase:meta </code> region.<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> boolean isMetaTable();<a name="line.251"></a> -<span class="sourceLineNo">252</span><a name="line.252"></a> -<span class="sourceLineNo">253</span> /**<a name="line.253"></a> -<span class="sourceLineNo">254</span> * Check if normalization enable flag of the table is true. If flag is false<a name="line.254"></a> -<span class="sourceLineNo">255</span> * then no region normalizer won't attempt to normalize this table.<a name="line.255"></a> -<span class="sourceLineNo">256</span> *<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @return true if region normalization is enabled for this table<a name="line.257"></a> -<span class="sourceLineNo">258</span> */<a name="line.258"></a> -<span class="sourceLineNo">259</span> boolean isNormalizationEnabled();<a name="line.259"></a> -<span class="sourceLineNo">260</span><a name="line.260"></a> -<span class="sourceLineNo">261</span> /**<a name="line.261"></a> -<span class="sourceLineNo">262</span> * Check if the readOnly flag of the table is set. If the readOnly flag is set<a name="line.262"></a> -<span class="sourceLineNo">263</span> * then the contents of the table can only be read from but not modified.<a name="line.263"></a> -<span class="sourceLineNo">264</span> *<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @return true if all columns in the table should be read only<a name="line.265"></a> -<span class="sourceLineNo">266</span> */<a name="line.266"></a> -<span class="sourceLineNo">267</span> boolean isReadOnly();<a name="line.267"></a> -<span class="sourceLineNo">268</span><a name="line.268"></a> -<span class="sourceLineNo">269</span>}<a name="line.269"></a> +<span class="sourceLineNo">213</span> * Check if the table has an attached co-processor represented by the name<a name="line.213"></a> +<span class="sourceLineNo">214</span> * className<a name="line.214"></a> +<span class="sourceLineNo">215</span> *<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @param classNameToMatch - Class name of the co-processor<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @return true of the table has a co-processor className<a name="line.217"></a> +<span class="sourceLineNo">218</span> */<a name="line.218"></a> +<span class="sourceLineNo">219</span> boolean hasCoprocessor(String classNameToMatch);<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> /**<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Checks to see if this table contains the given column family<a name="line.222"></a> +<span class="sourceLineNo">223</span> *<a name="line.223"></a> +<span class="sourceLineNo">224</span> * @param name Family name or column name.<a name="line.224"></a> +<span class="sourceLineNo">225</span> * @return true if the table contains the specified family name<a name="line.225"></a> +<span class="sourceLineNo">226</span> */<a name="line.226"></a> +<span class="sourceLineNo">227</span> boolean hasColumnFamily(final byte[] name);<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> * @return true if the read-replicas memstore replication is enabled.<a name="line.230"></a> +<span class="sourceLineNo">231</span> */<a name="line.231"></a> +<span class="sourceLineNo">232</span> boolean hasRegionMemStoreReplication();<a name="line.232"></a> +<span class="sourceLineNo">233</span><a name="line.233"></a> +<span class="sourceLineNo">234</span> /**<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @return true if there are at least one cf whose replication scope is<a name="line.235"></a> +<span class="sourceLineNo">236</span> * serial.<a name="line.236"></a> +<span class="sourceLineNo">237</span> */<a name="line.237"></a> +<span class="sourceLineNo">238</span> boolean hasSerialReplicationScope();<a name="line.238"></a> +<span class="sourceLineNo">239</span><a name="line.239"></a> +<span class="sourceLineNo">240</span> /**<a name="line.240"></a> +<span class="sourceLineNo">241</span> * Check if the compaction enable flag of the table is true. If flag is false<a name="line.241"></a> +<span class="sourceLineNo">242</span> * then no minor/major compactions will be done in real.<a name="line.242"></a> +<span class="sourceLineNo">243</span> *<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @return true if table compaction enabled<a name="line.244"></a> +<span class="sourceLineNo">245</span> */<a name="line.245"></a> +<span class="sourceLineNo">246</span> boolean isCompactionEnabled();<a name="line.246"></a> +<span class="sourceLineNo">247</span><a name="line.247"></a> +<span class="sourceLineNo">248</span> /**<a name="line.248"></a> +<span class="sourceLineNo">249</span> * Checks if this table is <code> hbase:meta </code> region.<a name="line.249"></a> +<span class="sourceLineNo">250</span> *<a name="line.250"></a> +<span class="sourceLineNo">251</span> * @return true if this table is <code> hbase:meta </code> region<a name="line.251"></a> +<span class="sourceLineNo">252</span> */<a name="line.252"></a> +<span class="sourceLineNo">253</span> boolean isMetaRegion();<a name="line.253"></a> +<span class="sourceLineNo">254</span><a name="line.254"></a> +<span class="sourceLineNo">255</span> /**<a name="line.255"></a> +<span class="sourceLineNo">256</span> * Checks if the table is a <code>hbase:meta</code> table<a name="line.256"></a> +<span class="sourceLineNo">257</span> *<a name="line.257"></a> +<span class="sourceLineNo">258</span> * @return true if table is <code> hbase:meta </code> region.<a name="line.258"></a> +<span class="sourceLineNo">259</span> */<a name="line.259"></a> +<span class="sourceLineNo">260</span> boolean isMetaTable();<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Check if normalization enable flag of the table is true. If flag is false<a name="line.263"></a> +<span class="sourceLineNo">264</span> * then no region normalizer won't attempt to normalize this table.<a name="line.264"></a> +<span class="sourceLineNo">265</span> *<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return true if region normalization is enabled for this table<a name="line.266"></a> +<span class="sourceLineNo">267</span> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> boolean isNormalizationEnabled();<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Check if the readOnly flag of the table is set. If the readOnly flag is set<a name="line.271"></a> +<span class="sourceLineNo">272</span> * then the contents of the table can only be read from but not modified.<a name="line.272"></a> +<span class="sourceLineNo">273</span> *<a name="line.273"></a> +<span class="sourceLineNo">274</span> * @return true if all columns in the table should be read only<a name="line.274"></a> +<span class="sourceLineNo">275</span> */<a name="line.275"></a> +<span class="sourceLineNo">276</span> boolean isReadOnly();<a name="line.276"></a> +<span class="sourceLineNo">277</span><a name="line.277"></a> +<span class="sourceLineNo">278</span> /**<a name="line.278"></a> +<span class="sourceLineNo">279</span> * Check if the table's cfs' replication scope matched with the replication state<a name="line.279"></a> +<span class="sourceLineNo">280</span> * @param enabled replication state<a name="line.280"></a> +<span class="sourceLineNo">281</span> * @return true if matched, otherwise false<a name="line.281"></a> +<span class="sourceLineNo">282</span> */<a name="line.282"></a> +<span class="sourceLineNo">283</span> default boolean matchReplicationScope(boolean enabled) {<a name="line.283"></a> +<span class="sourceLineNo">284</span> boolean hasEnabled = false;<a name="line.284"></a> +<span class="sourceLineNo">285</span> boolean hasDisabled = false;<a name="line.285"></a> +<span class="sourceLineNo">286</span><a name="line.286"></a> +<span class="sourceLineNo">287</span> for (ColumnFamilyDescriptor cf : getColumnFamilies()) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> if (cf.getScope() != HConstants.REPLICATION_SCOPE_GLOBAL<a name="line.288"></a> +<span class="sourceLineNo">289</span> && cf.getScope() != HConstants.REPLICATION_SCOPE_SERIAL) {<a name="line.289"></a> +<span class="sourceLineNo">290</span> hasDisabled = true;<a name="line.290"></a> +<span class="sourceLineNo">291</span> } else {<a name="line.291"></a> +<span class="sourceLineNo">292</span> hasEnabled = true;<a name="line.292"></a> +<span class="sourceLineNo">293</span> }<a name="line.293"></a> +<span class="sourceLineNo">294</span> }<a name="line.294"></a> +<span class="sourceLineNo">295</span><a name="line.295"></a> +<span class="sourceLineNo">296</span> if (hasEnabled && hasDisabled) {<a name="line.296"></a> +<span class="sourceLineNo">297</span> return false;<a name="line.297"></a> +<span class="sourceLineNo">298</span> }<a name="line.298"></a> +<span class="sourceLineNo">299</span> if (hasEnabled) {<a name="line.299"></a> +<span class="sourceLineNo">300</span> return enabled;<a name="line.300"></a> +<span class="sourceLineNo">301</span> }<a name="line.301"></a> +<span class="sourceLineNo">302</span> return !enabled;<a name="line.302"></a> +<span class="sourceLineNo">303</span> }<a name="line.303"></a> +<span class="sourceLineNo">304</span>}<a name="line.304"></a>
