http://git-wip-us.apache.org/repos/asf/hbase-site/blob/db523e4d/apidocs/src-html/org/apache/hadoop/hbase/client/HConnection.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/HConnection.html b/apidocs/src-html/org/apache/hadoop/hbase/client/HConnection.html deleted file mode 100644 index b403eb8..0000000 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/HConnection.html +++ /dev/null @@ -1,698 +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> *<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.client;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.concurrent.ExecutorService;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HRegionLocation;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HTableDescriptor;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.MasterNotRunningException;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.ServerName;<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.ZooKeeperConnectionException;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.coprocessor.Batch;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.MasterService;<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span>/**<a name="line.38"></a> -<span class="sourceLineNo">039</span> * A cluster connection. Knows how to find the master, locate regions out on the cluster,<a name="line.39"></a> -<span class="sourceLineNo">040</span> * keeps a cache of locations and then knows how to re-calibrate after they move. You need one<a name="line.40"></a> -<span class="sourceLineNo">041</span> * of these to talk to your HBase cluster. {@link ConnectionFactory} manages instances of this<a name="line.41"></a> -<span class="sourceLineNo">042</span> * class. See it for how to get one of these.<a name="line.42"></a> -<span class="sourceLineNo">043</span> *<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <p>This is NOT a connection to a particular server but to ALL servers in the cluster. Individual<a name="line.44"></a> -<span class="sourceLineNo">045</span> * connections are managed at a lower level.<a name="line.45"></a> -<span class="sourceLineNo">046</span> *<a name="line.46"></a> -<span class="sourceLineNo">047</span> * <p>HConnections are used by {@link HTable} mostly but also by<a name="line.47"></a> -<span class="sourceLineNo">048</span> * {@link HBaseAdmin}, and {@link org.apache.hadoop.hbase.zookeeper.MetaTableLocator}. <a name="line.48"></a> -<span class="sourceLineNo">049</span> *<a name="line.49"></a> -<span class="sourceLineNo">050</span> * @see ConnectionFactory<a name="line.50"></a> -<span class="sourceLineNo">051</span> * @deprecated in favor of {@link Connection} and {@link ConnectionFactory}<a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span>@InterfaceAudience.Public<a name="line.53"></a> -<span class="sourceLineNo">054</span>@InterfaceStability.Stable<a name="line.54"></a> -<span class="sourceLineNo">055</span>@Deprecated<a name="line.55"></a> -<span class="sourceLineNo">056</span>public interface HConnection extends Connection {<a name="line.56"></a> -<span class="sourceLineNo">057</span> /**<a name="line.57"></a> -<span class="sourceLineNo">058</span> * Key for configuration in Configuration whose value is the class we implement making a<a name="line.58"></a> -<span class="sourceLineNo">059</span> * new HConnection instance.<a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span> public static final String HBASE_CLIENT_CONNECTION_IMPL = "hbase.client.connection.impl";<a name="line.61"></a> -<span class="sourceLineNo">062</span><a name="line.62"></a> -<span class="sourceLineNo">063</span> /**<a name="line.63"></a> -<span class="sourceLineNo">064</span> * @return Configuration instance being used by this HConnection instance.<a name="line.64"></a> -<span class="sourceLineNo">065</span> */<a name="line.65"></a> -<span class="sourceLineNo">066</span> @Override<a name="line.66"></a> -<span class="sourceLineNo">067</span> Configuration getConfiguration();<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> * Retrieve an HTableInterface implementation for access to a table.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * The returned HTableInterface is not thread safe, a new instance should<a name="line.71"></a> -<span class="sourceLineNo">072</span> * be created for each using thread.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * This is a lightweight operation, pooling or caching of the returned HTableInterface<a name="line.73"></a> -<span class="sourceLineNo">074</span> * is neither required nor desired.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * (created with {@link ConnectionFactory#createConnection(Configuration)}).<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param tableName<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @return an HTable to use for interactions with this table<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> public HTableInterface getTable(String tableName) throws IOException;<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> * Retrieve an HTableInterface implementation for access to a table.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * The returned HTableInterface is not thread safe, a new instance should<a name="line.83"></a> -<span class="sourceLineNo">084</span> * be created for each using thread.<a name="line.84"></a> -<span class="sourceLineNo">085</span> * This is a lightweight operation, pooling or caching of the returned HTableInterface<a name="line.85"></a> -<span class="sourceLineNo">086</span> * is neither required nor desired.<a name="line.86"></a> -<span class="sourceLineNo">087</span> * (created with {@link ConnectionFactory#createConnection(Configuration)}).<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param tableName<a name="line.88"></a> -<span class="sourceLineNo">089</span> * @return an HTable to use for interactions with this table<a name="line.89"></a> -<span class="sourceLineNo">090</span> */<a name="line.90"></a> -<span class="sourceLineNo">091</span> public HTableInterface getTable(byte[] tableName) throws IOException;<a name="line.91"></a> -<span class="sourceLineNo">092</span><a name="line.92"></a> -<span class="sourceLineNo">093</span> /**<a name="line.93"></a> -<span class="sourceLineNo">094</span> * Retrieve an HTableInterface implementation for access to a table.<a name="line.94"></a> -<span class="sourceLineNo">095</span> * The returned HTableInterface is not thread safe, a new instance should<a name="line.95"></a> -<span class="sourceLineNo">096</span> * be created for each using thread.<a name="line.96"></a> -<span class="sourceLineNo">097</span> * This is a lightweight operation, pooling or caching of the returned HTableInterface<a name="line.97"></a> -<span class="sourceLineNo">098</span> * is neither required nor desired.<a name="line.98"></a> -<span class="sourceLineNo">099</span> * (created with {@link ConnectionFactory#createConnection(Configuration)}).<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @param tableName<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @return an HTable to use for interactions with this table<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> @Override<a name="line.103"></a> -<span class="sourceLineNo">104</span> public HTableInterface getTable(TableName tableName) throws IOException;<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> * Retrieve an HTableInterface implementation for access to a table.<a name="line.107"></a> -<span class="sourceLineNo">108</span> * The returned HTableInterface is not thread safe, a new instance should<a name="line.108"></a> -<span class="sourceLineNo">109</span> * be created for each using thread.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * This is a lightweight operation, pooling or caching of the returned HTableInterface<a name="line.110"></a> -<span class="sourceLineNo">111</span> * is neither required nor desired.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * (created with {@link ConnectionFactory#createConnection(Configuration)}).<a name="line.112"></a> -<span class="sourceLineNo">113</span> * @param tableName<a name="line.113"></a> -<span class="sourceLineNo">114</span> * @param pool The thread pool to use for batch operations, null to use a default pool.<a name="line.114"></a> -<span class="sourceLineNo">115</span> * @return an HTable to use for interactions with this table<a name="line.115"></a> -<span class="sourceLineNo">116</span> */<a name="line.116"></a> -<span class="sourceLineNo">117</span> public HTableInterface getTable(String tableName, ExecutorService pool) throws IOException;<a name="line.117"></a> -<span class="sourceLineNo">118</span><a name="line.118"></a> -<span class="sourceLineNo">119</span> /**<a name="line.119"></a> -<span class="sourceLineNo">120</span> * Retrieve an HTableInterface implementation for access to a table.<a name="line.120"></a> -<span class="sourceLineNo">121</span> * The returned HTableInterface is not thread safe, a new instance should<a name="line.121"></a> -<span class="sourceLineNo">122</span> * be created for each using thread.<a name="line.122"></a> -<span class="sourceLineNo">123</span> * This is a lightweight operation, pooling or caching of the returned HTableInterface<a name="line.123"></a> -<span class="sourceLineNo">124</span> * is neither required nor desired.<a name="line.124"></a> -<span class="sourceLineNo">125</span> * (created with {@link ConnectionFactory#createConnection(Configuration)}).<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param tableName<a name="line.126"></a> -<span class="sourceLineNo">127</span> * @param pool The thread pool to use for batch operations, null to use a default pool.<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @return an HTable to use for interactions with this table<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> public HTableInterface getTable(byte[] tableName, ExecutorService pool) throws IOException;<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Retrieve an HTableInterface implementation for access to a table.<a name="line.133"></a> -<span class="sourceLineNo">134</span> * The returned HTableInterface is not thread safe, a new instance should<a name="line.134"></a> -<span class="sourceLineNo">135</span> * be created for each using thread.<a name="line.135"></a> -<span class="sourceLineNo">136</span> * This is a lightweight operation, pooling or caching of the returned HTableInterface<a name="line.136"></a> -<span class="sourceLineNo">137</span> * is neither required nor desired.<a name="line.137"></a> -<span class="sourceLineNo">138</span> * (created with {@link ConnectionFactory#createConnection(Configuration)}).<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param tableName table to get interface for<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @param pool The thread pool to use for batch operations, null to use a default pool.<a name="line.140"></a> -<span class="sourceLineNo">141</span> * @return an HTable to use for interactions with this table<a name="line.141"></a> -<span class="sourceLineNo">142</span> */<a name="line.142"></a> -<span class="sourceLineNo">143</span> @Override<a name="line.143"></a> -<span class="sourceLineNo">144</span> public HTableInterface getTable(TableName tableName, ExecutorService pool) throws IOException;<a name="line.144"></a> -<span class="sourceLineNo">145</span><a name="line.145"></a> -<span class="sourceLineNo">146</span> /**<a name="line.146"></a> -<span class="sourceLineNo">147</span> * Retrieve a RegionLocator implementation to inspect region information on a table. The returned<a name="line.147"></a> -<span class="sourceLineNo">148</span> * RegionLocator is not thread-safe, so a new instance should be created for each using thread.<a name="line.148"></a> -<span class="sourceLineNo">149</span> *<a name="line.149"></a> -<span class="sourceLineNo">150</span> * This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither<a name="line.150"></a> -<span class="sourceLineNo">151</span> * required nor desired.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param tableName Name of the table who's region is to be examined<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @return A RegionLocator instance<a name="line.153"></a> -<span class="sourceLineNo">154</span> */<a name="line.154"></a> -<span class="sourceLineNo">155</span> @Override<a name="line.155"></a> -<span class="sourceLineNo">156</span> public RegionLocator getRegionLocator(TableName tableName) throws IOException;<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> * Retrieve an Admin implementation to administer an HBase cluster.<a name="line.159"></a> -<span class="sourceLineNo">160</span> * The returned Admin is not guaranteed to be thread-safe. A new instance should be created for<a name="line.160"></a> -<span class="sourceLineNo">161</span> * each using thread. This is a lightweight operation. Pooling or caching of the returned<a name="line.161"></a> -<span class="sourceLineNo">162</span> * Admin is not recommended.<a name="line.162"></a> -<span class="sourceLineNo">163</span> *<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @return an Admin instance for cluster administration<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> @Override<a name="line.166"></a> -<span class="sourceLineNo">167</span> Admin getAdmin() throws IOException;<a name="line.167"></a> -<span class="sourceLineNo">168</span><a name="line.168"></a> -<span class="sourceLineNo">169</span> /** @return - true if the master server is running<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @deprecated internal method, do not use thru HConnection */<a name="line.170"></a> -<span class="sourceLineNo">171</span> @Deprecated<a name="line.171"></a> -<span class="sourceLineNo">172</span> boolean isMasterRunning()<a name="line.172"></a> -<span class="sourceLineNo">173</span> throws MasterNotRunningException, ZooKeeperConnectionException;<a name="line.173"></a> -<span class="sourceLineNo">174</span><a name="line.174"></a> -<span class="sourceLineNo">175</span> /**<a name="line.175"></a> -<span class="sourceLineNo">176</span> * A table that isTableEnabled == false and isTableDisabled == false<a name="line.176"></a> -<span class="sourceLineNo">177</span> * is possible. This happens when a table has a lot of regions<a name="line.177"></a> -<span class="sourceLineNo">178</span> * that must be processed.<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @param tableName table name<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return true if the table is enabled, false otherwise<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @throws IOException if a remote or network exception occurs<a name="line.181"></a> -<span class="sourceLineNo">182</span> */<a name="line.182"></a> -<span class="sourceLineNo">183</span> boolean isTableEnabled(TableName tableName) throws IOException;<a name="line.183"></a> -<span class="sourceLineNo">184</span><a name="line.184"></a> -<span class="sourceLineNo">185</span> /**<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @deprecated instead use {@link #isTableEnabled(TableName)}<a name="line.186"></a> -<span class="sourceLineNo">187</span> */<a name="line.187"></a> -<span class="sourceLineNo">188</span> @Deprecated<a name="line.188"></a> -<span class="sourceLineNo">189</span> boolean isTableEnabled(byte[] tableName) throws IOException;<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> * @param tableName table name<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @return true if the table is disabled, false otherwise<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @throws IOException if a remote or network exception occurs<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> boolean isTableDisabled(TableName tableName) throws IOException;<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> * @deprecated instead use {@link #isTableDisabled(TableName)}<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> @Deprecated<a name="line.201"></a> -<span class="sourceLineNo">202</span> boolean isTableDisabled(byte[] tableName) throws IOException;<a name="line.202"></a> -<span class="sourceLineNo">203</span><a name="line.203"></a> -<span class="sourceLineNo">204</span> /**<a name="line.204"></a> -<span class="sourceLineNo">205</span> * Retrieve TableState, represent current table state.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * @param tableName table state for<a name="line.206"></a> -<span class="sourceLineNo">207</span> * @return state of the table<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> public TableState getTableState(TableName tableName) throws IOException;<a name="line.209"></a> -<span class="sourceLineNo">210</span><a name="line.210"></a> -<span class="sourceLineNo">211</span> /**<a name="line.211"></a> -<span class="sourceLineNo">212</span> * @param tableName table name<a name="line.212"></a> -<span class="sourceLineNo">213</span> * @return true if all regions of the table are available, false otherwise<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @throws IOException if a remote or network exception occurs<a name="line.214"></a> -<span class="sourceLineNo">215</span> */<a name="line.215"></a> -<span class="sourceLineNo">216</span> boolean isTableAvailable(TableName tableName) throws IOException;<a name="line.216"></a> -<span class="sourceLineNo">217</span><a name="line.217"></a> -<span class="sourceLineNo">218</span> /**<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @deprecated instead use {@link #isTableAvailable(TableName)}<a name="line.219"></a> -<span class="sourceLineNo">220</span> */<a name="line.220"></a> -<span class="sourceLineNo">221</span> @Deprecated<a name="line.221"></a> -<span class="sourceLineNo">222</span> boolean isTableAvailable(byte[] tableName) throws IOException;<a name="line.222"></a> -<span class="sourceLineNo">223</span><a name="line.223"></a> -<span class="sourceLineNo">224</span> /**<a name="line.224"></a> -<span class="sourceLineNo">225</span> * Use this api to check if the table has been created with the specified number of<a name="line.225"></a> -<span class="sourceLineNo">226</span> * splitkeys which was used while creating the given table.<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Note : If this api is used after a table's region gets splitted, the api may return<a name="line.227"></a> -<span class="sourceLineNo">228</span> * false.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @param tableName tableName<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @param splitKeys splitKeys used while creating table<a name="line.230"></a> -<span class="sourceLineNo">231</span> * @throws IOException if a remote or network exception occurs<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @deprecated internal method, do not use through HConnection */<a name="line.232"></a> -<span class="sourceLineNo">233</span> @Deprecated<a name="line.233"></a> -<span class="sourceLineNo">234</span> boolean isTableAvailable(TableName tableName, byte[][] splitKeys) throws IOException;<a name="line.234"></a> -<span class="sourceLineNo">235</span><a name="line.235"></a> -<span class="sourceLineNo">236</span> /**<a name="line.236"></a> -<span class="sourceLineNo">237</span> * @deprecated internal method, do not use through HConnection<a name="line.237"></a> -<span class="sourceLineNo">238</span> */<a name="line.238"></a> -<span class="sourceLineNo">239</span> @Deprecated<a name="line.239"></a> -<span class="sourceLineNo">240</span> boolean isTableAvailable(byte[] tableName, byte[][] splitKeys) throws IOException;<a name="line.240"></a> -<span class="sourceLineNo">241</span><a name="line.241"></a> -<span class="sourceLineNo">242</span> /**<a name="line.242"></a> -<span class="sourceLineNo">243</span> * List all the userspace tables. In other words, scan the hbase:meta table.<a name="line.243"></a> -<span class="sourceLineNo">244</span> *<a name="line.244"></a> -<span class="sourceLineNo">245</span> * @return - returns an array of HTableDescriptors<a name="line.245"></a> -<span class="sourceLineNo">246</span> * @throws IOException if a remote or network exception occurs<a name="line.246"></a> -<span class="sourceLineNo">247</span> * @deprecated Use {@link Admin#listTables()} instead.<a name="line.247"></a> -<span class="sourceLineNo">248</span> */<a name="line.248"></a> -<span class="sourceLineNo">249</span> @Deprecated<a name="line.249"></a> -<span class="sourceLineNo">250</span> HTableDescriptor[] listTables() throws IOException;<a name="line.250"></a> -<span class="sourceLineNo">251</span><a name="line.251"></a> -<span class="sourceLineNo">252</span> // This is a bit ugly - We call this getTableNames in 0.94 and the<a name="line.252"></a> -<span class="sourceLineNo">253</span> // successor function, returning TableName, listTableNames in later versions<a name="line.253"></a> -<span class="sourceLineNo">254</span> // because Java polymorphism doesn't consider return value types<a name="line.254"></a> -<span class="sourceLineNo">255</span><a name="line.255"></a> -<span class="sourceLineNo">256</span> /**<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @deprecated Use {@link Admin#listTableNames()} instead.<a name="line.257"></a> -<span class="sourceLineNo">258</span> */<a name="line.258"></a> -<span class="sourceLineNo">259</span> @Deprecated<a name="line.259"></a> -<span class="sourceLineNo">260</span> String[] getTableNames() throws IOException;<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> * @deprecated Use {@link Admin#listTables()} instead.<a name="line.263"></a> -<span class="sourceLineNo">264</span> */<a name="line.264"></a> -<span class="sourceLineNo">265</span> @Deprecated<a name="line.265"></a> -<span class="sourceLineNo">266</span> TableName[] listTableNames() throws IOException;<a name="line.266"></a> -<span class="sourceLineNo">267</span><a name="line.267"></a> -<span class="sourceLineNo">268</span> /**<a name="line.268"></a> -<span class="sourceLineNo">269</span> * @param tableName table name<a name="line.269"></a> -<span class="sourceLineNo">270</span> * @return table metadata<a name="line.270"></a> -<span class="sourceLineNo">271</span> * @throws IOException if a remote or network exception occurs<a name="line.271"></a> -<span class="sourceLineNo">272</span> * @deprecated internal method, do not use through HConnection<a name="line.272"></a> -<span class="sourceLineNo">273</span> */<a name="line.273"></a> -<span class="sourceLineNo">274</span> @Deprecated<a name="line.274"></a> -<span class="sourceLineNo">275</span> HTableDescriptor getHTableDescriptor(TableName tableName)<a name="line.275"></a> -<span class="sourceLineNo">276</span> throws IOException;<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> * @deprecated internal method, do not use through HConnection<a name="line.279"></a> -<span class="sourceLineNo">280</span> */<a name="line.280"></a> -<span class="sourceLineNo">281</span> @Deprecated<a name="line.281"></a> -<span class="sourceLineNo">282</span> HTableDescriptor getHTableDescriptor(byte[] tableName)<a name="line.282"></a> -<span class="sourceLineNo">283</span> throws IOException;<a name="line.283"></a> -<span class="sourceLineNo">284</span><a name="line.284"></a> -<span class="sourceLineNo">285</span> /**<a name="line.285"></a> -<span class="sourceLineNo">286</span> * Find the location of the region of <i>tableName</i> that <i>row</i><a name="line.286"></a> -<span class="sourceLineNo">287</span> * lives in.<a name="line.287"></a> -<span class="sourceLineNo">288</span> * @param tableName name of the table <i>row</i> is in<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @param row row key you're trying to find the region of<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @return HRegionLocation that describes where to find the region in<a name="line.290"></a> -<span class="sourceLineNo">291</span> * question<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @throws IOException if a remote or network exception occurs<a name="line.292"></a> -<span class="sourceLineNo">293</span> * @deprecated internal method, do not use through HConnection<a name="line.293"></a> -<span class="sourceLineNo">294</span> */<a name="line.294"></a> -<span class="sourceLineNo">295</span> @Deprecated<a name="line.295"></a> -<span class="sourceLineNo">296</span> public HRegionLocation locateRegion(final TableName tableName,<a name="line.296"></a> -<span class="sourceLineNo">297</span> final byte [] row) throws IOException;<a name="line.297"></a> -<span class="sourceLineNo">298</span><a name="line.298"></a> -<span class="sourceLineNo">299</span> /**<a name="line.299"></a> -<span class="sourceLineNo">300</span> * @deprecated internal method, do not use through HConnection<a name="line.300"></a> -<span class="sourceLineNo">301</span> */<a name="line.301"></a> -<span class="sourceLineNo">302</span> @Deprecated<a name="line.302"></a> -<span class="sourceLineNo">303</span> public HRegionLocation locateRegion(final byte[] tableName,<a name="line.303"></a> -<span class="sourceLineNo">304</span> final byte [] row) throws IOException;<a name="line.304"></a> -<span class="sourceLineNo">305</span><a name="line.305"></a> -<span class="sourceLineNo">306</span> /**<a name="line.306"></a> -<span class="sourceLineNo">307</span> * Allows flushing the region cache.<a name="line.307"></a> -<span class="sourceLineNo">308</span> * @deprecated internal method, do not use through HConnection */<a name="line.308"></a> -<span class="sourceLineNo">309</span> @Deprecated<a name="line.309"></a> -<span class="sourceLineNo">310</span> void clearRegionCache();<a name="line.310"></a> -<span class="sourceLineNo">311</span><a name="line.311"></a> -<span class="sourceLineNo">312</span> /**<a name="line.312"></a> -<span class="sourceLineNo">313</span> * Allows flushing the region cache of all locations that pertain to<a name="line.313"></a> -<span class="sourceLineNo">314</span> * <code>tableName</code><a name="line.314"></a> -<span class="sourceLineNo">315</span> * @param tableName Name of the table whose regions we are to remove from<a name="line.315"></a> -<span class="sourceLineNo">316</span> * cache.<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @deprecated internal method, do not use through HConnection */<a name="line.317"></a> -<span class="sourceLineNo">318</span> @Deprecated<a name="line.318"></a> -<span class="sourceLineNo">319</span> void clearRegionCache(final TableName tableName);<a name="line.319"></a> -<span class="sourceLineNo">320</span><a name="line.320"></a> -<span class="sourceLineNo">321</span> /**<a name="line.321"></a> -<span class="sourceLineNo">322</span> * @deprecated internal method, do not use through HConnection<a name="line.322"></a> -<span class="sourceLineNo">323</span> */<a name="line.323"></a> -<span class="sourceLineNo">324</span> @Deprecated<a name="line.324"></a> -<span class="sourceLineNo">325</span> void clearRegionCache(final byte[] tableName);<a name="line.325"></a> -<span class="sourceLineNo">326</span><a name="line.326"></a> -<span class="sourceLineNo">327</span> /**<a name="line.327"></a> -<span class="sourceLineNo">328</span> * Deletes cached locations for the specific region.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @param location The location object for the region, to be purged from cache.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * @deprecated internal method, do not use thru HConnection */<a name="line.330"></a> -<span class="sourceLineNo">331</span> @Deprecated<a name="line.331"></a> -<span class="sourceLineNo">332</span> void deleteCachedRegionLocation(final HRegionLocation location);<a name="line.332"></a> -<span class="sourceLineNo">333</span><a name="line.333"></a> -<span class="sourceLineNo">334</span> /**<a name="line.334"></a> -<span class="sourceLineNo">335</span> * Find the location of the region of <i>tableName</i> that <i>row</i><a name="line.335"></a> -<span class="sourceLineNo">336</span> * lives in, ignoring any value that might be in the cache.<a name="line.336"></a> -<span class="sourceLineNo">337</span> * @param tableName name of the table <i>row</i> is in<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @param row row key you're trying to find the region of<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @return HRegionLocation that describes where to find the region in<a name="line.339"></a> -<span class="sourceLineNo">340</span> * question<a name="line.340"></a> -<span class="sourceLineNo">341</span> * @throws IOException if a remote or network exception occurs<a name="line.341"></a> -<span class="sourceLineNo">342</span> * @deprecated internal method, do not use through HConnection */<a name="line.342"></a> -<span class="sourceLineNo">343</span> @Deprecated<a name="line.343"></a> -<span class="sourceLineNo">344</span> HRegionLocation relocateRegion(final TableName tableName,<a name="line.344"></a> -<span class="sourceLineNo">345</span> final byte [] row) throws IOException;<a name="line.345"></a> -<span class="sourceLineNo">346</span><a name="line.346"></a> -<span class="sourceLineNo">347</span> /**<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @deprecated internal method, do not use through HConnection<a name="line.348"></a> -<span class="sourceLineNo">349</span> */<a name="line.349"></a> -<span class="sourceLineNo">350</span> @Deprecated<a name="line.350"></a> -<span class="sourceLineNo">351</span> HRegionLocation relocateRegion(final byte[] tableName,<a name="line.351"></a> -<span class="sourceLineNo">352</span> final byte [] row) throws IOException;<a name="line.352"></a> -<span class="sourceLineNo">353</span><a name="line.353"></a> -<span class="sourceLineNo">354</span> /**<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @deprecated internal method, do not use through HConnection<a name="line.355"></a> -<span class="sourceLineNo">356</span> */<a name="line.356"></a> -<span class="sourceLineNo">357</span> @Deprecated<a name="line.357"></a> -<span class="sourceLineNo">358</span> void updateCachedLocations(TableName tableName, byte[] rowkey,<a name="line.358"></a> -<span class="sourceLineNo">359</span> Object exception, HRegionLocation source);<a name="line.359"></a> -<span class="sourceLineNo">360</span><a name="line.360"></a> -<span class="sourceLineNo">361</span> /**<a name="line.361"></a> -<span class="sourceLineNo">362</span> * Update the location cache. This is used internally by HBase, in most cases it should not be<a name="line.362"></a> -<span class="sourceLineNo">363</span> * used by the client application.<a name="line.363"></a> -<span class="sourceLineNo">364</span> * @param tableName the table name<a name="line.364"></a> -<span class="sourceLineNo">365</span> * @param regionName the regionName<a name="line.365"></a> -<span class="sourceLineNo">366</span> * @param rowkey the row<a name="line.366"></a> -<span class="sourceLineNo">367</span> * @param exception the exception if any. Can be null.<a name="line.367"></a> -<span class="sourceLineNo">368</span> * @param source the previous location<a name="line.368"></a> -<span class="sourceLineNo">369</span> * @deprecated internal method, do not use through HConnection<a name="line.369"></a> -<span class="sourceLineNo">370</span> */<a name="line.370"></a> -<span class="sourceLineNo">371</span> @Deprecated<a name="line.371"></a> -<span class="sourceLineNo">372</span> void updateCachedLocations(TableName tableName, byte[] regionName, byte[] rowkey,<a name="line.372"></a> -<span class="sourceLineNo">373</span> Object exception, ServerName source);<a name="line.373"></a> -<span class="sourceLineNo">374</span> /**<a name="line.374"></a> -<span class="sourceLineNo">375</span> * @deprecated internal method, do not use through HConnection<a name="line.375"></a> -<span class="sourceLineNo">376</span> */<a name="line.376"></a> -<span class="sourceLineNo">377</span> @Deprecated<a name="line.377"></a> -<span class="sourceLineNo">378</span> void updateCachedLocations(byte[] tableName, byte[] rowkey,<a name="line.378"></a> -<span class="sourceLineNo">379</span> Object exception, HRegionLocation source);<a name="line.379"></a> -<span class="sourceLineNo">380</span><a name="line.380"></a> -<span class="sourceLineNo">381</span> /**<a name="line.381"></a> -<span class="sourceLineNo">382</span> * Gets the location of the region of <i>regionName</i>.<a name="line.382"></a> -<span class="sourceLineNo">383</span> * @param regionName name of the region to locate<a name="line.383"></a> -<span class="sourceLineNo">384</span> * @return HRegionLocation that describes where to find the region in<a name="line.384"></a> -<span class="sourceLineNo">385</span> * question<a name="line.385"></a> -<span class="sourceLineNo">386</span> * @throws IOException if a remote or network exception occurs<a name="line.386"></a> -<span class="sourceLineNo">387</span> * @deprecated internal method, do not use thru HConnection */<a name="line.387"></a> -<span class="sourceLineNo">388</span> @Deprecated<a name="line.388"></a> -<span class="sourceLineNo">389</span> HRegionLocation locateRegion(final byte[] regionName)<a name="line.389"></a> -<span class="sourceLineNo">390</span> throws IOException;<a name="line.390"></a> -<span class="sourceLineNo">391</span><a name="line.391"></a> -<span class="sourceLineNo">392</span> /**<a name="line.392"></a> -<span class="sourceLineNo">393</span> * Gets the locations of all regions in the specified table, <i>tableName</i>.<a name="line.393"></a> -<span class="sourceLineNo">394</span> * @param tableName table to get regions of<a name="line.394"></a> -<span class="sourceLineNo">395</span> * @return list of region locations for all regions of table<a name="line.395"></a> -<span class="sourceLineNo">396</span> * @throws IOException<a name="line.396"></a> -<span class="sourceLineNo">397</span> * @deprecated internal method, do not use thru HConnection */<a name="line.397"></a> -<span class="sourceLineNo">398</span> @Deprecated<a name="line.398"></a> -<span class="sourceLineNo">399</span> List<HRegionLocation> locateRegions(final TableName tableName) throws IOException;<a name="line.399"></a> -<span class="sourceLineNo">400</span><a name="line.400"></a> -<span class="sourceLineNo">401</span> /**<a name="line.401"></a> -<span class="sourceLineNo">402</span> * @deprecated internal method, do not use through HConnection<a name="line.402"></a> -<span class="sourceLineNo">403</span> */<a name="line.403"></a> -<span class="sourceLineNo">404</span> @Deprecated<a name="line.404"></a> -<span class="sourceLineNo">405</span> List<HRegionLocation> locateRegions(final byte[] tableName) throws IOException;<a name="line.405"></a> -<span class="sourceLineNo">406</span><a name="line.406"></a> -<span class="sourceLineNo">407</span> /**<a name="line.407"></a> -<span class="sourceLineNo">408</span> * Gets the locations of all regions in the specified table, <i>tableName</i>.<a name="line.408"></a> -<span class="sourceLineNo">409</span> * @param tableName table to get regions of<a name="line.409"></a> -<span class="sourceLineNo">410</span> * @param useCache Should we use the cache to retrieve the region information.<a name="line.410"></a> -<span class="sourceLineNo">411</span> * @param offlined True if we are to include offlined regions, false and we'll leave out offlined<a name="line.411"></a> -<span class="sourceLineNo">412</span> * regions from returned list.<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @return list of region locations for all regions of table<a name="line.413"></a> -<span class="sourceLineNo">414</span> * @throws IOException<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @deprecated internal method, do not use thru HConnection<a name="line.415"></a> -<span class="sourceLineNo">416</span> */<a name="line.416"></a> -<span class="sourceLineNo">417</span> @Deprecated<a name="line.417"></a> -<span class="sourceLineNo">418</span> public List<HRegionLocation> locateRegions(final TableName tableName,<a name="line.418"></a> -<span class="sourceLineNo">419</span> final boolean useCache,<a name="line.419"></a> -<span class="sourceLineNo">420</span> final boolean offlined) throws IOException;<a name="line.420"></a> -<span class="sourceLineNo">421</span><a name="line.421"></a> -<span class="sourceLineNo">422</span> /**<a name="line.422"></a> -<span class="sourceLineNo">423</span> * @deprecated internal method, do not use through HConnection<a name="line.423"></a> -<span class="sourceLineNo">424</span> */<a name="line.424"></a> -<span class="sourceLineNo">425</span> @Deprecated<a name="line.425"></a> -<span class="sourceLineNo">426</span> public List<HRegionLocation> locateRegions(final byte[] tableName,<a name="line.426"></a> -<span class="sourceLineNo">427</span> final boolean useCache,<a name="line.427"></a> -<span class="sourceLineNo">428</span> final boolean offlined) throws IOException;<a name="line.428"></a> -<span class="sourceLineNo">429</span><a name="line.429"></a> -<span class="sourceLineNo">430</span> /**<a name="line.430"></a> -<span class="sourceLineNo">431</span> * Returns a {@link MasterKeepAliveConnection} to the active master<a name="line.431"></a> -<span class="sourceLineNo">432</span> * @deprecated internal method, do not use thru HConnection */<a name="line.432"></a> -<span class="sourceLineNo">433</span> @Deprecated<a name="line.433"></a> -<span class="sourceLineNo">434</span> MasterService.BlockingInterface getMaster() throws IOException;<a name="line.434"></a> -<span class="sourceLineNo">435</span><a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Establishes a connection to the region server at the specified address.<a name="line.438"></a> -<span class="sourceLineNo">439</span> * @param serverName<a name="line.439"></a> -<span class="sourceLineNo">440</span> * @return proxy for HRegionServer<a name="line.440"></a> -<span class="sourceLineNo">441</span> * @throws IOException if a remote or network exception occurs<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @deprecated internal method, do not use thru HConnection */<a name="line.442"></a> -<span class="sourceLineNo">443</span> @Deprecated<a name="line.443"></a> -<span class="sourceLineNo">444</span> AdminService.BlockingInterface getAdmin(final ServerName serverName) throws IOException;<a name="line.444"></a> -<span class="sourceLineNo">445</span><a name="line.445"></a> -<span class="sourceLineNo">446</span> /**<a name="line.446"></a> -<span class="sourceLineNo">447</span> * Establishes a connection to the region server at the specified address, and returns<a name="line.447"></a> -<span class="sourceLineNo">448</span> * a region client protocol.<a name="line.448"></a> -<span class="sourceLineNo">449</span> *<a name="line.449"></a> -<span class="sourceLineNo">450</span> * @param serverName<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @return ClientProtocol proxy for RegionServer<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @throws IOException if a remote or network exception occurs<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @deprecated internal method, do not use thru HConnection */<a name="line.453"></a> -<span class="sourceLineNo">454</span> @Deprecated<a name="line.454"></a> -<span class="sourceLineNo">455</span> ClientService.BlockingInterface getClient(final ServerName serverName) throws IOException;<a name="line.455"></a> -<span class="sourceLineNo">456</span><a name="line.456"></a> -<span class="sourceLineNo">457</span> /**<a name="line.457"></a> -<span class="sourceLineNo">458</span> * Establishes a connection to the region server at the specified address.<a name="line.458"></a> -<span class="sourceLineNo">459</span> * @param serverName<a name="line.459"></a> -<span class="sourceLineNo">460</span> * @param getMaster do we check if master is alive<a name="line.460"></a> -<span class="sourceLineNo">461</span> * @return proxy for HRegionServer<a name="line.461"></a> -<span class="sourceLineNo">462</span> * @throws IOException if a remote or network exception occurs<a name="line.462"></a> -<span class="sourceLineNo">463</span> * @deprecated You can pass master flag but nothing special is done.<a name="line.463"></a> -<span class="sourceLineNo">464</span> */<a name="line.464"></a> -<span class="sourceLineNo">465</span> @Deprecated<a name="line.465"></a> -<span class="sourceLineNo">466</span> AdminService.BlockingInterface getAdmin(final ServerName serverName, boolean getMaster)<a name="line.466"></a> -<span class="sourceLineNo">467</span> throws IOException;<a name="line.467"></a> -<span class="sourceLineNo">468</span><a name="line.468"></a> -<span class="sourceLineNo">469</span> /**<a name="line.469"></a> -<span class="sourceLineNo">470</span> * Find region location hosting passed row<a name="line.470"></a> -<span class="sourceLineNo">471</span> * @param tableName table name<a name="line.471"></a> -<span class="sourceLineNo">472</span> * @param row Row to find.<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param reload If true do not use cache, otherwise bypass.<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @return Location of row.<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @throws IOException if a remote or network exception occurs<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @deprecated internal method, do not use thru HConnection */<a name="line.476"></a> -<span class="sourceLineNo">477</span> @Deprecated<a name="line.477"></a> -<span class="sourceLineNo">478</span> HRegionLocation getRegionLocation(TableName tableName, byte [] row,<a name="line.478"></a> -<span class="sourceLineNo">479</span> boolean reload)<a name="line.479"></a> -<span class="sourceLineNo">480</span> throws IOException;<a name="line.480"></a> -<span class="sourceLineNo">481</span><a name="line.481"></a> -<span class="sourceLineNo">482</span> /**<a name="line.482"></a> -<span class="sourceLineNo">483</span> * @deprecated internal method, do not use through HConnection<a name="line.483"></a> -<span class="sourceLineNo">484</span> */<a name="line.484"></a> -<span class="sourceLineNo">485</span> @Deprecated<a name="line.485"></a> -<span class="sourceLineNo">486</span> HRegionLocation getRegionLocation(byte[] tableName, byte [] row,<a name="line.486"></a> -<span class="sourceLineNo">487</span> boolean reload)<a name="line.487"></a> -<span class="sourceLineNo">488</span> throws IOException;<a name="line.488"></a> -<span class="sourceLineNo">489</span><a name="line.489"></a> -<span class="sourceLineNo">490</span> /**<a name="line.490"></a> -<span class="sourceLineNo">491</span> * Process a mixed batch of Get, Put and Delete actions. All actions for a<a name="line.491"></a> -<span class="sourceLineNo">492</span> * RegionServer are forwarded in one RPC call.<a name="line.492"></a> -<span class="sourceLineNo">493</span> *<a name="line.493"></a> -<span class="sourceLineNo">494</span> *<a name="line.494"></a> -<span class="sourceLineNo">495</span> * @param actions The collection of actions.<a name="line.495"></a> -<span class="sourceLineNo">496</span> * @param tableName Name of the hbase table<a name="line.496"></a> -<span class="sourceLineNo">497</span> * @param pool thread pool for parallel execution<a name="line.497"></a> -<span class="sourceLineNo">498</span> * @param results An empty array, same size as list. If an exception is thrown,<a name="line.498"></a> -<span class="sourceLineNo">499</span> * you can test here for partial results, and to determine which actions<a name="line.499"></a> -<span class="sourceLineNo">500</span> * processed successfully.<a name="line.500"></a> -<span class="sourceLineNo">501</span> * @throws IOException if there are problems talking to META. Per-item<a name="line.501"></a> -<span class="sourceLineNo">502</span> * exceptions are stored in the results array.<a name="line.502"></a> -<span class="sourceLineNo">503</span> * @deprecated since 0.96 - Use {@link HTableInterface#batch} instead<a name="line.503"></a> -<span class="sourceLineNo">504</span> */<a name="line.504"></a> -<span class="sourceLineNo">505</span> @Deprecated<a name="line.505"></a> -<span class="sourceLineNo">506</span> void processBatch(List<? extends Row> actions, final TableName tableName,<a name="line.506"></a> -<span class="sourceLineNo">507</span> ExecutorService pool, Object[] results) throws IOException, InterruptedException;<a name="line.507"></a> -<span class="sourceLineNo">508</span><a name="line.508"></a> -<span class="sourceLineNo">509</span> /**<a name="line.509"></a> -<span class="sourceLineNo">510</span> * @deprecated internal method, do not use through HConnection<a name="line.510"></a> -<span class="sourceLineNo">511</span> */<a name="line.511"></a> -<span class="sourceLineNo">512</span> @Deprecated<a name="line.512"></a> -<span class="sourceLineNo">513</span> void processBatch(List<? extends Row> actions, final byte[] tableName,<a name="line.513"></a> -<span class="sourceLineNo">514</span> ExecutorService pool, Object[] results) throws IOException, InterruptedException;<a name="line.514"></a> -<span class="sourceLineNo">515</span><a name="line.515"></a> -<span class="sourceLineNo">516</span> /**<a name="line.516"></a> -<span class="sourceLineNo">517</span> * Parameterized batch processing, allowing varying return types for different<a name="line.517"></a> -<span class="sourceLineNo">518</span> * {@link Row} implementations.<a name="line.518"></a> -<span class="sourceLineNo">519</span> * @deprecated since 0.96 - Use {@link HTableInterface#batchCallback} instead<a name="line.519"></a> -<span class="sourceLineNo">520</span> */<a name="line.520"></a> -<span class="sourceLineNo">521</span> @Deprecated<a name="line.521"></a> -<span class="sourceLineNo">522</span> public <R> void processBatchCallback(List<? extends Row> list,<a name="line.522"></a> -<span class="sourceLineNo">523</span> final TableName tableName,<a name="line.523"></a> -<span class="sourceLineNo">524</span> ExecutorService pool,<a name="line.524"></a> -<span class="sourceLineNo">525</span> Object[] results,<a name="line.525"></a> -<span class="sourceLineNo">526</span> Batch.Callback<R> callback) throws IOException, InterruptedException;<a name="line.526"></a> -<span class="sourceLineNo">527</span><a name="line.527"></a> -<span class="sourceLineNo">528</span> /**<a name="line.528"></a> -<span class="sourceLineNo">529</span> * @deprecated Unsupported API<a name="line.529"></a> -<span class="sourceLineNo">530</span> */<a name="line.530"></a> -<span class="sourceLineNo">531</span> @Deprecated<a name="line.531"></a> -<span class="sourceLineNo">532</span> public <R> void processBatchCallback(List<? extends Row> list,<a name="line.532"></a> -<span class="sourceLineNo">533</span> final byte[] tableName,<a name="line.533"></a> -<span class="sourceLineNo">534</span> ExecutorService pool,<a name="line.534"></a> -<span class="sourceLineNo">535</span> Object[] results,<a name="line.535"></a> -<span class="sourceLineNo">536</span> Batch.Callback<R> callback) throws IOException, InterruptedException;<a name="line.536"></a> -<span class="sourceLineNo">537</span><a name="line.537"></a> -<span class="sourceLineNo">538</span> /**<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @deprecated does nothing since since 0.99<a name="line.539"></a> -<span class="sourceLineNo">540</span> **/<a name="line.540"></a> -<span class="sourceLineNo">541</span> @Deprecated<a name="line.541"></a> -<span class="sourceLineNo">542</span> public void setRegionCachePrefetch(final TableName tableName,<a name="line.542"></a> -<span class="sourceLineNo">543</span> final boolean enable);<a name="line.543"></a> -<span class="sourceLineNo">544</span><a name="line.544"></a> -<span class="sourceLineNo">545</span> /**<a name="line.545"></a> -<span class="sourceLineNo">546</span> * @deprecated does nothing since 0.99<a name="line.546"></a> -<span class="sourceLineNo">547</span> **/<a name="line.547"></a> -<span class="sourceLineNo">548</span> @Deprecated<a name="line.548"></a> -<span class="sourceLineNo">549</span> public void setRegionCachePrefetch(final byte[] tableName,<a name="line.549"></a> -<span class="sourceLineNo">550</span> final boolean enable);<a name="line.550"></a> -<span class="sourceLineNo">551</span><a name="line.551"></a> -<span class="sourceLineNo">552</span> /**<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @deprecated always return false since 0.99<a name="line.553"></a> -<span class="sourceLineNo">554</span> **/<a name="line.554"></a> -<span class="sourceLineNo">555</span> @Deprecated<a name="line.555"></a> -<span class="sourceLineNo">556</span> boolean getRegionCachePrefetch(final TableName tableName);<a name="line.556"></a> -<span class="sourceLineNo">557</span><a name="line.557"></a> -<span class="sourceLineNo">558</span> /**<a name="line.558"></a> -<span class="sourceLineNo">559</span> * @deprecated always return false since 0.99<a name="line.559"></a> -<span class="sourceLineNo">560</span> **/<a name="line.560"></a> -<span class="sourceLineNo">561</span> @Deprecated<a name="line.561"></a> -<span class="sourceLineNo">562</span> boolean getRegionCachePrefetch(final byte[] tableName);<a name="line.562"></a> -<span class="sourceLineNo">563</span><a name="line.563"></a> -<span class="sourceLineNo">564</span> /**<a name="line.564"></a> -<span class="sourceLineNo">565</span> * @return the number of region servers that are currently running<a name="line.565"></a> -<span class="sourceLineNo">566</span> * @throws IOException if a remote or network exception occurs<a name="line.566"></a> -<span class="sourceLineNo">567</span> * @deprecated This method will be changed from public to package protected.<a name="line.567"></a> -<span class="sourceLineNo">568</span> */<a name="line.568"></a> -<span class="sourceLineNo">569</span> @Deprecated<a name="line.569"></a> -<span class="sourceLineNo">570</span> int getCurrentNrHRS() throws IOException;<a name="line.570"></a> -<span class="sourceLineNo">571</span><a name="line.571"></a> -<span class="sourceLineNo">572</span> /**<a name="line.572"></a> -<span class="sourceLineNo">573</span> * @param tableNames List of table names<a name="line.573"></a> -<span class="sourceLineNo">574</span> * @return HTD[] table metadata<a name="line.574"></a> -<span class="sourceLineNo">575</span> * @throws IOException if a remote or network exception occurs<a name="line.575"></a> -<span class="sourceLineNo">576</span> * @deprecated Use {@link Admin#getTableDescriptor(TableName)} instead.<a name="line.576"></a> -<span class="sourceLineNo">577</span> */<a name="line.577"></a> -<span class="sourceLineNo">578</span> @Deprecated<a name="line.578"></a> -<span class="sourceLineNo">579</span> HTableDescriptor[] getHTableDescriptorsByTableName(List<TableName> tableNames) throws IOException;<a name="line.579"></a> -<span class="sourceLineNo">580</span><a name="line.580"></a> -<span class="sourceLineNo">581</span> /**<a name="line.581"></a> -<span class="sourceLineNo">582</span> * @deprecated since 0.96.0<a name="line.582"></a> -<span class="sourceLineNo">583</span> */<a name="line.583"></a> -<span class="sourceLineNo">584</span> @Deprecated<a name="line.584"></a> -<span class="sourceLineNo">585</span> HTableDescriptor[] getHTableDescriptors(List<String> tableNames) throws<a name="line.585"></a> -<span class="sourceLineNo">586</span> IOException;<a name="line.586"></a> -<span class="sourceLineNo">587</span><a name="line.587"></a> -<span class="sourceLineNo">588</span> /**<a name="line.588"></a> -<span class="sourceLineNo">589</span> * @return true if this connection is closed<a name="line.589"></a> -<span class="sourceLineNo">590</span> */<a name="line.590"></a> -<span class="sourceLineNo">591</span> @Override<a name="line.591"></a> -<span class="sourceLineNo">592</span> boolean isClosed();<a name="line.592"></a> -<span class="sourceLineNo">593</span><a name="line.593"></a> -<span class="sourceLineNo">594</span><a name="line.594"></a> -<span class="sourceLineNo">595</span> /**<a name="line.595"></a> -<span class="sourceLineNo">596</span> * Clear any caches that pertain to server name <code>sn</code>.<a name="line.596"></a> -<span class="sourceLineNo">597</span> * @param sn A server name<a name="line.597"></a> -<span class="sourceLineNo">598</span> * @deprecated internal method, do not use thru HConnection */<a name="line.598"></a> -<span class="sourceLineNo">599</span> @Deprecated<a name="line.599"></a> -<span class="sourceLineNo">600</span> void clearCaches(final ServerName sn);<a name="line.600"></a> -<span class="sourceLineNo">601</span><a name="line.601"></a> -<span class="sourceLineNo">602</span> /**<a name="line.602"></a> -<span class="sourceLineNo">603</span> * This function allows HBaseAdmin and potentially others to get a shared MasterService<a name="line.603"></a> -<span class="sourceLineNo">604</span> * connection.<a name="line.604"></a> -<span class="sourceLineNo">605</span> * @return The shared instance. Never returns null.<a name="line.605"></a> -<span class="sourceLineNo">606</span> * @throws MasterNotRunningException<a name="line.606"></a> -<span class="sourceLineNo">607</span> * @deprecated Since 0.96.0<a name="line.607"></a> -<span class="sourceLineNo">608</span> */<a name="line.608"></a> -<span class="sourceLineNo">609</span> // TODO: Why is this in the public interface when the returned type is shutdown package access?<a name="line.609"></a> -<span class="sourceLineNo">610</span> @Deprecated<a name="line.610"></a> -<span class="sourceLineNo">611</span> MasterKeepAliveConnection getKeepAliveMasterService()<a name="line.611"></a> -<span class="sourceLineNo">612</span> throws MasterNotRunningException;<a name="line.612"></a> -<span class="sourceLineNo">613</span><a name="line.613"></a> -<span class="sourceLineNo">614</span> /**<a name="line.614"></a> -<span class="sourceLineNo">615</span> * @param serverName<a name="line.615"></a> -<span class="sourceLineNo">616</span> * @return true if the server is known as dead, false otherwise.<a name="line.616"></a> -<span class="sourceLineNo">617</span> * @deprecated internal method, do not use thru HConnection */<a name="line.617"></a> -<span class="sourceLineNo">618</span> @Deprecated<a name="line.618"></a> -<span class="sourceLineNo">619</span> boolean isDeadServer(ServerName serverName);<a name="line.619"></a> -<span class="sourceLineNo">620</span><a name="line.620"></a> -<span class="sourceLineNo">621</span> /**<a name="line.621"></a> -<span class="sourceLineNo">622</span> * @return Nonce generator for this HConnection; may be null if disabled in configuration.<a name="line.622"></a> -<span class="sourceLineNo">623</span> * @deprecated internal method, do not use thru HConnection */<a name="line.623"></a> -<span class="sourceLineNo">624</span> @Deprecated<a name="line.624"></a> -<span class="sourceLineNo">625</span> public NonceGenerator getNonceGenerator();<a name="line.625"></a> -<span class="sourceLineNo">626</span>}<a name="line.626"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/db523e4d/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html index 29852a1..a19bfc4 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html @@ -585,12 +585,12 @@ <span class="sourceLineNo">577</span> * early and throw SocketTimeoutException.<a name="line.577"></a> <span class="sourceLineNo">578</span> * @param operationTimeout the total timeout of each operation in millisecond.<a name="line.578"></a> <span class="sourceLineNo">579</span> */<a name="line.579"></a> -<span class="sourceLineNo">580</span> public void setOperationTimeout(int operationTimeout);<a name="line.580"></a> +<span class="sourceLineNo">580</span> void setOperationTimeout(int operationTimeout);<a name="line.580"></a> <span class="sourceLineNo">581</span><a name="line.581"></a> <span class="sourceLineNo">582</span> /**<a name="line.582"></a> <span class="sourceLineNo">583</span> * Get timeout (millisecond) of each operation for in Table instance.<a name="line.583"></a> <span class="sourceLineNo">584</span> */<a name="line.584"></a> -<span class="sourceLineNo">585</span> public int getOperationTimeout();<a name="line.585"></a> +<span class="sourceLineNo">585</span> int getOperationTimeout();<a name="line.585"></a> <span class="sourceLineNo">586</span><a name="line.586"></a> <span class="sourceLineNo">587</span> /**<a name="line.587"></a> <span class="sourceLineNo">588</span> * Set timeout (millisecond) of each rpc request in operations of this Table instance, will<a name="line.588"></a> @@ -599,12 +599,12 @@ <span class="sourceLineNo">591</span> * retries exhausted or operation timeout reached.<a name="line.591"></a> <span class="sourceLineNo">592</span> * @param rpcTimeout the timeout of each rpc request in millisecond.<a name="line.592"></a> <span class="sourceLineNo">593</span> */<a name="line.593"></a> -<span class="sourceLineNo">594</span> public void setRpcTimeout(int rpcTimeout);<a name="line.594"></a> +<span class="sourceLineNo">594</span> void setRpcTimeout(int rpcTimeout);<a name="line.594"></a> <span class="sourceLineNo">595</span><a name="line.595"></a> <span class="sourceLineNo">596</span> /**<a name="line.596"></a> <span class="sourceLineNo">597</span> * Get timeout (millisecond) of each rpc request in this Table instance.<a name="line.597"></a> <span class="sourceLineNo">598</span> */<a name="line.598"></a> -<span class="sourceLineNo">599</span> public int getRpcTimeout();<a name="line.599"></a> +<span class="sourceLineNo">599</span> int getRpcTimeout();<a name="line.599"></a> <span class="sourceLineNo">600</span><a name="line.600"></a> <span class="sourceLineNo">601</span>}<a name="line.601"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/db523e4d/apidocs/src-html/org/apache/hadoop/hbase/filter/SubstringComparator.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/SubstringComparator.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/SubstringComparator.html index 8e35327..e211154 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/SubstringComparator.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/SubstringComparator.html @@ -26,98 +26,99 @@ <span class="sourceLineNo">018</span> */<a name="line.18"></a> <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.filter;<a name="line.19"></a> <span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.protobuf.generated.ComparatorProtos;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>import com.google.protobuf.InvalidProtocolBufferException;<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">021</span>import java.util.Locale;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.protobuf.generated.ComparatorProtos;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.26"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span>import com.google.protobuf.InvalidProtocolBufferException;<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> * This comparator is for use with SingleColumnValueFilter, for filtering based on<a name="line.31"></a> -<span class="sourceLineNo">032</span> * the value of a given column. Use it to test if a given substring appears<a name="line.32"></a> -<span class="sourceLineNo">033</span> * in a cell value in the column. The comparison is case insensitive.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * Only EQUAL or NOT_EQUAL tests are valid with this comparator.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> -<span class="sourceLineNo">037</span> * For example:<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> -<span class="sourceLineNo">039</span> * <pre><a name="line.39"></a> -<span class="sourceLineNo">040</span> * SingleColumnValueFilter scvf =<a name="line.40"></a> -<span class="sourceLineNo">041</span> * new SingleColumnValueFilter("col", CompareOp.EQUAL,<a name="line.41"></a> -<span class="sourceLineNo">042</span> * new SubstringComparator("substr"));<a name="line.42"></a> -<span class="sourceLineNo">043</span> * </pre><a name="line.43"></a> -<span class="sourceLineNo">044</span> */<a name="line.44"></a> -<span class="sourceLineNo">045</span>@InterfaceAudience.Public<a name="line.45"></a> -<span class="sourceLineNo">046</span>@InterfaceStability.Stable<a name="line.46"></a> -<span class="sourceLineNo">047</span>public class SubstringComparator extends ByteArrayComparable {<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> private String substr;<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> * Constructor<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @param substr the substring<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> public SubstringComparator(String substr) {<a name="line.55"></a> -<span class="sourceLineNo">056</span> super(Bytes.toBytes(substr.toLowerCase()));<a name="line.56"></a> -<span class="sourceLineNo">057</span> this.substr = substr.toLowerCase();<a name="line.57"></a> -<span class="sourceLineNo">058</span> }<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> @Override<a name="line.60"></a> -<span class="sourceLineNo">061</span> public byte[] getValue() {<a name="line.61"></a> -<span class="sourceLineNo">062</span> return Bytes.toBytes(substr);<a name="line.62"></a> -<span class="sourceLineNo">063</span> }<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> @Override<a name="line.65"></a> -<span class="sourceLineNo">066</span> public int compareTo(byte[] value, int offset, int length) {<a name="line.66"></a> -<span class="sourceLineNo">067</span> return Bytes.toString(value, offset, length).toLowerCase().contains(substr) ? 0<a name="line.67"></a> -<span class="sourceLineNo">068</span> : 1;<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @return The comparator serialized using pb<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> public byte [] toByteArray() {<a name="line.74"></a> -<span class="sourceLineNo">075</span> ComparatorProtos.SubstringComparator.Builder builder =<a name="line.75"></a> -<span class="sourceLineNo">076</span> ComparatorProtos.SubstringComparator.newBuilder();<a name="line.76"></a> -<span class="sourceLineNo">077</span> builder.setSubstr(this.substr);<a name="line.77"></a> -<span class="sourceLineNo">078</span> return builder.build().toByteArray();<a name="line.78"></a> -<span class="sourceLineNo">079</span> }<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> * @param pbBytes A pb serialized {@link SubstringComparator} instance<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @return An instance of {@link SubstringComparator} made from <code>bytes</code><a name="line.83"></a> -<span class="sourceLineNo">084</span> * @throws DeserializationException<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @see #toByteArray<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> public static SubstringComparator parseFrom(final byte [] pbBytes)<a name="line.87"></a> -<span class="sourceLineNo">088</span> throws DeserializationException {<a name="line.88"></a> -<span class="sourceLineNo">089</span> ComparatorProtos.SubstringComparator proto;<a name="line.89"></a> -<span class="sourceLineNo">090</span> try {<a name="line.90"></a> -<span class="sourceLineNo">091</span> proto = ComparatorProtos.SubstringComparator.parseFrom(pbBytes);<a name="line.91"></a> -<span class="sourceLineNo">092</span> } catch (InvalidProtocolBufferException e) {<a name="line.92"></a> -<span class="sourceLineNo">093</span> throw new DeserializationException(e);<a name="line.93"></a> -<span class="sourceLineNo">094</span> }<a name="line.94"></a> -<span class="sourceLineNo">095</span> return new SubstringComparator(proto.getSubstr());<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> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @param other<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return true if and only if the fields of the comparator that are serialized<a name="line.100"></a> -<span class="sourceLineNo">101</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> boolean areSerializedFieldsEqual(ByteArrayComparable other) {<a name="line.103"></a> -<span class="sourceLineNo">104</span> if (other == this) return true;<a name="line.104"></a> -<span class="sourceLineNo">105</span> if (!(other instanceof SubstringComparator)) return false;<a name="line.105"></a> -<span class="sourceLineNo">106</span><a name="line.106"></a> -<span class="sourceLineNo">107</span> SubstringComparator comparator = (SubstringComparator)other;<a name="line.107"></a> -<span class="sourceLineNo">108</span> return super.areSerializedFieldsEqual(comparator)<a name="line.108"></a> -<span class="sourceLineNo">109</span> && this.substr.equals(comparator.substr);<a name="line.109"></a> -<span class="sourceLineNo">110</span> }<a name="line.110"></a> -<span class="sourceLineNo">111</span><a name="line.111"></a> -<span class="sourceLineNo">112</span>}<a name="line.112"></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> * This comparator is for use with SingleColumnValueFilter, for filtering based on<a name="line.32"></a> +<span class="sourceLineNo">033</span> * the value of a given column. Use it to test if a given substring appears<a name="line.33"></a> +<span class="sourceLineNo">034</span> * in a cell value in the column. The comparison is case insensitive.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Only EQUAL or NOT_EQUAL tests are valid with this comparator.<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * For example:<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <pre><a name="line.40"></a> +<span class="sourceLineNo">041</span> * SingleColumnValueFilter scvf =<a name="line.41"></a> +<span class="sourceLineNo">042</span> * new SingleColumnValueFilter("col", CompareOp.EQUAL,<a name="line.42"></a> +<span class="sourceLineNo">043</span> * new SubstringComparator("substr"));<a name="line.43"></a> +<span class="sourceLineNo">044</span> * </pre><a name="line.44"></a> +<span class="sourceLineNo">045</span> */<a name="line.45"></a> +<span class="sourceLineNo">046</span>@InterfaceAudience.Public<a name="line.46"></a> +<span class="sourceLineNo">047</span>@InterfaceStability.Stable<a name="line.47"></a> +<span class="sourceLineNo">048</span>public class SubstringComparator extends ByteArrayComparable {<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> private String substr;<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> * Constructor<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @param substr the substring<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public SubstringComparator(String substr) {<a name="line.56"></a> +<span class="sourceLineNo">057</span> super(Bytes.toBytes(substr.toLowerCase(Locale.ROOT)));<a name="line.57"></a> +<span class="sourceLineNo">058</span> this.substr = substr.toLowerCase(Locale.ROOT);<a name="line.58"></a> +<span class="sourceLineNo">059</span> }<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> @Override<a name="line.61"></a> +<span class="sourceLineNo">062</span> public byte[] getValue() {<a name="line.62"></a> +<span class="sourceLineNo">063</span> return Bytes.toBytes(substr);<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> @Override<a name="line.66"></a> +<span class="sourceLineNo">067</span> public int compareTo(byte[] value, int offset, int length) {<a name="line.67"></a> +<span class="sourceLineNo">068</span> return Bytes.toString(value, offset, length).toLowerCase(Locale.ROOT).contains(substr) ? 0<a name="line.68"></a> +<span class="sourceLineNo">069</span> : 1;<a name="line.69"></a> +<span class="sourceLineNo">070</span> }<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> /**<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @return The comparator serialized using pb<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> public byte [] toByteArray() {<a name="line.75"></a> +<span class="sourceLineNo">076</span> ComparatorProtos.SubstringComparator.Builder builder =<a name="line.76"></a> +<span class="sourceLineNo">077</span> ComparatorProtos.SubstringComparator.newBuilder();<a name="line.77"></a> +<span class="sourceLineNo">078</span> builder.setSubstr(this.substr);<a name="line.78"></a> +<span class="sourceLineNo">079</span> return builder.build().toByteArray();<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> /**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param pbBytes A pb serialized {@link SubstringComparator} instance<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @return An instance of {@link SubstringComparator} made from <code>bytes</code><a name="line.84"></a> +<span class="sourceLineNo">085</span> * @throws DeserializationException<a name="line.85"></a> +<span class="sourceLineNo">086</span> * @see #toByteArray<a name="line.86"></a> +<span class="sourceLineNo">087</span> */<a name="line.87"></a> +<span class="sourceLineNo">088</span> public static SubstringComparator parseFrom(final byte [] pbBytes)<a name="line.88"></a> +<span class="sourceLineNo">089</span> throws DeserializationException {<a name="line.89"></a> +<span class="sourceLineNo">090</span> ComparatorProtos.SubstringComparator proto;<a name="line.90"></a> +<span class="sourceLineNo">091</span> try {<a name="line.91"></a> +<span class="sourceLineNo">092</span> proto = ComparatorProtos.SubstringComparator.parseFrom(pbBytes);<a name="line.92"></a> +<span class="sourceLineNo">093</span> } catch (InvalidProtocolBufferException e) {<a name="line.93"></a> +<span class="sourceLineNo">094</span> throw new DeserializationException(e);<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></a> +<span class="sourceLineNo">096</span> return new SubstringComparator(proto.getSubstr());<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> /**<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @param other<a name="line.100"></a> +<span class="sourceLineNo">101</span> * @return true if and only if the fields of the comparator that are serialized<a name="line.101"></a> +<span class="sourceLineNo">102</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.102"></a> +<span class="sourceLineNo">103</span> */<a name="line.103"></a> +<span class="sourceLineNo">104</span> boolean areSerializedFieldsEqual(ByteArrayComparable other) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (other == this) return true;<a name="line.105"></a> +<span class="sourceLineNo">106</span> if (!(other instanceof SubstringComparator)) return false;<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> SubstringComparator comparator = (SubstringComparator)other;<a name="line.108"></a> +<span class="sourceLineNo">109</span> return super.areSerializedFieldsEqual(comparator)<a name="line.109"></a> +<span class="sourceLineNo">110</span> && this.substr.equals(comparator.substr);<a name="line.110"></a> +<span class="sourceLineNo">111</span> }<a name="line.111"></a> +<span class="sourceLineNo">112</span><a name="line.112"></a> +<span class="sourceLineNo">113</span>}<a name="line.113"></a>
