You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by mi...@apache.org on 2016/08/25 18:25:36 UTC
[26/51] [abbrv] [partial] hbase-site git commit: Published site at
44c9021d67b0e922e1d2f5f53908742aceab6c80.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/a16749a7/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html
----------------------------------------------------------------------
diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html
index 3098301..0993322 100644
--- a/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html
+++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html
@@ -95,214 +95,216 @@
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Filters a row based on the row key. If this returns true, the entire row will be excluded. If<a name="line.88"></a>
<span class="sourceLineNo">089</span> * false, each KeyValue in the row will be passed to {@link #filterKeyValue(Cell)} below.<a name="line.89"></a>
-<span class="sourceLineNo">090</span> *<a name="line.90"></a>
-<span class="sourceLineNo">091</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.91"></a>
-<span class="sourceLineNo">092</span> * {@link IOException}.<a name="line.92"></a>
-<span class="sourceLineNo">093</span> *<a name="line.93"></a>
-<span class="sourceLineNo">094</span> * @param firstRowCell The first cell coming in the new row<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * @return true, remove entire row, false, include the row (maybe).<a name="line.95"></a>
-<span class="sourceLineNo">096</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.96"></a>
-<span class="sourceLineNo">097</span> */<a name="line.97"></a>
-<span class="sourceLineNo">098</span> abstract public boolean filterRowKey(Cell firstRowCell) throws IOException;<a name="line.98"></a>
-<span class="sourceLineNo">099</span><a name="line.99"></a>
-<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
-<span class="sourceLineNo">101</span> * If this returns true, the scan will terminate.<a name="line.101"></a>
-<span class="sourceLineNo">102</span> * <a name="line.102"></a>
-<span class="sourceLineNo">103</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.103"></a>
-<span class="sourceLineNo">104</span> * {@link IOException}.<a name="line.104"></a>
-<span class="sourceLineNo">105</span> * <a name="line.105"></a>
-<span class="sourceLineNo">106</span> * @return true to end scan, false to continue.<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.107"></a>
-<span class="sourceLineNo">108</span> */<a name="line.108"></a>
-<span class="sourceLineNo">109</span> abstract public boolean filterAllRemaining() throws IOException;<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 way to filter based on the column family, column qualifier and/or the column value. Return<a name="line.112"></a>
-<span class="sourceLineNo">113</span> * code is described below. This allows filters to filter only certain number of columns, then<a name="line.113"></a>
-<span class="sourceLineNo">114</span> * terminate without matching ever column.<a name="line.114"></a>
-<span class="sourceLineNo">115</span> * <a name="line.115"></a>
-<span class="sourceLineNo">116</span> * If filterRowKey returns true, filterKeyValue needs to be consistent with it.<a name="line.116"></a>
+<span class="sourceLineNo">090</span> * If {@link #filterAllRemaining()} returns true, then {@link #filterRowKey(Cell)} should<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * also return true.<a name="line.91"></a>
+<span class="sourceLineNo">092</span> *<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * {@link IOException}.<a name="line.94"></a>
+<span class="sourceLineNo">095</span> *<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * @param firstRowCell The first cell coming in the new row<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * @return true, remove entire row, false, include the row (maybe).<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.98"></a>
+<span class="sourceLineNo">099</span> */<a name="line.99"></a>
+<span class="sourceLineNo">100</span> abstract public boolean filterRowKey(Cell firstRowCell) throws IOException;<a name="line.100"></a>
+<span class="sourceLineNo">101</span><a name="line.101"></a>
+<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * If this returns true, the scan will terminate.<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * <a name="line.104"></a>
+<span class="sourceLineNo">105</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * {@link IOException}.<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * <a name="line.107"></a>
+<span class="sourceLineNo">108</span> * @return true to end scan, false to continue.<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.109"></a>
+<span class="sourceLineNo">110</span> */<a name="line.110"></a>
+<span class="sourceLineNo">111</span> abstract public boolean filterAllRemaining() throws IOException;<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>
+<span class="sourceLineNo">114</span> * A way to filter based on the column family, column qualifier and/or the column value. Return<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * code is described below. This allows filters to filter only certain number of columns, then<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * terminate without matching ever column.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * <a name="line.117"></a>
-<span class="sourceLineNo">118</span> * filterKeyValue can assume that filterRowKey has already been called for the row.<a name="line.118"></a>
+<span class="sourceLineNo">118</span> * If filterRowKey returns true, filterKeyValue needs to be consistent with it.<a name="line.118"></a>
<span class="sourceLineNo">119</span> * <a name="line.119"></a>
-<span class="sourceLineNo">120</span> * If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return<a name="line.120"></a>
-<span class="sourceLineNo">121</span> * <code>ReturnCode.NEXT_ROW</code> until {@link #reset()} is called just in case the caller calls<a name="line.121"></a>
-<span class="sourceLineNo">122</span> * for the next row.<a name="line.122"></a>
-<span class="sourceLineNo">123</span> * <a name="line.123"></a>
-<span class="sourceLineNo">124</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.124"></a>
-<span class="sourceLineNo">125</span> * {@link IOException}.<a name="line.125"></a>
-<span class="sourceLineNo">126</span> * <a name="line.126"></a>
-<span class="sourceLineNo">127</span> * @param v the Cell in question<a name="line.127"></a>
-<span class="sourceLineNo">128</span> * @return code as described below<a name="line.128"></a>
-<span class="sourceLineNo">129</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.129"></a>
-<span class="sourceLineNo">130</span> * @see Filter.ReturnCode<a name="line.130"></a>
-<span class="sourceLineNo">131</span> */<a name="line.131"></a>
-<span class="sourceLineNo">132</span> abstract public ReturnCode filterKeyValue(final Cell v) throws IOException;<a name="line.132"></a>
-<span class="sourceLineNo">133</span><a name="line.133"></a>
-<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
-<span class="sourceLineNo">135</span> * Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * Cell object must be returned.<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * <a name="line.137"></a>
-<span class="sourceLineNo">138</span> * @see org.apache.hadoop.hbase.KeyValue#shallowCopy()<a name="line.138"></a>
-<span class="sourceLineNo">139</span> * The transformed KeyValue is what is eventually returned to the client. Most filters will<a name="line.139"></a>
-<span class="sourceLineNo">140</span> * return the passed KeyValue unchanged.<a name="line.140"></a>
-<span class="sourceLineNo">141</span> * @see org.apache.hadoop.hbase.filter.KeyOnlyFilter#transformCell(Cell) for an example of a<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * transformation.<a name="line.142"></a>
-<span class="sourceLineNo">143</span> * <a name="line.143"></a>
-<span class="sourceLineNo">144</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * {@link IOException}.<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * <a name="line.146"></a>
-<span class="sourceLineNo">147</span> * @param v the KeyValue in question<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * @return the changed KeyValue<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.149"></a>
-<span class="sourceLineNo">150</span> */<a name="line.150"></a>
-<span class="sourceLineNo">151</span> abstract public Cell transformCell(final Cell v) throws IOException;<a name="line.151"></a>
-<span class="sourceLineNo">152</span><a name="line.152"></a>
-<span class="sourceLineNo">153</span> /**<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * Return codes for filterValue().<a name="line.154"></a>
-<span class="sourceLineNo">155</span> */<a name="line.155"></a>
-<span class="sourceLineNo">156</span> @InterfaceAudience.Public<a name="line.156"></a>
-<span class="sourceLineNo">157</span> @InterfaceStability.Stable<a name="line.157"></a>
-<span class="sourceLineNo">158</span> public enum ReturnCode {<a name="line.158"></a>
-<span class="sourceLineNo">159</span> /**<a name="line.159"></a>
-<span class="sourceLineNo">160</span> * Include the Cell<a name="line.160"></a>
-<span class="sourceLineNo">161</span> */<a name="line.161"></a>
-<span class="sourceLineNo">162</span> INCLUDE,<a name="line.162"></a>
-<span class="sourceLineNo">163</span> /**<a name="line.163"></a>
-<span class="sourceLineNo">164</span> * Include the Cell and seek to the next column skipping older versions.<a name="line.164"></a>
-<span class="sourceLineNo">165</span> */<a name="line.165"></a>
-<span class="sourceLineNo">166</span> INCLUDE_AND_NEXT_COL,<a name="line.166"></a>
-<span class="sourceLineNo">167</span> /**<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * Skip this Cell<a name="line.168"></a>
-<span class="sourceLineNo">169</span> */<a name="line.169"></a>
-<span class="sourceLineNo">170</span> SKIP,<a name="line.170"></a>
-<span class="sourceLineNo">171</span> /**<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * Skip this column. Go to the next column in this row.<a name="line.172"></a>
-<span class="sourceLineNo">173</span> */<a name="line.173"></a>
-<span class="sourceLineNo">174</span> NEXT_COL,<a name="line.174"></a>
-<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
-<span class="sourceLineNo">176</span> * Done with columns, skip to next row. Note that filterRow() will<a name="line.176"></a>
-<span class="sourceLineNo">177</span> * still be called.<a name="line.177"></a>
-<span class="sourceLineNo">178</span> */<a name="line.178"></a>
-<span class="sourceLineNo">179</span> NEXT_ROW,<a name="line.179"></a>
-<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
-<span class="sourceLineNo">181</span> * Seek to next key which is given as hint by the filter.<a name="line.181"></a>
-<span class="sourceLineNo">182</span> */<a name="line.182"></a>
-<span class="sourceLineNo">183</span> SEEK_NEXT_USING_HINT,<a name="line.183"></a>
-<span class="sourceLineNo">184</span> /**<a name="line.184"></a>
-<span class="sourceLineNo">185</span> * Include KeyValue and done with row, seek to next.<a name="line.185"></a>
-<span class="sourceLineNo">186</span> */<a name="line.186"></a>
-<span class="sourceLineNo">187</span> INCLUDE_AND_SEEK_NEXT_ROW,<a name="line.187"></a>
-<span class="sourceLineNo">188</span>}<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> * Chance to alter the list of Cells to be submitted. Modifications to the list will carry on<a name="line.191"></a>
-<span class="sourceLineNo">192</span> * <a name="line.192"></a>
-<span class="sourceLineNo">193</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.193"></a>
-<span class="sourceLineNo">194</span> * {@link IOException}.<a name="line.194"></a>
-<span class="sourceLineNo">195</span> * <a name="line.195"></a>
-<span class="sourceLineNo">196</span> * @param kvs the list of Cells to be filtered<a name="line.196"></a>
-<span class="sourceLineNo">197</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.197"></a>
-<span class="sourceLineNo">198</span> */<a name="line.198"></a>
-<span class="sourceLineNo">199</span> abstract public void filterRowCells(List<Cell> kvs) throws IOException;<a name="line.199"></a>
-<span class="sourceLineNo">200</span><a name="line.200"></a>
-<span class="sourceLineNo">201</span> /**<a name="line.201"></a>
-<span class="sourceLineNo">202</span> * Primarily used to check for conflicts with scans(such as scans that do not read a full row at a<a name="line.202"></a>
-<span class="sourceLineNo">203</span> * time).<a name="line.203"></a>
-<span class="sourceLineNo">204</span> * <a name="line.204"></a>
-<span class="sourceLineNo">205</span> * @return True if this filter actively uses filterRowCells(List) or filterRow().<a name="line.205"></a>
-<span class="sourceLineNo">206</span> */<a name="line.206"></a>
-<span class="sourceLineNo">207</span> abstract public boolean hasFilterRow();<a name="line.207"></a>
-<span class="sourceLineNo">208</span><a name="line.208"></a>
-<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
-<span class="sourceLineNo">210</span> * Last chance to veto row based on previous {@link #filterKeyValue(Cell)} calls. The filter<a name="line.210"></a>
-<span class="sourceLineNo">211</span> * needs to retain state then return a particular value for this call if they wish to exclude a<a name="line.211"></a>
-<span class="sourceLineNo">212</span> * row if a certain column is missing (for example).<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * <a name="line.213"></a>
-<span class="sourceLineNo">214</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.214"></a>
-<span class="sourceLineNo">215</span> * {@link IOException}.<a name="line.215"></a>
-<span class="sourceLineNo">216</span> * <a name="line.216"></a>
-<span class="sourceLineNo">217</span> * @return true to exclude row, false to include row.<a name="line.217"></a>
-<span class="sourceLineNo">218</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.218"></a>
-<span class="sourceLineNo">219</span> */<a name="line.219"></a>
-<span class="sourceLineNo">220</span> abstract public boolean filterRow() throws IOException;<a name="line.220"></a>
-<span class="sourceLineNo">221</span><a name="line.221"></a>
-<span class="sourceLineNo">222</span> /**<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is<a name="line.223"></a>
-<span class="sourceLineNo">224</span> * the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the<a name="line.224"></a>
-<span class="sourceLineNo">225</span> * QueryMatcher would call this function to find out which key it must next seek to.<a name="line.225"></a>
-<span class="sourceLineNo">226</span> * <a name="line.226"></a>
-<span class="sourceLineNo">227</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.227"></a>
-<span class="sourceLineNo">228</span> * {@link IOException}.<a name="line.228"></a>
-<span class="sourceLineNo">229</span> * <a name="line.229"></a>
-<span class="sourceLineNo">230</span> * @return KeyValue which must be next seeked. return null if the filter is not sure which key to<a name="line.230"></a>
-<span class="sourceLineNo">231</span> * seek to next.<a name="line.231"></a>
-<span class="sourceLineNo">232</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.232"></a>
-<span class="sourceLineNo">233</span> */<a name="line.233"></a>
-<span class="sourceLineNo">234</span> abstract public Cell getNextCellHint(final Cell currentCell) 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> * Check that given column family is essential for filter to check row. Most filters always return<a name="line.237"></a>
-<span class="sourceLineNo">238</span> * true here. But some could have more sophisticated logic which could significantly reduce<a name="line.238"></a>
-<span class="sourceLineNo">239</span> * scanning process by not even touching columns until we are 100% sure that it's data is needed<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * in result.<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * <a name="line.241"></a>
-<span class="sourceLineNo">242</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.242"></a>
-<span class="sourceLineNo">243</span> * {@link IOException}.<a name="line.243"></a>
-<span class="sourceLineNo">244</span> * <a name="line.244"></a>
-<span class="sourceLineNo">245</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.245"></a>
-<span class="sourceLineNo">246</span> */<a name="line.246"></a>
-<span class="sourceLineNo">247</span> abstract public boolean isFamilyEssential(byte[] name) throws IOException;<a name="line.247"></a>
-<span class="sourceLineNo">248</span><a name="line.248"></a>
-<span class="sourceLineNo">249</span> /**<a name="line.249"></a>
-<span class="sourceLineNo">250</span> * TODO: JAVADOC<a name="line.250"></a>
-<span class="sourceLineNo">251</span> * <a name="line.251"></a>
-<span class="sourceLineNo">252</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.252"></a>
-<span class="sourceLineNo">253</span> * {@link IOException}.<a name="line.253"></a>
-<span class="sourceLineNo">254</span> * <a name="line.254"></a>
-<span class="sourceLineNo">255</span> * @return The filter serialized using pb<a name="line.255"></a>
-<span class="sourceLineNo">256</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.256"></a>
-<span class="sourceLineNo">257</span> */<a name="line.257"></a>
-<span class="sourceLineNo">258</span> abstract public byte[] toByteArray() throws IOException;<a name="line.258"></a>
-<span class="sourceLineNo">259</span><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> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.262"></a>
-<span class="sourceLineNo">263</span> * {@link IOException}.<a name="line.263"></a>
-<span class="sourceLineNo">264</span> * <a name="line.264"></a>
-<span class="sourceLineNo">265</span> * @param pbBytes A pb serialized {@link Filter} instance<a name="line.265"></a>
-<span class="sourceLineNo">266</span> * @return An instance of {@link Filter} made from <code>bytes</code><a name="line.266"></a>
-<span class="sourceLineNo">267</span> * @throws DeserializationException<a name="line.267"></a>
-<span class="sourceLineNo">268</span> * @see #toByteArray<a name="line.268"></a>
-<span class="sourceLineNo">269</span> */<a name="line.269"></a>
-<span class="sourceLineNo">270</span> public static Filter parseFrom(final byte [] pbBytes) throws DeserializationException {<a name="line.270"></a>
-<span class="sourceLineNo">271</span> throw new DeserializationException(<a name="line.271"></a>
-<span class="sourceLineNo">272</span> "parseFrom called on base Filter, but should be called on derived type");<a name="line.272"></a>
-<span class="sourceLineNo">273</span> }<a name="line.273"></a>
-<span class="sourceLineNo">274</span><a name="line.274"></a>
-<span class="sourceLineNo">275</span> /**<a name="line.275"></a>
-<span class="sourceLineNo">276</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.276"></a>
-<span class="sourceLineNo">277</span> * {@link IOException}.<a name="line.277"></a>
-<span class="sourceLineNo">278</span> * <a name="line.278"></a>
-<span class="sourceLineNo">279</span> * @param other<a name="line.279"></a>
-<span class="sourceLineNo">280</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.280"></a>
-<span class="sourceLineNo">281</span> * corresponding fields in other. Used for testing.<a name="line.281"></a>
-<span class="sourceLineNo">282</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.282"></a>
-<span class="sourceLineNo">283</span> */<a name="line.283"></a>
-<span class="sourceLineNo">284</span> abstract boolean areSerializedFieldsEqual(Filter other);<a name="line.284"></a>
-<span class="sourceLineNo">285</span><a name="line.285"></a>
-<span class="sourceLineNo">286</span> /**<a name="line.286"></a>
-<span class="sourceLineNo">287</span> * alter the reversed scan flag<a name="line.287"></a>
-<span class="sourceLineNo">288</span> * @param reversed flag<a name="line.288"></a>
-<span class="sourceLineNo">289</span> */<a name="line.289"></a>
-<span class="sourceLineNo">290</span> public void setReversed(boolean reversed) {<a name="line.290"></a>
-<span class="sourceLineNo">291</span> this.reversed = reversed;<a name="line.291"></a>
-<span class="sourceLineNo">292</span> }<a name="line.292"></a>
-<span class="sourceLineNo">293</span><a name="line.293"></a>
-<span class="sourceLineNo">294</span> public boolean isReversed() {<a name="line.294"></a>
-<span class="sourceLineNo">295</span> return this.reversed;<a name="line.295"></a>
-<span class="sourceLineNo">296</span> }<a name="line.296"></a>
-<span class="sourceLineNo">297</span>}<a name="line.297"></a>
+<span class="sourceLineNo">120</span> * filterKeyValue can assume that filterRowKey has already been called for the row.<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * <a name="line.121"></a>
+<span class="sourceLineNo">122</span> * If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * <code>ReturnCode.NEXT_ROW</code> until {@link #reset()} is called just in case the caller calls<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * for the next row.<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * <a name="line.125"></a>
+<span class="sourceLineNo">126</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * {@link IOException}.<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * <a name="line.128"></a>
+<span class="sourceLineNo">129</span> * @param v the Cell in question<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * @return code as described below<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * @see Filter.ReturnCode<a name="line.132"></a>
+<span class="sourceLineNo">133</span> */<a name="line.133"></a>
+<span class="sourceLineNo">134</span> abstract public ReturnCode filterKeyValue(final Cell v) throws IOException;<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> * Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * Cell object must be returned.<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * <a name="line.139"></a>
+<span class="sourceLineNo">140</span> * @see org.apache.hadoop.hbase.KeyValue#shallowCopy()<a name="line.140"></a>
+<span class="sourceLineNo">141</span> * The transformed KeyValue is what is eventually returned to the client. Most filters will<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * return the passed KeyValue unchanged.<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * @see org.apache.hadoop.hbase.filter.KeyOnlyFilter#transformCell(Cell) for an example of a<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * transformation.<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * <a name="line.145"></a>
+<span class="sourceLineNo">146</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * {@link IOException}.<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * <a name="line.148"></a>
+<span class="sourceLineNo">149</span> * @param v the KeyValue in question<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * @return the changed KeyValue<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.151"></a>
+<span class="sourceLineNo">152</span> */<a name="line.152"></a>
+<span class="sourceLineNo">153</span> abstract public Cell transformCell(final Cell v) throws IOException;<a name="line.153"></a>
+<span class="sourceLineNo">154</span><a name="line.154"></a>
+<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * Return codes for filterValue().<a name="line.156"></a>
+<span class="sourceLineNo">157</span> */<a name="line.157"></a>
+<span class="sourceLineNo">158</span> @InterfaceAudience.Public<a name="line.158"></a>
+<span class="sourceLineNo">159</span> @InterfaceStability.Stable<a name="line.159"></a>
+<span class="sourceLineNo">160</span> public enum ReturnCode {<a name="line.160"></a>
+<span class="sourceLineNo">161</span> /**<a name="line.161"></a>
+<span class="sourceLineNo">162</span> * Include the Cell<a name="line.162"></a>
+<span class="sourceLineNo">163</span> */<a name="line.163"></a>
+<span class="sourceLineNo">164</span> INCLUDE,<a name="line.164"></a>
+<span class="sourceLineNo">165</span> /**<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * Include the Cell and seek to the next column skipping older versions.<a name="line.166"></a>
+<span class="sourceLineNo">167</span> */<a name="line.167"></a>
+<span class="sourceLineNo">168</span> INCLUDE_AND_NEXT_COL,<a name="line.168"></a>
+<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
+<span class="sourceLineNo">170</span> * Skip this Cell<a name="line.170"></a>
+<span class="sourceLineNo">171</span> */<a name="line.171"></a>
+<span class="sourceLineNo">172</span> SKIP,<a name="line.172"></a>
+<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
+<span class="sourceLineNo">174</span> * Skip this column. Go to the next column in this row.<a name="line.174"></a>
+<span class="sourceLineNo">175</span> */<a name="line.175"></a>
+<span class="sourceLineNo">176</span> NEXT_COL,<a name="line.176"></a>
+<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
+<span class="sourceLineNo">178</span> * Done with columns, skip to next row. Note that filterRow() will<a name="line.178"></a>
+<span class="sourceLineNo">179</span> * still be called.<a name="line.179"></a>
+<span class="sourceLineNo">180</span> */<a name="line.180"></a>
+<span class="sourceLineNo">181</span> NEXT_ROW,<a name="line.181"></a>
+<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
+<span class="sourceLineNo">183</span> * Seek to next key which is given as hint by the filter.<a name="line.183"></a>
+<span class="sourceLineNo">184</span> */<a name="line.184"></a>
+<span class="sourceLineNo">185</span> SEEK_NEXT_USING_HINT,<a name="line.185"></a>
+<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * Include KeyValue and done with row, seek to next.<a name="line.187"></a>
+<span class="sourceLineNo">188</span> */<a name="line.188"></a>
+<span class="sourceLineNo">189</span> INCLUDE_AND_SEEK_NEXT_ROW,<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> /**<a name="line.192"></a>
+<span class="sourceLineNo">193</span> * Chance to alter the list of Cells to be submitted. Modifications to the list will carry on<a name="line.193"></a>
+<span class="sourceLineNo">194</span> * <a name="line.194"></a>
+<span class="sourceLineNo">195</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * {@link IOException}.<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * <a name="line.197"></a>
+<span class="sourceLineNo">198</span> * @param kvs the list of Cells to be filtered<a name="line.198"></a>
+<span class="sourceLineNo">199</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.199"></a>
+<span class="sourceLineNo">200</span> */<a name="line.200"></a>
+<span class="sourceLineNo">201</span> abstract public void filterRowCells(List<Cell> kvs) throws IOException;<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> * Primarily used to check for conflicts with scans(such as scans that do not read a full row at a<a name="line.204"></a>
+<span class="sourceLineNo">205</span> * time).<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * <a name="line.206"></a>
+<span class="sourceLineNo">207</span> * @return True if this filter actively uses filterRowCells(List) or filterRow().<a name="line.207"></a>
+<span class="sourceLineNo">208</span> */<a name="line.208"></a>
+<span class="sourceLineNo">209</span> abstract public boolean hasFilterRow();<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> * Last chance to veto row based on previous {@link #filterKeyValue(Cell)} calls. The filter<a name="line.212"></a>
+<span class="sourceLineNo">213</span> * needs to retain state then return a particular value for this call if they wish to exclude a<a name="line.213"></a>
+<span class="sourceLineNo">214</span> * row if a certain column is missing (for example).<a name="line.214"></a>
+<span class="sourceLineNo">215</span> * <a name="line.215"></a>
+<span class="sourceLineNo">216</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.216"></a>
+<span class="sourceLineNo">217</span> * {@link IOException}.<a name="line.217"></a>
+<span class="sourceLineNo">218</span> * <a name="line.218"></a>
+<span class="sourceLineNo">219</span> * @return true to exclude row, false to include row.<a name="line.219"></a>
+<span class="sourceLineNo">220</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.220"></a>
+<span class="sourceLineNo">221</span> */<a name="line.221"></a>
+<span class="sourceLineNo">222</span> abstract public boolean filterRow() 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> * If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is<a name="line.225"></a>
+<span class="sourceLineNo">226</span> * the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the<a name="line.226"></a>
+<span class="sourceLineNo">227</span> * QueryMatcher would call this function to find out which key it must next seek to.<a name="line.227"></a>
+<span class="sourceLineNo">228</span> * <a name="line.228"></a>
+<span class="sourceLineNo">229</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.229"></a>
+<span class="sourceLineNo">230</span> * {@link IOException}.<a name="line.230"></a>
+<span class="sourceLineNo">231</span> * <a name="line.231"></a>
+<span class="sourceLineNo">232</span> * @return KeyValue which must be next seeked. return null if the filter is not sure which key to<a name="line.232"></a>
+<span class="sourceLineNo">233</span> * seek to next.<a name="line.233"></a>
+<span class="sourceLineNo">234</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.234"></a>
+<span class="sourceLineNo">235</span> */<a name="line.235"></a>
+<span class="sourceLineNo">236</span> abstract public Cell getNextCellHint(final Cell currentCell) throws IOException;<a name="line.236"></a>
+<span class="sourceLineNo">237</span><a name="line.237"></a>
+<span class="sourceLineNo">238</span> /**<a name="line.238"></a>
+<span class="sourceLineNo">239</span> * Check that given column family is essential for filter to check row. Most filters always return<a name="line.239"></a>
+<span class="sourceLineNo">240</span> * true here. But some could have more sophisticated logic which could significantly reduce<a name="line.240"></a>
+<span class="sourceLineNo">241</span> * scanning process by not even touching columns until we are 100% sure that it's data is needed<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * in result.<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * <a name="line.243"></a>
+<span class="sourceLineNo">244</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.244"></a>
+<span class="sourceLineNo">245</span> * {@link IOException}.<a name="line.245"></a>
+<span class="sourceLineNo">246</span> * <a name="line.246"></a>
+<span class="sourceLineNo">247</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.247"></a>
+<span class="sourceLineNo">248</span> */<a name="line.248"></a>
+<span class="sourceLineNo">249</span> abstract public boolean isFamilyEssential(byte[] name) throws IOException;<a name="line.249"></a>
+<span class="sourceLineNo">250</span><a name="line.250"></a>
+<span class="sourceLineNo">251</span> /**<a name="line.251"></a>
+<span class="sourceLineNo">252</span> * TODO: JAVADOC<a name="line.252"></a>
+<span class="sourceLineNo">253</span> * <a name="line.253"></a>
+<span class="sourceLineNo">254</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.254"></a>
+<span class="sourceLineNo">255</span> * {@link IOException}.<a name="line.255"></a>
+<span class="sourceLineNo">256</span> * <a name="line.256"></a>
+<span class="sourceLineNo">257</span> * @return The filter serialized using pb<a name="line.257"></a>
+<span class="sourceLineNo">258</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.258"></a>
+<span class="sourceLineNo">259</span> */<a name="line.259"></a>
+<span class="sourceLineNo">260</span> abstract public byte[] toByteArray() 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> * <a name="line.263"></a>
+<span class="sourceLineNo">264</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.264"></a>
+<span class="sourceLineNo">265</span> * {@link IOException}.<a name="line.265"></a>
+<span class="sourceLineNo">266</span> * <a name="line.266"></a>
+<span class="sourceLineNo">267</span> * @param pbBytes A pb serialized {@link Filter} instance<a name="line.267"></a>
+<span class="sourceLineNo">268</span> * @return An instance of {@link Filter} made from <code>bytes</code><a name="line.268"></a>
+<span class="sourceLineNo">269</span> * @throws DeserializationException<a name="line.269"></a>
+<span class="sourceLineNo">270</span> * @see #toByteArray<a name="line.270"></a>
+<span class="sourceLineNo">271</span> */<a name="line.271"></a>
+<span class="sourceLineNo">272</span> public static Filter parseFrom(final byte [] pbBytes) throws DeserializationException {<a name="line.272"></a>
+<span class="sourceLineNo">273</span> throw new DeserializationException(<a name="line.273"></a>
+<span class="sourceLineNo">274</span> "parseFrom called on base Filter, but should be called on derived type");<a name="line.274"></a>
+<span class="sourceLineNo">275</span> }<a name="line.275"></a>
+<span class="sourceLineNo">276</span><a name="line.276"></a>
+<span class="sourceLineNo">277</span> /**<a name="line.277"></a>
+<span class="sourceLineNo">278</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.278"></a>
+<span class="sourceLineNo">279</span> * {@link IOException}.<a name="line.279"></a>
+<span class="sourceLineNo">280</span> * <a name="line.280"></a>
+<span class="sourceLineNo">281</span> * @param other<a name="line.281"></a>
+<span class="sourceLineNo">282</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.282"></a>
+<span class="sourceLineNo">283</span> * corresponding fields in other. Used for testing.<a name="line.283"></a>
+<span class="sourceLineNo">284</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.284"></a>
+<span class="sourceLineNo">285</span> */<a name="line.285"></a>
+<span class="sourceLineNo">286</span> abstract boolean areSerializedFieldsEqual(Filter other);<a name="line.286"></a>
+<span class="sourceLineNo">287</span><a name="line.287"></a>
+<span class="sourceLineNo">288</span> /**<a name="line.288"></a>
+<span class="sourceLineNo">289</span> * alter the reversed scan flag<a name="line.289"></a>
+<span class="sourceLineNo">290</span> * @param reversed flag<a name="line.290"></a>
+<span class="sourceLineNo">291</span> */<a name="line.291"></a>
+<span class="sourceLineNo">292</span> public void setReversed(boolean reversed) {<a name="line.292"></a>
+<span class="sourceLineNo">293</span> this.reversed = reversed;<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> public boolean isReversed() {<a name="line.296"></a>
+<span class="sourceLineNo">297</span> return this.reversed;<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>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/a16749a7/apidocs/src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html
----------------------------------------------------------------------
diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html
index 0da4ea6..5b89dcd 100644
--- a/apidocs/src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html
+++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html
@@ -69,67 +69,68 @@
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> public boolean filterRowKey(Cell firstRowCell) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> // if stopRowKey is <= buffer, then true, filter row.<a name="line.63"></a>
-<span class="sourceLineNo">064</span> int cmp = CellComparator.COMPARATOR.compareRows(firstRowCell, stopRowKey, 0, stopRowKey.length);<a name="line.64"></a>
-<span class="sourceLineNo">065</span> done = reversed ? cmp < 0 : cmp > 0;<a name="line.65"></a>
-<span class="sourceLineNo">066</span> return done;<a name="line.66"></a>
-<span class="sourceLineNo">067</span> }<a name="line.67"></a>
-<span class="sourceLineNo">068</span><a name="line.68"></a>
-<span class="sourceLineNo">069</span> public boolean filterAllRemaining() {<a name="line.69"></a>
-<span class="sourceLineNo">070</span> return done;<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> public static Filter createFilterFromArguments (ArrayList<byte []> filterArguments) {<a name="line.73"></a>
-<span class="sourceLineNo">074</span> Preconditions.checkArgument(filterArguments.size() == 1,<a name="line.74"></a>
-<span class="sourceLineNo">075</span> "Expected 1 but got: %s", filterArguments.size());<a name="line.75"></a>
-<span class="sourceLineNo">076</span> byte [] stopRowKey = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a name="line.76"></a>
-<span class="sourceLineNo">077</span> return new InclusiveStopFilter(stopRowKey);<a name="line.77"></a>
-<span class="sourceLineNo">078</span> }<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> * @return The filter serialized using pb<a name="line.81"></a>
-<span class="sourceLineNo">082</span> */<a name="line.82"></a>
-<span class="sourceLineNo">083</span> public byte [] toByteArray() {<a name="line.83"></a>
-<span class="sourceLineNo">084</span> FilterProtos.InclusiveStopFilter.Builder builder =<a name="line.84"></a>
-<span class="sourceLineNo">085</span> FilterProtos.InclusiveStopFilter.newBuilder();<a name="line.85"></a>
-<span class="sourceLineNo">086</span> if (this.stopRowKey != null) builder.setStopRowKey(ByteStringer.wrap(this.stopRowKey));<a name="line.86"></a>
-<span class="sourceLineNo">087</span> return builder.build().toByteArray();<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> /**<a name="line.90"></a>
-<span class="sourceLineNo">091</span> * @param pbBytes A pb serialized {@link InclusiveStopFilter} instance<a name="line.91"></a>
-<span class="sourceLineNo">092</span> * @return An instance of {@link InclusiveStopFilter} made from <code>bytes</code><a name="line.92"></a>
-<span class="sourceLineNo">093</span> * @throws DeserializationException<a name="line.93"></a>
-<span class="sourceLineNo">094</span> * @see #toByteArray<a name="line.94"></a>
-<span class="sourceLineNo">095</span> */<a name="line.95"></a>
-<span class="sourceLineNo">096</span> public static InclusiveStopFilter parseFrom(final byte [] pbBytes)<a name="line.96"></a>
-<span class="sourceLineNo">097</span> throws DeserializationException {<a name="line.97"></a>
-<span class="sourceLineNo">098</span> FilterProtos.InclusiveStopFilter proto;<a name="line.98"></a>
-<span class="sourceLineNo">099</span> try {<a name="line.99"></a>
-<span class="sourceLineNo">100</span> proto = FilterProtos.InclusiveStopFilter.parseFrom(pbBytes);<a name="line.100"></a>
-<span class="sourceLineNo">101</span> } catch (InvalidProtocolBufferException e) {<a name="line.101"></a>
-<span class="sourceLineNo">102</span> throw new DeserializationException(e);<a name="line.102"></a>
-<span class="sourceLineNo">103</span> }<a name="line.103"></a>
-<span class="sourceLineNo">104</span> return new InclusiveStopFilter(proto.hasStopRowKey()?proto.getStopRowKey().toByteArray():null);<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> /**<a name="line.107"></a>
-<span class="sourceLineNo">108</span> * @param other<a name="line.108"></a>
-<span class="sourceLineNo">109</span> * @return true if and only if the fields of the filter that are serialized<a name="line.109"></a>
-<span class="sourceLineNo">110</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.110"></a>
-<span class="sourceLineNo">111</span> */<a name="line.111"></a>
-<span class="sourceLineNo">112</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.112"></a>
-<span class="sourceLineNo">113</span> if (o == this) return true;<a name="line.113"></a>
-<span class="sourceLineNo">114</span> if (!(o instanceof InclusiveStopFilter)) return false;<a name="line.114"></a>
-<span class="sourceLineNo">115</span><a name="line.115"></a>
-<span class="sourceLineNo">116</span> InclusiveStopFilter other = (InclusiveStopFilter)o;<a name="line.116"></a>
-<span class="sourceLineNo">117</span> return Bytes.equals(this.getStopRowKey(), other.getStopRowKey());<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> @Override<a name="line.120"></a>
-<span class="sourceLineNo">121</span> public String toString() {<a name="line.121"></a>
-<span class="sourceLineNo">122</span> return this.getClass().getSimpleName() + " " + Bytes.toStringBinary(this.stopRowKey);<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">064</span> if (filterAllRemaining()) return true;<a name="line.64"></a>
+<span class="sourceLineNo">065</span> int cmp = CellComparator.COMPARATOR.compareRows(firstRowCell, stopRowKey, 0, stopRowKey.length);<a name="line.65"></a>
+<span class="sourceLineNo">066</span> done = reversed ? cmp < 0 : cmp > 0;<a name="line.66"></a>
+<span class="sourceLineNo">067</span> return done;<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> public boolean filterAllRemaining() {<a name="line.70"></a>
+<span class="sourceLineNo">071</span> return done;<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> public static Filter createFilterFromArguments (ArrayList<byte []> filterArguments) {<a name="line.74"></a>
+<span class="sourceLineNo">075</span> Preconditions.checkArgument(filterArguments.size() == 1,<a name="line.75"></a>
+<span class="sourceLineNo">076</span> "Expected 1 but got: %s", filterArguments.size());<a name="line.76"></a>
+<span class="sourceLineNo">077</span> byte [] stopRowKey = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a name="line.77"></a>
+<span class="sourceLineNo">078</span> return new InclusiveStopFilter(stopRowKey);<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> * @return The filter serialized using pb<a name="line.82"></a>
+<span class="sourceLineNo">083</span> */<a name="line.83"></a>
+<span class="sourceLineNo">084</span> public byte [] toByteArray() {<a name="line.84"></a>
+<span class="sourceLineNo">085</span> FilterProtos.InclusiveStopFilter.Builder builder =<a name="line.85"></a>
+<span class="sourceLineNo">086</span> FilterProtos.InclusiveStopFilter.newBuilder();<a name="line.86"></a>
+<span class="sourceLineNo">087</span> if (this.stopRowKey != null) builder.setStopRowKey(ByteStringer.wrap(this.stopRowKey));<a name="line.87"></a>
+<span class="sourceLineNo">088</span> return builder.build().toByteArray();<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> /**<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * @param pbBytes A pb serialized {@link InclusiveStopFilter} instance<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * @return An instance of {@link InclusiveStopFilter} made from <code>bytes</code><a name="line.93"></a>
+<span class="sourceLineNo">094</span> * @throws DeserializationException<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * @see #toByteArray<a name="line.95"></a>
+<span class="sourceLineNo">096</span> */<a name="line.96"></a>
+<span class="sourceLineNo">097</span> public static InclusiveStopFilter parseFrom(final byte [] pbBytes)<a name="line.97"></a>
+<span class="sourceLineNo">098</span> throws DeserializationException {<a name="line.98"></a>
+<span class="sourceLineNo">099</span> FilterProtos.InclusiveStopFilter proto;<a name="line.99"></a>
+<span class="sourceLineNo">100</span> try {<a name="line.100"></a>
+<span class="sourceLineNo">101</span> proto = FilterProtos.InclusiveStopFilter.parseFrom(pbBytes);<a name="line.101"></a>
+<span class="sourceLineNo">102</span> } catch (InvalidProtocolBufferException e) {<a name="line.102"></a>
+<span class="sourceLineNo">103</span> throw new DeserializationException(e);<a name="line.103"></a>
+<span class="sourceLineNo">104</span> }<a name="line.104"></a>
+<span class="sourceLineNo">105</span> return new InclusiveStopFilter(proto.hasStopRowKey()?proto.getStopRowKey().toByteArray():null);<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> /**<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * @param other<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * @return true if and only if the fields of the filter that are serialized<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.111"></a>
+<span class="sourceLineNo">112</span> */<a name="line.112"></a>
+<span class="sourceLineNo">113</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.113"></a>
+<span class="sourceLineNo">114</span> if (o == this) return true;<a name="line.114"></a>
+<span class="sourceLineNo">115</span> if (!(o instanceof InclusiveStopFilter)) return false;<a name="line.115"></a>
+<span class="sourceLineNo">116</span><a name="line.116"></a>
+<span class="sourceLineNo">117</span> InclusiveStopFilter other = (InclusiveStopFilter)o;<a name="line.117"></a>
+<span class="sourceLineNo">118</span> return Bytes.equals(this.getStopRowKey(), other.getStopRowKey());<a name="line.118"></a>
+<span class="sourceLineNo">119</span> }<a name="line.119"></a>
+<span class="sourceLineNo">120</span><a name="line.120"></a>
+<span class="sourceLineNo">121</span> @Override<a name="line.121"></a>
+<span class="sourceLineNo">122</span> public String toString() {<a name="line.122"></a>
+<span class="sourceLineNo">123</span> return this.getClass().getSimpleName() + " " + Bytes.toStringBinary(this.stopRowKey);<a name="line.123"></a>
+<span class="sourceLineNo">124</span> }<a name="line.124"></a>
+<span class="sourceLineNo">125</span>}<a name="line.125"></a>