http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/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 35d409c..22238bc 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/Filter.html @@ -42,7 +42,7 @@ <span class="sourceLineNo">034</span> * <li> {@link #reset()} : reset the filter state before filtering a new row. </li><a name="line.34"></a> <span class="sourceLineNo">035</span> * <li> {@link #filterAllRemaining()}: true means row scan is over; false means keep going. </li><a name="line.35"></a> <span class="sourceLineNo">036</span> * <li> {@link #filterRowKey(Cell)}: true means drop this row; false means include.</li><a name="line.36"></a> -<span class="sourceLineNo">037</span> * <li> {@link #filterKeyValue(Cell)}: decides whether to include or exclude this Cell.<a name="line.37"></a> +<span class="sourceLineNo">037</span> * <li> {@link #filterCell(Cell)}: decides whether to include or exclude this Cell.<a name="line.37"></a> <span class="sourceLineNo">038</span> * See {@link ReturnCode}. </li><a name="line.38"></a> <span class="sourceLineNo">039</span> * <li> {@link #transformCell(Cell)}: if the Cell is included, let the filter transform the<a name="line.39"></a> <span class="sourceLineNo">040</span> * Cell. </li><a name="line.40"></a> @@ -74,7 +74,7 @@ <span class="sourceLineNo">066</span><a name="line.66"></a> <span class="sourceLineNo">067</span> /**<a name="line.67"></a> <span class="sourceLineNo">068</span> * Filters a row based on the row key. If this returns true, the entire row will be excluded. If<a name="line.68"></a> -<span class="sourceLineNo">069</span> * false, each KeyValue in the row will be passed to {@link #filterKeyValue(Cell)} below.<a name="line.69"></a> +<span class="sourceLineNo">069</span> * false, each KeyValue in the row will be passed to {@link #filterCell(Cell)} below.<a name="line.69"></a> <span class="sourceLineNo">070</span> * <a name="line.70"></a> <span class="sourceLineNo">071</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.71"></a> <span class="sourceLineNo">072</span> * {@link IOException}.<a name="line.72"></a> @@ -92,7 +92,7 @@ <span class="sourceLineNo">084</span><a name="line.84"></a> <span class="sourceLineNo">085</span> /**<a name="line.85"></a> <span class="sourceLineNo">086</span> * Filters a row based on the row key. If this returns true, the entire row will be excluded. If<a name="line.86"></a> -<span class="sourceLineNo">087</span> * false, each KeyValue in the row will be passed to {@link #filterKeyValue(Cell)} below.<a name="line.87"></a> +<span class="sourceLineNo">087</span> * false, each KeyValue in the row will be passed to {@link #filterCell(Cell)} below.<a name="line.87"></a> <span class="sourceLineNo">088</span> * If {@link #filterAllRemaining()} returns true, then {@link #filterRowKey(Cell)} should<a name="line.88"></a> <span class="sourceLineNo">089</span> * also return true.<a name="line.89"></a> <span class="sourceLineNo">090</span> *<a name="line.90"></a> @@ -128,184 +128,214 @@ <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">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">127</span> * @param c the Cell in question<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @return code as described below, Filter.ReturnCode.INCLUDE by default<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> public enum ReturnCode {<a name="line.157"></a> -<span class="sourceLineNo">158</span> /**<a name="line.158"></a> -<span class="sourceLineNo">159</span> * Include the Cell<a name="line.159"></a> -<span class="sourceLineNo">160</span> */<a name="line.160"></a> -<span class="sourceLineNo">161</span> INCLUDE,<a name="line.161"></a> -<span class="sourceLineNo">162</span> /**<a name="line.162"></a> -<span class="sourceLineNo">163</span> * Include the Cell and seek to the next column skipping older versions.<a name="line.163"></a> -<span class="sourceLineNo">164</span> */<a name="line.164"></a> -<span class="sourceLineNo">165</span> INCLUDE_AND_NEXT_COL,<a name="line.165"></a> -<span class="sourceLineNo">166</span> /**<a name="line.166"></a> -<span class="sourceLineNo">167</span> * Skip this Cell<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> SKIP,<a name="line.169"></a> -<span class="sourceLineNo">170</span> /**<a name="line.170"></a> -<span class="sourceLineNo">171</span> * Skip this column. Go to the next column in this row.<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> NEXT_COL,<a name="line.173"></a> -<span class="sourceLineNo">174</span> /**<a name="line.174"></a> -<span class="sourceLineNo">175</span> * Seek to next row in current family. It may still pass a cell whose family is different but<a name="line.175"></a> -<span class="sourceLineNo">176</span> * row is the same as previous cell to {@link #filterKeyValue(Cell)} , even if we get a NEXT_ROW<a name="line.176"></a> -<span class="sourceLineNo">177</span> * returned for previous cell. For more details see HBASE-18368. <br><a name="line.177"></a> -<span class="sourceLineNo">178</span> * Once reset() method was invoked, then we switch to the next row for all family, and you can<a name="line.178"></a> -<span class="sourceLineNo">179</span> * catch the event by invoking CellUtils.matchingRows(previousCell, currentCell). <br><a name="line.179"></a> -<span class="sourceLineNo">180</span> * Note that filterRow() will still be called. <br><a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> NEXT_ROW,<a name="line.182"></a> -<span class="sourceLineNo">183</span> /**<a name="line.183"></a> -<span class="sourceLineNo">184</span> * Seek to next key which is given as hint by the filter.<a name="line.184"></a> -<span class="sourceLineNo">185</span> */<a name="line.185"></a> -<span class="sourceLineNo">186</span> SEEK_NEXT_USING_HINT,<a name="line.186"></a> -<span class="sourceLineNo">187</span> /**<a name="line.187"></a> -<span class="sourceLineNo">188</span> * Include KeyValue and done with row, seek to next. See NEXT_ROW.<a name="line.188"></a> -<span class="sourceLineNo">189</span> */<a name="line.189"></a> -<span class="sourceLineNo">190</span> INCLUDE_AND_SEEK_NEXT_ROW,<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> /**<a name="line.193"></a> -<span class="sourceLineNo">194</span> * Chance to alter the list of Cells to be submitted. Modifications to the list will carry on<a name="line.194"></a> -<span class="sourceLineNo">195</span> * <a name="line.195"></a> -<span class="sourceLineNo">196</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.196"></a> -<span class="sourceLineNo">197</span> * {@link IOException}.<a name="line.197"></a> -<span class="sourceLineNo">198</span> * <a name="line.198"></a> -<span class="sourceLineNo">199</span> * @param kvs the list of Cells to be filtered<a name="line.199"></a> -<span class="sourceLineNo">200</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.200"></a> -<span class="sourceLineNo">201</span> */<a name="line.201"></a> -<span class="sourceLineNo">202</span> abstract public void filterRowCells(List<Cell> kvs) 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> * Primarily used to check for conflicts with scans(such as scans that do not read a full row at a<a name="line.205"></a> -<span class="sourceLineNo">206</span> * time).<a name="line.206"></a> -<span class="sourceLineNo">207</span> * <a name="line.207"></a> -<span class="sourceLineNo">208</span> * @return True if this filter actively uses filterRowCells(List) or filterRow().<a name="line.208"></a> -<span class="sourceLineNo">209</span> */<a name="line.209"></a> -<span class="sourceLineNo">210</span> abstract public boolean hasFilterRow();<a name="line.210"></a> -<span class="sourceLineNo">211</span><a name="line.211"></a> -<span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * Last chance to veto row based on previous {@link #filterKeyValue(Cell)} calls. The filter<a name="line.213"></a> -<span class="sourceLineNo">214</span> * needs to retain state then return a particular value for this call if they wish to exclude a<a name="line.214"></a> -<span class="sourceLineNo">215</span> * row if a certain column is missing (for example).<a name="line.215"></a> -<span class="sourceLineNo">216</span> * <a name="line.216"></a> -<span class="sourceLineNo">217</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.217"></a> -<span class="sourceLineNo">218</span> * {@link IOException}.<a name="line.218"></a> -<span class="sourceLineNo">219</span> * <a name="line.219"></a> -<span class="sourceLineNo">220</span> * @return true to exclude row, false to include row.<a name="line.220"></a> -<span class="sourceLineNo">221</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.221"></a> -<span class="sourceLineNo">222</span> */<a name="line.222"></a> -<span class="sourceLineNo">223</span> abstract public boolean filterRow() throws IOException;<a name="line.223"></a> -<span class="sourceLineNo">224</span><a name="line.224"></a> -<span class="sourceLineNo">225</span> /**<a name="line.225"></a> -<span class="sourceLineNo">226</span> * If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is<a name="line.226"></a> -<span class="sourceLineNo">227</span> * the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the<a name="line.227"></a> -<span class="sourceLineNo">228</span> * QueryMatcher would call this function to find out which key it must next seek to.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * <a name="line.229"></a> -<span class="sourceLineNo">230</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.230"></a> -<span class="sourceLineNo">231</span> * {@link IOException}.<a name="line.231"></a> -<span class="sourceLineNo">232</span> * <a name="line.232"></a> -<span class="sourceLineNo">233</span> * @return KeyValue which must be next seeked. return null if the filter is not sure which key to<a name="line.233"></a> -<span class="sourceLineNo">234</span> * seek to next.<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.235"></a> -<span class="sourceLineNo">236</span> */<a name="line.236"></a> -<span class="sourceLineNo">237</span> abstract public Cell getNextCellHint(final Cell currentCell) throws IOException;<a name="line.237"></a> -<span class="sourceLineNo">238</span><a name="line.238"></a> -<span class="sourceLineNo">239</span> /**<a name="line.239"></a> -<span class="sourceLineNo">240</span> * Check that given column family is essential for filter to check row. Most filters always return<a name="line.240"></a> -<span class="sourceLineNo">241</span> * true here. But some could have more sophisticated logic which could significantly reduce<a name="line.241"></a> -<span class="sourceLineNo">242</span> * scanning process by not even touching columns until we are 100% sure that it's data is needed<a name="line.242"></a> -<span class="sourceLineNo">243</span> * in result.<a name="line.243"></a> -<span class="sourceLineNo">244</span> * <a name="line.244"></a> -<span class="sourceLineNo">245</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.245"></a> -<span class="sourceLineNo">246</span> * {@link IOException}.<a name="line.246"></a> -<span class="sourceLineNo">247</span> * <a name="line.247"></a> -<span class="sourceLineNo">248</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.248"></a> -<span class="sourceLineNo">249</span> */<a name="line.249"></a> -<span class="sourceLineNo">250</span> abstract public boolean isFamilyEssential(byte[] name) throws IOException;<a name="line.250"></a> -<span class="sourceLineNo">251</span><a name="line.251"></a> -<span class="sourceLineNo">252</span> /**<a name="line.252"></a> -<span class="sourceLineNo">253</span> * TODO: JAVADOC<a name="line.253"></a> -<span class="sourceLineNo">254</span> * <a name="line.254"></a> -<span class="sourceLineNo">255</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.255"></a> -<span class="sourceLineNo">256</span> * {@link IOException}.<a name="line.256"></a> -<span class="sourceLineNo">257</span> * <a name="line.257"></a> -<span class="sourceLineNo">258</span> * @return The filter serialized using pb<a name="line.258"></a> -<span class="sourceLineNo">259</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.259"></a> -<span class="sourceLineNo">260</span> */<a name="line.260"></a> -<span class="sourceLineNo">261</span> abstract public byte[] toByteArray() throws IOException;<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> * <a name="line.264"></a> -<span class="sourceLineNo">265</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.265"></a> -<span class="sourceLineNo">266</span> * {@link IOException}.<a name="line.266"></a> -<span class="sourceLineNo">267</span> * <a name="line.267"></a> -<span class="sourceLineNo">268</span> * @param pbBytes A pb serialized {@link Filter} instance<a name="line.268"></a> -<span class="sourceLineNo">269</span> * @return An instance of {@link Filter} made from <code>bytes</code><a name="line.269"></a> -<span class="sourceLineNo">270</span> * @throws DeserializationException<a name="line.270"></a> -<span class="sourceLineNo">271</span> * @see #toByteArray<a name="line.271"></a> -<span class="sourceLineNo">272</span> */<a name="line.272"></a> -<span class="sourceLineNo">273</span> public static Filter parseFrom(final byte [] pbBytes) throws DeserializationException {<a name="line.273"></a> -<span class="sourceLineNo">274</span> throw new DeserializationException(<a name="line.274"></a> -<span class="sourceLineNo">275</span> "parseFrom called on base Filter, but should be called on derived type");<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> /**<a name="line.278"></a> -<span class="sourceLineNo">279</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.279"></a> -<span class="sourceLineNo">280</span> * {@link IOException}.<a name="line.280"></a> -<span class="sourceLineNo">281</span> * <a name="line.281"></a> -<span class="sourceLineNo">282</span> * @param other<a name="line.282"></a> -<span class="sourceLineNo">283</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.283"></a> -<span class="sourceLineNo">284</span> * corresponding fields in other. Used for testing.<a name="line.284"></a> -<span class="sourceLineNo">285</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.285"></a> -<span class="sourceLineNo">286</span> */<a name="line.286"></a> -<span class="sourceLineNo">287</span> abstract boolean areSerializedFieldsEqual(Filter other);<a name="line.287"></a> -<span class="sourceLineNo">288</span><a name="line.288"></a> -<span class="sourceLineNo">289</span> /**<a name="line.289"></a> -<span class="sourceLineNo">290</span> * alter the reversed scan flag<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @param reversed flag<a name="line.291"></a> -<span class="sourceLineNo">292</span> */<a name="line.292"></a> -<span class="sourceLineNo">293</span> public void setReversed(boolean reversed) {<a name="line.293"></a> -<span class="sourceLineNo">294</span> this.reversed = reversed;<a name="line.294"></a> -<span class="sourceLineNo">295</span> }<a name="line.295"></a> -<span class="sourceLineNo">296</span><a name="line.296"></a> -<span class="sourceLineNo">297</span> public boolean isReversed() {<a name="line.297"></a> -<span class="sourceLineNo">298</span> return this.reversed;<a name="line.298"></a> -<span class="sourceLineNo">299</span> }<a name="line.299"></a> -<span class="sourceLineNo">300</span>}<a name="line.300"></a> +<span class="sourceLineNo">131</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * Instead use filterCell(Cell)<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> @Deprecated<a name="line.134"></a> +<span class="sourceLineNo">135</span> public ReturnCode filterKeyValue(final Cell c) throws IOException {<a name="line.135"></a> +<span class="sourceLineNo">136</span> return Filter.ReturnCode.INCLUDE;<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> /**<a name="line.139"></a> +<span class="sourceLineNo">140</span> * A way to filter based on the column family, column qualifier and/or the column value. Return<a name="line.140"></a> +<span class="sourceLineNo">141</span> * code is described below. This allows filters to filter only certain number of columns, then<a name="line.141"></a> +<span class="sourceLineNo">142</span> * terminate without matching ever column.<a name="line.142"></a> +<span class="sourceLineNo">143</span> *<a name="line.143"></a> +<span class="sourceLineNo">144</span> * If filterRowKey returns true, filterCell needs to be consistent with it.<a name="line.144"></a> +<span class="sourceLineNo">145</span> *<a name="line.145"></a> +<span class="sourceLineNo">146</span> * filterCell can assume that filterRowKey has already been called for the row.<a name="line.146"></a> +<span class="sourceLineNo">147</span> *<a name="line.147"></a> +<span class="sourceLineNo">148</span> * If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <code>ReturnCode.NEXT_ROW</code> until {@link #reset()} is called just in case the caller calls<a name="line.149"></a> +<span class="sourceLineNo">150</span> * for the next row.<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.152"></a> +<span class="sourceLineNo">153</span> * {@link IOException}.<a name="line.153"></a> +<span class="sourceLineNo">154</span> *<a name="line.154"></a> +<span class="sourceLineNo">155</span> * @param c the Cell in question<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @return code as described below<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @see Filter.ReturnCode<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> public ReturnCode filterCell(final Cell c) throws IOException{<a name="line.160"></a> +<span class="sourceLineNo">161</span> return filterKeyValue(c);<a name="line.161"></a> +<span class="sourceLineNo">162</span> }<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Cell object must be returned.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <a name="line.167"></a> +<span class="sourceLineNo">168</span> * @see org.apache.hadoop.hbase.KeyValue#shallowCopy()<a name="line.168"></a> +<span class="sourceLineNo">169</span> * The transformed KeyValue is what is eventually returned to the client. Most filters will<a name="line.169"></a> +<span class="sourceLineNo">170</span> * return the passed KeyValue unchanged.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @see org.apache.hadoop.hbase.filter.KeyOnlyFilter#transformCell(Cell) for an example of a<a name="line.171"></a> +<span class="sourceLineNo">172</span> * transformation.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * <a name="line.173"></a> +<span class="sourceLineNo">174</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.174"></a> +<span class="sourceLineNo">175</span> * {@link IOException}.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <a name="line.176"></a> +<span class="sourceLineNo">177</span> * @param v the KeyValue in question<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @return the changed KeyValue<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.179"></a> +<span class="sourceLineNo">180</span> */<a name="line.180"></a> +<span class="sourceLineNo">181</span> abstract public Cell transformCell(final Cell v) throws IOException;<a name="line.181"></a> +<span class="sourceLineNo">182</span><a name="line.182"></a> +<span class="sourceLineNo">183</span> /**<a name="line.183"></a> +<span class="sourceLineNo">184</span> * Return codes for filterValue().<a name="line.184"></a> +<span class="sourceLineNo">185</span> */<a name="line.185"></a> +<span class="sourceLineNo">186</span> @InterfaceAudience.Public<a name="line.186"></a> +<span class="sourceLineNo">187</span> public enum ReturnCode {<a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Include the Cell<a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> INCLUDE,<a name="line.191"></a> +<span class="sourceLineNo">192</span> /**<a name="line.192"></a> +<span class="sourceLineNo">193</span> * Include the Cell and seek to the next column skipping older versions.<a name="line.193"></a> +<span class="sourceLineNo">194</span> */<a name="line.194"></a> +<span class="sourceLineNo">195</span> INCLUDE_AND_NEXT_COL,<a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Skip this Cell<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> SKIP,<a name="line.199"></a> +<span class="sourceLineNo">200</span> /**<a name="line.200"></a> +<span class="sourceLineNo">201</span> * Skip this column. Go to the next column in this row.<a name="line.201"></a> +<span class="sourceLineNo">202</span> */<a name="line.202"></a> +<span class="sourceLineNo">203</span> NEXT_COL,<a name="line.203"></a> +<span class="sourceLineNo">204</span> /**<a name="line.204"></a> +<span class="sourceLineNo">205</span> * Seek to next row in current family. It may still pass a cell whose family is different but<a name="line.205"></a> +<span class="sourceLineNo">206</span> * row is the same as previous cell to {@link #filterCell(Cell)} , even if we get a NEXT_ROW<a name="line.206"></a> +<span class="sourceLineNo">207</span> * returned for previous cell. For more details see HBASE-18368. <br><a name="line.207"></a> +<span class="sourceLineNo">208</span> * Once reset() method was invoked, then we switch to the next row for all family, and you can<a name="line.208"></a> +<span class="sourceLineNo">209</span> * catch the event by invoking CellUtils.matchingRows(previousCell, currentCell). <br><a name="line.209"></a> +<span class="sourceLineNo">210</span> * Note that filterRow() will still be called. <br><a name="line.210"></a> +<span class="sourceLineNo">211</span> */<a name="line.211"></a> +<span class="sourceLineNo">212</span> NEXT_ROW,<a name="line.212"></a> +<span class="sourceLineNo">213</span> /**<a name="line.213"></a> +<span class="sourceLineNo">214</span> * Seek to next key which is given as hint by the filter.<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> SEEK_NEXT_USING_HINT,<a name="line.216"></a> +<span class="sourceLineNo">217</span> /**<a name="line.217"></a> +<span class="sourceLineNo">218</span> * Include KeyValue and done with row, seek to next. See NEXT_ROW.<a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> INCLUDE_AND_SEEK_NEXT_ROW,<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> /**<a name="line.223"></a> +<span class="sourceLineNo">224</span> * Chance to alter the list of Cells to be submitted. Modifications to the list will carry on<a name="line.224"></a> +<span class="sourceLineNo">225</span> * <a name="line.225"></a> +<span class="sourceLineNo">226</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.226"></a> +<span class="sourceLineNo">227</span> * {@link IOException}.<a name="line.227"></a> +<span class="sourceLineNo">228</span> * <a name="line.228"></a> +<span class="sourceLineNo">229</span> * @param kvs the list of Cells to be filtered<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.230"></a> +<span class="sourceLineNo">231</span> */<a name="line.231"></a> +<span class="sourceLineNo">232</span> abstract public void filterRowCells(List<Cell> kvs) throws IOException;<a name="line.232"></a> +<span class="sourceLineNo">233</span><a name="line.233"></a> +<span class="sourceLineNo">234</span> /**<a name="line.234"></a> +<span class="sourceLineNo">235</span> * Primarily used to check for conflicts with scans(such as scans that do not read a full row at a<a name="line.235"></a> +<span class="sourceLineNo">236</span> * time).<a name="line.236"></a> +<span class="sourceLineNo">237</span> * <a name="line.237"></a> +<span class="sourceLineNo">238</span> * @return True if this filter actively uses filterRowCells(List) or filterRow().<a name="line.238"></a> +<span class="sourceLineNo">239</span> */<a name="line.239"></a> +<span class="sourceLineNo">240</span> abstract public boolean hasFilterRow();<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> * Last chance to veto row based on previous {@link #filterCell(Cell)} calls. The filter<a name="line.243"></a> +<span class="sourceLineNo">244</span> * needs to retain state then return a particular value for this call if they wish to exclude a<a name="line.244"></a> +<span class="sourceLineNo">245</span> * row if a certain column is missing (for example).<a name="line.245"></a> +<span class="sourceLineNo">246</span> * <a name="line.246"></a> +<span class="sourceLineNo">247</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.247"></a> +<span class="sourceLineNo">248</span> * {@link IOException}.<a name="line.248"></a> +<span class="sourceLineNo">249</span> * <a name="line.249"></a> +<span class="sourceLineNo">250</span> * @return true to exclude row, false to include row.<a name="line.250"></a> +<span class="sourceLineNo">251</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.251"></a> +<span class="sourceLineNo">252</span> */<a name="line.252"></a> +<span class="sourceLineNo">253</span> abstract public boolean filterRow() throws IOException;<a name="line.253"></a> +<span class="sourceLineNo">254</span><a name="line.254"></a> +<span class="sourceLineNo">255</span> /**<a name="line.255"></a> +<span class="sourceLineNo">256</span> * If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is<a name="line.256"></a> +<span class="sourceLineNo">257</span> * the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the<a name="line.257"></a> +<span class="sourceLineNo">258</span> * QueryMatcher would call this function to find out which key it must next seek to.<a name="line.258"></a> +<span class="sourceLineNo">259</span> * <a name="line.259"></a> +<span class="sourceLineNo">260</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.260"></a> +<span class="sourceLineNo">261</span> * {@link IOException}.<a name="line.261"></a> +<span class="sourceLineNo">262</span> * <a name="line.262"></a> +<span class="sourceLineNo">263</span> * @return KeyValue which must be next seeked. return null if the filter is not sure which key to<a name="line.263"></a> +<span class="sourceLineNo">264</span> * seek to next.<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.265"></a> +<span class="sourceLineNo">266</span> */<a name="line.266"></a> +<span class="sourceLineNo">267</span> abstract public Cell getNextCellHint(final Cell currentCell) throws IOException;<a name="line.267"></a> +<span class="sourceLineNo">268</span><a name="line.268"></a> +<span class="sourceLineNo">269</span> /**<a name="line.269"></a> +<span class="sourceLineNo">270</span> * Check that given column family is essential for filter to check row. Most filters always return<a name="line.270"></a> +<span class="sourceLineNo">271</span> * true here. But some could have more sophisticated logic which could significantly reduce<a name="line.271"></a> +<span class="sourceLineNo">272</span> * scanning process by not even touching columns until we are 100% sure that it's data is needed<a name="line.272"></a> +<span class="sourceLineNo">273</span> * in result.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * <a name="line.274"></a> +<span class="sourceLineNo">275</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.275"></a> +<span class="sourceLineNo">276</span> * {@link IOException}.<a name="line.276"></a> +<span class="sourceLineNo">277</span> * <a name="line.277"></a> +<span class="sourceLineNo">278</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.278"></a> +<span class="sourceLineNo">279</span> */<a name="line.279"></a> +<span class="sourceLineNo">280</span> abstract public boolean isFamilyEssential(byte[] name) throws IOException;<a name="line.280"></a> +<span class="sourceLineNo">281</span><a name="line.281"></a> +<span class="sourceLineNo">282</span> /**<a name="line.282"></a> +<span class="sourceLineNo">283</span> * TODO: JAVADOC<a name="line.283"></a> +<span class="sourceLineNo">284</span> * <a name="line.284"></a> +<span class="sourceLineNo">285</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.285"></a> +<span class="sourceLineNo">286</span> * {@link IOException}.<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <a name="line.287"></a> +<span class="sourceLineNo">288</span> * @return The filter serialized using pb<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.289"></a> +<span class="sourceLineNo">290</span> */<a name="line.290"></a> +<span class="sourceLineNo">291</span> abstract public byte[] toByteArray() throws IOException;<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> * <a name="line.294"></a> +<span class="sourceLineNo">295</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.295"></a> +<span class="sourceLineNo">296</span> * {@link IOException}.<a name="line.296"></a> +<span class="sourceLineNo">297</span> * <a name="line.297"></a> +<span class="sourceLineNo">298</span> * @param pbBytes A pb serialized {@link Filter} instance<a name="line.298"></a> +<span class="sourceLineNo">299</span> * @return An instance of {@link Filter} made from <code>bytes</code><a name="line.299"></a> +<span class="sourceLineNo">300</span> * @throws DeserializationException<a name="line.300"></a> +<span class="sourceLineNo">301</span> * @see #toByteArray<a name="line.301"></a> +<span class="sourceLineNo">302</span> */<a name="line.302"></a> +<span class="sourceLineNo">303</span> public static Filter parseFrom(final byte [] pbBytes) throws DeserializationException {<a name="line.303"></a> +<span class="sourceLineNo">304</span> throw new DeserializationException(<a name="line.304"></a> +<span class="sourceLineNo">305</span> "parseFrom called on base Filter, but should be called on derived type");<a name="line.305"></a> +<span class="sourceLineNo">306</span> }<a name="line.306"></a> +<span class="sourceLineNo">307</span><a name="line.307"></a> +<span class="sourceLineNo">308</span> /**<a name="line.308"></a> +<span class="sourceLineNo">309</span> * Concrete implementers can signal a failure condition in their code by throwing an<a name="line.309"></a> +<span class="sourceLineNo">310</span> * {@link IOException}.<a name="line.310"></a> +<span class="sourceLineNo">311</span> * <a name="line.311"></a> +<span class="sourceLineNo">312</span> * @param other<a name="line.312"></a> +<span class="sourceLineNo">313</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.313"></a> +<span class="sourceLineNo">314</span> * corresponding fields in other. Used for testing.<a name="line.314"></a> +<span class="sourceLineNo">315</span> * @throws IOException in case an I/O or an filter specific failure needs to be signaled.<a name="line.315"></a> +<span class="sourceLineNo">316</span> */<a name="line.316"></a> +<span class="sourceLineNo">317</span> abstract boolean areSerializedFieldsEqual(Filter other);<a name="line.317"></a> +<span class="sourceLineNo">318</span><a name="line.318"></a> +<span class="sourceLineNo">319</span> /**<a name="line.319"></a> +<span class="sourceLineNo">320</span> * alter the reversed scan flag<a name="line.320"></a> +<span class="sourceLineNo">321</span> * @param reversed flag<a name="line.321"></a> +<span class="sourceLineNo">322</span> */<a name="line.322"></a> +<span class="sourceLineNo">323</span> public void setReversed(boolean reversed) {<a name="line.323"></a> +<span class="sourceLineNo">324</span> this.reversed = reversed;<a name="line.324"></a> +<span class="sourceLineNo">325</span> }<a name="line.325"></a> +<span class="sourceLineNo">326</span><a name="line.326"></a> +<span class="sourceLineNo">327</span> public boolean isReversed() {<a name="line.327"></a> +<span class="sourceLineNo">328</span> return this.reversed;<a name="line.328"></a> +<span class="sourceLineNo">329</span> }<a name="line.329"></a> +<span class="sourceLineNo">330</span>}<a name="line.330"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html index f5ec5a9..9c23193 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html @@ -46,7 +46,7 @@ <span class="sourceLineNo">038</span> * {@link Operator#MUST_PASS_ONE} (<code>OR</code>). Since you can use Filter Lists as children of<a name="line.38"></a> <span class="sourceLineNo">039</span> * Filter Lists, you can create a hierarchy of filters to be evaluated. <br><a name="line.39"></a> <span class="sourceLineNo">040</span> * {@link Operator#MUST_PASS_ALL} evaluates lazily: evaluation stops as soon as one filter does not<a name="line.40"></a> -<span class="sourceLineNo">041</span> * include the KeyValue. <br><a name="line.41"></a> +<span class="sourceLineNo">041</span> * include the Cell. <br><a name="line.41"></a> <span class="sourceLineNo">042</span> * {@link Operator#MUST_PASS_ONE} evaluates non-lazily: all filters are always evaluated. <br><a name="line.42"></a> <span class="sourceLineNo">043</span> * Defaults to {@link Operator#MUST_PASS_ALL}.<a name="line.43"></a> <span class="sourceLineNo">044</span> */<a name="line.44"></a> @@ -174,8 +174,8 @@ <span class="sourceLineNo">166</span> }<a name="line.166"></a> <span class="sourceLineNo">167</span><a name="line.167"></a> <span class="sourceLineNo">168</span> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * Internal implementation of {@link #filterKeyValue(Cell)}. Compared to the<a name="line.169"></a> -<span class="sourceLineNo">170</span> * {@link #filterKeyValue(Cell)} method, this method accepts an additional parameter named<a name="line.170"></a> +<span class="sourceLineNo">169</span> * Internal implementation of {@link #filterCell(Cell)}. Compared to the<a name="line.169"></a> +<span class="sourceLineNo">170</span> * {@link #filterCell(Cell)} method, this method accepts an additional parameter named<a name="line.170"></a> <span class="sourceLineNo">171</span> * transformedCell. This parameter indicates the initial value of transformed cell before this<a name="line.171"></a> <span class="sourceLineNo">172</span> * filter operation. <br/><a name="line.172"></a> <span class="sourceLineNo">173</span> * For FilterList, we can consider a filter list as a node in a tree. sub-filters of the filter<a name="line.173"></a> @@ -188,114 +188,120 @@ <span class="sourceLineNo">180</span> * @return ReturnCode of this filter operation.<a name="line.180"></a> <span class="sourceLineNo">181</span> * @throws IOException<a name="line.181"></a> <span class="sourceLineNo">182</span> */<a name="line.182"></a> -<span class="sourceLineNo">183</span> ReturnCode internalFilterKeyValue(Cell c, Cell transformedCell) throws IOException {<a name="line.183"></a> -<span class="sourceLineNo">184</span> return this.filterListBase.internalFilterKeyValue(c, transformedCell);<a name="line.184"></a> +<span class="sourceLineNo">183</span> ReturnCode internalFilterCell(Cell c, Cell transformedCell) throws IOException {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return this.filterListBase.internalFilterCell(c, transformedCell);<a name="line.184"></a> <span class="sourceLineNo">185</span> }<a name="line.185"></a> <span class="sourceLineNo">186</span><a name="line.186"></a> <span class="sourceLineNo">187</span> @Override<a name="line.187"></a> -<span class="sourceLineNo">188</span> public ReturnCode filterKeyValue(Cell c) throws IOException {<a name="line.188"></a> -<span class="sourceLineNo">189</span> return filterListBase.filterKeyValue(c);<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> * Filters that never filter by modifying the returned List of Cells can inherit this<a name="line.193"></a> -<span class="sourceLineNo">194</span> * implementation that does nothing. {@inheritDoc}<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> @Override<a name="line.196"></a> -<span class="sourceLineNo">197</span> public void filterRowCells(List<Cell> cells) throws IOException {<a name="line.197"></a> -<span class="sourceLineNo">198</span> filterListBase.filterRowCells(cells);<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span><a name="line.200"></a> -<span class="sourceLineNo">201</span> @Override<a name="line.201"></a> -<span class="sourceLineNo">202</span> public boolean hasFilterRow() {<a name="line.202"></a> -<span class="sourceLineNo">203</span> return filterListBase.hasFilterRow();<a name="line.203"></a> -<span class="sourceLineNo">204</span> }<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> @Override<a name="line.206"></a> -<span class="sourceLineNo">207</span> public boolean filterRow() throws IOException {<a name="line.207"></a> -<span class="sourceLineNo">208</span> return filterListBase.filterRow();<a name="line.208"></a> -<span class="sourceLineNo">209</span> }<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> * @return The filter serialized using pb<a name="line.212"></a> -<span class="sourceLineNo">213</span> */<a name="line.213"></a> -<span class="sourceLineNo">214</span> public byte[] toByteArray() throws IOException {<a name="line.214"></a> -<span class="sourceLineNo">215</span> FilterProtos.FilterList.Builder builder = FilterProtos.FilterList.newBuilder();<a name="line.215"></a> -<span class="sourceLineNo">216</span> builder.setOperator(FilterProtos.FilterList.Operator.valueOf(operator.name()));<a name="line.216"></a> -<span class="sourceLineNo">217</span> ArrayList<Filter> filters = filterListBase.getFilters();<a name="line.217"></a> -<span class="sourceLineNo">218</span> for (int i = 0, n = filters.size(); i < n; i++) {<a name="line.218"></a> -<span class="sourceLineNo">219</span> builder.addFilters(ProtobufUtil.toFilter(filters.get(i)));<a name="line.219"></a> -<span class="sourceLineNo">220</span> }<a name="line.220"></a> -<span class="sourceLineNo">221</span> return builder.build().toByteArray();<a name="line.221"></a> -<span class="sourceLineNo">222</span> }<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> * @param pbBytes A pb serialized {@link FilterList} instance<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @return An instance of {@link FilterList} made from <code>bytes</code><a name="line.226"></a> -<span class="sourceLineNo">227</span> * @throws DeserializationException<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @see #toByteArray<a name="line.228"></a> -<span class="sourceLineNo">229</span> */<a name="line.229"></a> -<span class="sourceLineNo">230</span> public static FilterList parseFrom(final byte[] pbBytes) throws DeserializationException {<a name="line.230"></a> -<span class="sourceLineNo">231</span> FilterProtos.FilterList proto;<a name="line.231"></a> -<span class="sourceLineNo">232</span> try {<a name="line.232"></a> -<span class="sourceLineNo">233</span> proto = FilterProtos.FilterList.parseFrom(pbBytes);<a name="line.233"></a> -<span class="sourceLineNo">234</span> } catch (InvalidProtocolBufferException e) {<a name="line.234"></a> -<span class="sourceLineNo">235</span> throw new DeserializationException(e);<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> List<Filter> rowFilters = new ArrayList<>(proto.getFiltersCount());<a name="line.238"></a> -<span class="sourceLineNo">239</span> try {<a name="line.239"></a> -<span class="sourceLineNo">240</span> List<FilterProtos.Filter> filtersList = proto.getFiltersList();<a name="line.240"></a> -<span class="sourceLineNo">241</span> for (int i = 0, n = filtersList.size(); i < n; i++) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> rowFilters.add(ProtobufUtil.toFilter(filtersList.get(i)));<a name="line.242"></a> -<span class="sourceLineNo">243</span> }<a name="line.243"></a> -<span class="sourceLineNo">244</span> } catch (IOException ioe) {<a name="line.244"></a> -<span class="sourceLineNo">245</span> throw new DeserializationException(ioe);<a name="line.245"></a> -<span class="sourceLineNo">246</span> }<a name="line.246"></a> -<span class="sourceLineNo">247</span> return new FilterList(Operator.valueOf(proto.getOperator().name()), rowFilters);<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> /**<a name="line.250"></a> -<span class="sourceLineNo">251</span> * @param other<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.252"></a> -<span class="sourceLineNo">253</span> * corresponding fields in other. Used for testing.<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> boolean areSerializedFieldsEqual(Filter other) {<a name="line.255"></a> -<span class="sourceLineNo">256</span> if (other == this) return true;<a name="line.256"></a> -<span class="sourceLineNo">257</span> if (!(other instanceof FilterList)) return false;<a name="line.257"></a> -<span class="sourceLineNo">258</span><a name="line.258"></a> -<span class="sourceLineNo">259</span> FilterList o = (FilterList) other;<a name="line.259"></a> -<span class="sourceLineNo">260</span> return this.getOperator().equals(o.getOperator())<a name="line.260"></a> -<span class="sourceLineNo">261</span> && ((this.getFilters() == o.getFilters()) || this.getFilters().equals(o.getFilters()));<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> @Override<a name="line.264"></a> -<span class="sourceLineNo">265</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.265"></a> -<span class="sourceLineNo">266</span> return this.filterListBase.getNextCellHint(currentCell);<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> @Override<a name="line.269"></a> -<span class="sourceLineNo">270</span> public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.270"></a> -<span class="sourceLineNo">271</span> return this.filterListBase.isFamilyEssential(name);<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> @Override<a name="line.274"></a> -<span class="sourceLineNo">275</span> public void setReversed(boolean reversed) {<a name="line.275"></a> -<span class="sourceLineNo">276</span> this.reversed = reversed;<a name="line.276"></a> -<span class="sourceLineNo">277</span> this.filterListBase.setReversed(reversed);<a name="line.277"></a> +<span class="sourceLineNo">188</span> @Deprecated<a name="line.188"></a> +<span class="sourceLineNo">189</span> public ReturnCode filterKeyValue(final Cell c) throws IOException {<a name="line.189"></a> +<span class="sourceLineNo">190</span> return filterCell(c);<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> @Override<a name="line.193"></a> +<span class="sourceLineNo">194</span> public ReturnCode filterCell(final Cell c) throws IOException {<a name="line.194"></a> +<span class="sourceLineNo">195</span> return filterListBase.filterCell(c);<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<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> * Filters that never filter by modifying the returned List of Cells can inherit this<a name="line.199"></a> +<span class="sourceLineNo">200</span> * implementation that does nothing. {@inheritDoc}<a name="line.200"></a> +<span class="sourceLineNo">201</span> */<a name="line.201"></a> +<span class="sourceLineNo">202</span> @Override<a name="line.202"></a> +<span class="sourceLineNo">203</span> public void filterRowCells(List<Cell> cells) throws IOException {<a name="line.203"></a> +<span class="sourceLineNo">204</span> filterListBase.filterRowCells(cells);<a name="line.204"></a> +<span class="sourceLineNo">205</span> }<a name="line.205"></a> +<span class="sourceLineNo">206</span><a name="line.206"></a> +<span class="sourceLineNo">207</span> @Override<a name="line.207"></a> +<span class="sourceLineNo">208</span> public boolean hasFilterRow() {<a name="line.208"></a> +<span class="sourceLineNo">209</span> return filterListBase.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> @Override<a name="line.212"></a> +<span class="sourceLineNo">213</span> public boolean filterRow() throws IOException {<a name="line.213"></a> +<span class="sourceLineNo">214</span> return filterListBase.filterRow();<a name="line.214"></a> +<span class="sourceLineNo">215</span> }<a name="line.215"></a> +<span class="sourceLineNo">216</span><a name="line.216"></a> +<span class="sourceLineNo">217</span> /**<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @return The filter serialized using pb<a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> public byte[] toByteArray() throws IOException {<a name="line.220"></a> +<span class="sourceLineNo">221</span> FilterProtos.FilterList.Builder builder = FilterProtos.FilterList.newBuilder();<a name="line.221"></a> +<span class="sourceLineNo">222</span> builder.setOperator(FilterProtos.FilterList.Operator.valueOf(operator.name()));<a name="line.222"></a> +<span class="sourceLineNo">223</span> ArrayList<Filter> filters = filterListBase.getFilters();<a name="line.223"></a> +<span class="sourceLineNo">224</span> for (int i = 0, n = filters.size(); i < n; i++) {<a name="line.224"></a> +<span class="sourceLineNo">225</span> builder.addFilters(ProtobufUtil.toFilter(filters.get(i)));<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span> return builder.build().toByteArray();<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param pbBytes A pb serialized {@link FilterList} instance<a name="line.231"></a> +<span class="sourceLineNo">232</span> * @return An instance of {@link FilterList} made from <code>bytes</code><a name="line.232"></a> +<span class="sourceLineNo">233</span> * @throws DeserializationException<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @see #toByteArray<a name="line.234"></a> +<span class="sourceLineNo">235</span> */<a name="line.235"></a> +<span class="sourceLineNo">236</span> public static FilterList parseFrom(final byte[] pbBytes) throws DeserializationException {<a name="line.236"></a> +<span class="sourceLineNo">237</span> FilterProtos.FilterList proto;<a name="line.237"></a> +<span class="sourceLineNo">238</span> try {<a name="line.238"></a> +<span class="sourceLineNo">239</span> proto = FilterProtos.FilterList.parseFrom(pbBytes);<a name="line.239"></a> +<span class="sourceLineNo">240</span> } catch (InvalidProtocolBufferException e) {<a name="line.240"></a> +<span class="sourceLineNo">241</span> throw new DeserializationException(e);<a name="line.241"></a> +<span class="sourceLineNo">242</span> }<a name="line.242"></a> +<span class="sourceLineNo">243</span><a name="line.243"></a> +<span class="sourceLineNo">244</span> List<Filter> rowFilters = new ArrayList<>(proto.getFiltersCount());<a name="line.244"></a> +<span class="sourceLineNo">245</span> try {<a name="line.245"></a> +<span class="sourceLineNo">246</span> List<FilterProtos.Filter> filtersList = proto.getFiltersList();<a name="line.246"></a> +<span class="sourceLineNo">247</span> for (int i = 0, n = filtersList.size(); i < n; i++) {<a name="line.247"></a> +<span class="sourceLineNo">248</span> rowFilters.add(ProtobufUtil.toFilter(filtersList.get(i)));<a name="line.248"></a> +<span class="sourceLineNo">249</span> }<a name="line.249"></a> +<span class="sourceLineNo">250</span> } catch (IOException ioe) {<a name="line.250"></a> +<span class="sourceLineNo">251</span> throw new DeserializationException(ioe);<a name="line.251"></a> +<span class="sourceLineNo">252</span> }<a name="line.252"></a> +<span class="sourceLineNo">253</span> return new FilterList(Operator.valueOf(proto.getOperator().name()), rowFilters);<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> /**<a name="line.256"></a> +<span class="sourceLineNo">257</span> * @param other<a name="line.257"></a> +<span class="sourceLineNo">258</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.258"></a> +<span class="sourceLineNo">259</span> * corresponding fields in other. Used for testing.<a name="line.259"></a> +<span class="sourceLineNo">260</span> */<a name="line.260"></a> +<span class="sourceLineNo">261</span> boolean areSerializedFieldsEqual(Filter other) {<a name="line.261"></a> +<span class="sourceLineNo">262</span> if (other == this) return true;<a name="line.262"></a> +<span class="sourceLineNo">263</span> if (!(other instanceof FilterList)) return false;<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> FilterList o = (FilterList) other;<a name="line.265"></a> +<span class="sourceLineNo">266</span> return this.getOperator().equals(o.getOperator())<a name="line.266"></a> +<span class="sourceLineNo">267</span> && ((this.getFilters() == o.getFilters()) || this.getFilters().equals(o.getFilters()));<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> @Override<a name="line.270"></a> +<span class="sourceLineNo">271</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.271"></a> +<span class="sourceLineNo">272</span> return this.filterListBase.getNextCellHint(currentCell);<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> @Override<a name="line.275"></a> +<span class="sourceLineNo">276</span> public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.276"></a> +<span class="sourceLineNo">277</span> return this.filterListBase.isFamilyEssential(name);<a name="line.277"></a> <span class="sourceLineNo">278</span> }<a name="line.278"></a> <span class="sourceLineNo">279</span><a name="line.279"></a> <span class="sourceLineNo">280</span> @Override<a name="line.280"></a> -<span class="sourceLineNo">281</span> public boolean isReversed() {<a name="line.281"></a> -<span class="sourceLineNo">282</span> assert this.reversed == this.filterListBase.isReversed();<a name="line.282"></a> -<span class="sourceLineNo">283</span> return this.reversed;<a name="line.283"></a> +<span class="sourceLineNo">281</span> public void setReversed(boolean reversed) {<a name="line.281"></a> +<span class="sourceLineNo">282</span> this.reversed = reversed;<a name="line.282"></a> +<span class="sourceLineNo">283</span> this.filterListBase.setReversed(reversed);<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> @Override<a name="line.286"></a> -<span class="sourceLineNo">287</span> public String toString() {<a name="line.287"></a> -<span class="sourceLineNo">288</span> return this.filterListBase.toString();<a name="line.288"></a> -<span class="sourceLineNo">289</span> }<a name="line.289"></a> -<span class="sourceLineNo">290</span>}<a name="line.290"></a> +<span class="sourceLineNo">287</span> public boolean isReversed() {<a name="line.287"></a> +<span class="sourceLineNo">288</span> assert this.reversed == this.filterListBase.isReversed();<a name="line.288"></a> +<span class="sourceLineNo">289</span> return this.reversed;<a name="line.289"></a> +<span class="sourceLineNo">290</span> }<a name="line.290"></a> +<span class="sourceLineNo">291</span><a name="line.291"></a> +<span class="sourceLineNo">292</span> @Override<a name="line.292"></a> +<span class="sourceLineNo">293</span> public String toString() {<a name="line.293"></a> +<span class="sourceLineNo">294</span> return this.filterListBase.toString();<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span>}<a name="line.296"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.html index f5ec5a9..9c23193 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/FilterList.html @@ -46,7 +46,7 @@ <span class="sourceLineNo">038</span> * {@link Operator#MUST_PASS_ONE} (<code>OR</code>). Since you can use Filter Lists as children of<a name="line.38"></a> <span class="sourceLineNo">039</span> * Filter Lists, you can create a hierarchy of filters to be evaluated. <br><a name="line.39"></a> <span class="sourceLineNo">040</span> * {@link Operator#MUST_PASS_ALL} evaluates lazily: evaluation stops as soon as one filter does not<a name="line.40"></a> -<span class="sourceLineNo">041</span> * include the KeyValue. <br><a name="line.41"></a> +<span class="sourceLineNo">041</span> * include the Cell. <br><a name="line.41"></a> <span class="sourceLineNo">042</span> * {@link Operator#MUST_PASS_ONE} evaluates non-lazily: all filters are always evaluated. <br><a name="line.42"></a> <span class="sourceLineNo">043</span> * Defaults to {@link Operator#MUST_PASS_ALL}.<a name="line.43"></a> <span class="sourceLineNo">044</span> */<a name="line.44"></a> @@ -174,8 +174,8 @@ <span class="sourceLineNo">166</span> }<a name="line.166"></a> <span class="sourceLineNo">167</span><a name="line.167"></a> <span class="sourceLineNo">168</span> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * Internal implementation of {@link #filterKeyValue(Cell)}. Compared to the<a name="line.169"></a> -<span class="sourceLineNo">170</span> * {@link #filterKeyValue(Cell)} method, this method accepts an additional parameter named<a name="line.170"></a> +<span class="sourceLineNo">169</span> * Internal implementation of {@link #filterCell(Cell)}. Compared to the<a name="line.169"></a> +<span class="sourceLineNo">170</span> * {@link #filterCell(Cell)} method, this method accepts an additional parameter named<a name="line.170"></a> <span class="sourceLineNo">171</span> * transformedCell. This parameter indicates the initial value of transformed cell before this<a name="line.171"></a> <span class="sourceLineNo">172</span> * filter operation. <br/><a name="line.172"></a> <span class="sourceLineNo">173</span> * For FilterList, we can consider a filter list as a node in a tree. sub-filters of the filter<a name="line.173"></a> @@ -188,114 +188,120 @@ <span class="sourceLineNo">180</span> * @return ReturnCode of this filter operation.<a name="line.180"></a> <span class="sourceLineNo">181</span> * @throws IOException<a name="line.181"></a> <span class="sourceLineNo">182</span> */<a name="line.182"></a> -<span class="sourceLineNo">183</span> ReturnCode internalFilterKeyValue(Cell c, Cell transformedCell) throws IOException {<a name="line.183"></a> -<span class="sourceLineNo">184</span> return this.filterListBase.internalFilterKeyValue(c, transformedCell);<a name="line.184"></a> +<span class="sourceLineNo">183</span> ReturnCode internalFilterCell(Cell c, Cell transformedCell) throws IOException {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return this.filterListBase.internalFilterCell(c, transformedCell);<a name="line.184"></a> <span class="sourceLineNo">185</span> }<a name="line.185"></a> <span class="sourceLineNo">186</span><a name="line.186"></a> <span class="sourceLineNo">187</span> @Override<a name="line.187"></a> -<span class="sourceLineNo">188</span> public ReturnCode filterKeyValue(Cell c) throws IOException {<a name="line.188"></a> -<span class="sourceLineNo">189</span> return filterListBase.filterKeyValue(c);<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> * Filters that never filter by modifying the returned List of Cells can inherit this<a name="line.193"></a> -<span class="sourceLineNo">194</span> * implementation that does nothing. {@inheritDoc}<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> @Override<a name="line.196"></a> -<span class="sourceLineNo">197</span> public void filterRowCells(List<Cell> cells) throws IOException {<a name="line.197"></a> -<span class="sourceLineNo">198</span> filterListBase.filterRowCells(cells);<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span><a name="line.200"></a> -<span class="sourceLineNo">201</span> @Override<a name="line.201"></a> -<span class="sourceLineNo">202</span> public boolean hasFilterRow() {<a name="line.202"></a> -<span class="sourceLineNo">203</span> return filterListBase.hasFilterRow();<a name="line.203"></a> -<span class="sourceLineNo">204</span> }<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> @Override<a name="line.206"></a> -<span class="sourceLineNo">207</span> public boolean filterRow() throws IOException {<a name="line.207"></a> -<span class="sourceLineNo">208</span> return filterListBase.filterRow();<a name="line.208"></a> -<span class="sourceLineNo">209</span> }<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> * @return The filter serialized using pb<a name="line.212"></a> -<span class="sourceLineNo">213</span> */<a name="line.213"></a> -<span class="sourceLineNo">214</span> public byte[] toByteArray() throws IOException {<a name="line.214"></a> -<span class="sourceLineNo">215</span> FilterProtos.FilterList.Builder builder = FilterProtos.FilterList.newBuilder();<a name="line.215"></a> -<span class="sourceLineNo">216</span> builder.setOperator(FilterProtos.FilterList.Operator.valueOf(operator.name()));<a name="line.216"></a> -<span class="sourceLineNo">217</span> ArrayList<Filter> filters = filterListBase.getFilters();<a name="line.217"></a> -<span class="sourceLineNo">218</span> for (int i = 0, n = filters.size(); i < n; i++) {<a name="line.218"></a> -<span class="sourceLineNo">219</span> builder.addFilters(ProtobufUtil.toFilter(filters.get(i)));<a name="line.219"></a> -<span class="sourceLineNo">220</span> }<a name="line.220"></a> -<span class="sourceLineNo">221</span> return builder.build().toByteArray();<a name="line.221"></a> -<span class="sourceLineNo">222</span> }<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> * @param pbBytes A pb serialized {@link FilterList} instance<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @return An instance of {@link FilterList} made from <code>bytes</code><a name="line.226"></a> -<span class="sourceLineNo">227</span> * @throws DeserializationException<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @see #toByteArray<a name="line.228"></a> -<span class="sourceLineNo">229</span> */<a name="line.229"></a> -<span class="sourceLineNo">230</span> public static FilterList parseFrom(final byte[] pbBytes) throws DeserializationException {<a name="line.230"></a> -<span class="sourceLineNo">231</span> FilterProtos.FilterList proto;<a name="line.231"></a> -<span class="sourceLineNo">232</span> try {<a name="line.232"></a> -<span class="sourceLineNo">233</span> proto = FilterProtos.FilterList.parseFrom(pbBytes);<a name="line.233"></a> -<span class="sourceLineNo">234</span> } catch (InvalidProtocolBufferException e) {<a name="line.234"></a> -<span class="sourceLineNo">235</span> throw new DeserializationException(e);<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> List<Filter> rowFilters = new ArrayList<>(proto.getFiltersCount());<a name="line.238"></a> -<span class="sourceLineNo">239</span> try {<a name="line.239"></a> -<span class="sourceLineNo">240</span> List<FilterProtos.Filter> filtersList = proto.getFiltersList();<a name="line.240"></a> -<span class="sourceLineNo">241</span> for (int i = 0, n = filtersList.size(); i < n; i++) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> rowFilters.add(ProtobufUtil.toFilter(filtersList.get(i)));<a name="line.242"></a> -<span class="sourceLineNo">243</span> }<a name="line.243"></a> -<span class="sourceLineNo">244</span> } catch (IOException ioe) {<a name="line.244"></a> -<span class="sourceLineNo">245</span> throw new DeserializationException(ioe);<a name="line.245"></a> -<span class="sourceLineNo">246</span> }<a name="line.246"></a> -<span class="sourceLineNo">247</span> return new FilterList(Operator.valueOf(proto.getOperator().name()), rowFilters);<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> /**<a name="line.250"></a> -<span class="sourceLineNo">251</span> * @param other<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.252"></a> -<span class="sourceLineNo">253</span> * corresponding fields in other. Used for testing.<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> boolean areSerializedFieldsEqual(Filter other) {<a name="line.255"></a> -<span class="sourceLineNo">256</span> if (other == this) return true;<a name="line.256"></a> -<span class="sourceLineNo">257</span> if (!(other instanceof FilterList)) return false;<a name="line.257"></a> -<span class="sourceLineNo">258</span><a name="line.258"></a> -<span class="sourceLineNo">259</span> FilterList o = (FilterList) other;<a name="line.259"></a> -<span class="sourceLineNo">260</span> return this.getOperator().equals(o.getOperator())<a name="line.260"></a> -<span class="sourceLineNo">261</span> && ((this.getFilters() == o.getFilters()) || this.getFilters().equals(o.getFilters()));<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> @Override<a name="line.264"></a> -<span class="sourceLineNo">265</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.265"></a> -<span class="sourceLineNo">266</span> return this.filterListBase.getNextCellHint(currentCell);<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> @Override<a name="line.269"></a> -<span class="sourceLineNo">270</span> public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.270"></a> -<span class="sourceLineNo">271</span> return this.filterListBase.isFamilyEssential(name);<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> @Override<a name="line.274"></a> -<span class="sourceLineNo">275</span> public void setReversed(boolean reversed) {<a name="line.275"></a> -<span class="sourceLineNo">276</span> this.reversed = reversed;<a name="line.276"></a> -<span class="sourceLineNo">277</span> this.filterListBase.setReversed(reversed);<a name="line.277"></a> +<span class="sourceLineNo">188</span> @Deprecated<a name="line.188"></a> +<span class="sourceLineNo">189</span> public ReturnCode filterKeyValue(final Cell c) throws IOException {<a name="line.189"></a> +<span class="sourceLineNo">190</span> return filterCell(c);<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> @Override<a name="line.193"></a> +<span class="sourceLineNo">194</span> public ReturnCode filterCell(final Cell c) throws IOException {<a name="line.194"></a> +<span class="sourceLineNo">195</span> return filterListBase.filterCell(c);<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<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> * Filters that never filter by modifying the returned List of Cells can inherit this<a name="line.199"></a> +<span class="sourceLineNo">200</span> * implementation that does nothing. {@inheritDoc}<a name="line.200"></a> +<span class="sourceLineNo">201</span> */<a name="line.201"></a> +<span class="sourceLineNo">202</span> @Override<a name="line.202"></a> +<span class="sourceLineNo">203</span> public void filterRowCells(List<Cell> cells) throws IOException {<a name="line.203"></a> +<span class="sourceLineNo">204</span> filterListBase.filterRowCells(cells);<a name="line.204"></a> +<span class="sourceLineNo">205</span> }<a name="line.205"></a> +<span class="sourceLineNo">206</span><a name="line.206"></a> +<span class="sourceLineNo">207</span> @Override<a name="line.207"></a> +<span class="sourceLineNo">208</span> public boolean hasFilterRow() {<a name="line.208"></a> +<span class="sourceLineNo">209</span> return filterListBase.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> @Override<a name="line.212"></a> +<span class="sourceLineNo">213</span> public boolean filterRow() throws IOException {<a name="line.213"></a> +<span class="sourceLineNo">214</span> return filterListBase.filterRow();<a name="line.214"></a> +<span class="sourceLineNo">215</span> }<a name="line.215"></a> +<span class="sourceLineNo">216</span><a name="line.216"></a> +<span class="sourceLineNo">217</span> /**<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @return The filter serialized using pb<a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> public byte[] toByteArray() throws IOException {<a name="line.220"></a> +<span class="sourceLineNo">221</span> FilterProtos.FilterList.Builder builder = FilterProtos.FilterList.newBuilder();<a name="line.221"></a> +<span class="sourceLineNo">222</span> builder.setOperator(FilterProtos.FilterList.Operator.valueOf(operator.name()));<a name="line.222"></a> +<span class="sourceLineNo">223</span> ArrayList<Filter> filters = filterListBase.getFilters();<a name="line.223"></a> +<span class="sourceLineNo">224</span> for (int i = 0, n = filters.size(); i < n; i++) {<a name="line.224"></a> +<span class="sourceLineNo">225</span> builder.addFilters(ProtobufUtil.toFilter(filters.get(i)));<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span> return builder.build().toByteArray();<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param pbBytes A pb serialized {@link FilterList} instance<a name="line.231"></a> +<span class="sourceLineNo">232</span> * @return An instance of {@link FilterList} made from <code>bytes</code><a name="line.232"></a> +<span class="sourceLineNo">233</span> * @throws DeserializationException<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @see #toByteArray<a name="line.234"></a> +<span class="sourceLineNo">235</span> */<a name="line.235"></a> +<span class="sourceLineNo">236</span> public static FilterList parseFrom(final byte[] pbBytes) throws DeserializationException {<a name="line.236"></a> +<span class="sourceLineNo">237</span> FilterProtos.FilterList proto;<a name="line.237"></a> +<span class="sourceLineNo">238</span> try {<a name="line.238"></a> +<span class="sourceLineNo">239</span> proto = FilterProtos.FilterList.parseFrom(pbBytes);<a name="line.239"></a> +<span class="sourceLineNo">240</span> } catch (InvalidProtocolBufferException e) {<a name="line.240"></a> +<span class="sourceLineNo">241</span> throw new DeserializationException(e);<a name="line.241"></a> +<span class="sourceLineNo">242</span> }<a name="line.242"></a> +<span class="sourceLineNo">243</span><a name="line.243"></a> +<span class="sourceLineNo">244</span> List<Filter> rowFilters = new ArrayList<>(proto.getFiltersCount());<a name="line.244"></a> +<span class="sourceLineNo">245</span> try {<a name="line.245"></a> +<span class="sourceLineNo">246</span> List<FilterProtos.Filter> filtersList = proto.getFiltersList();<a name="line.246"></a> +<span class="sourceLineNo">247</span> for (int i = 0, n = filtersList.size(); i < n; i++) {<a name="line.247"></a> +<span class="sourceLineNo">248</span> rowFilters.add(ProtobufUtil.toFilter(filtersList.get(i)));<a name="line.248"></a> +<span class="sourceLineNo">249</span> }<a name="line.249"></a> +<span class="sourceLineNo">250</span> } catch (IOException ioe) {<a name="line.250"></a> +<span class="sourceLineNo">251</span> throw new DeserializationException(ioe);<a name="line.251"></a> +<span class="sourceLineNo">252</span> }<a name="line.252"></a> +<span class="sourceLineNo">253</span> return new FilterList(Operator.valueOf(proto.getOperator().name()), rowFilters);<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> /**<a name="line.256"></a> +<span class="sourceLineNo">257</span> * @param other<a name="line.257"></a> +<span class="sourceLineNo">258</span> * @return true if and only if the fields of the filter that are serialized are equal to the<a name="line.258"></a> +<span class="sourceLineNo">259</span> * corresponding fields in other. Used for testing.<a name="line.259"></a> +<span class="sourceLineNo">260</span> */<a name="line.260"></a> +<span class="sourceLineNo">261</span> boolean areSerializedFieldsEqual(Filter other) {<a name="line.261"></a> +<span class="sourceLineNo">262</span> if (other == this) return true;<a name="line.262"></a> +<span class="sourceLineNo">263</span> if (!(other instanceof FilterList)) return false;<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> FilterList o = (FilterList) other;<a name="line.265"></a> +<span class="sourceLineNo">266</span> return this.getOperator().equals(o.getOperator())<a name="line.266"></a> +<span class="sourceLineNo">267</span> && ((this.getFilters() == o.getFilters()) || this.getFilters().equals(o.getFilters()));<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> @Override<a name="line.270"></a> +<span class="sourceLineNo">271</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.271"></a> +<span class="sourceLineNo">272</span> return this.filterListBase.getNextCellHint(currentCell);<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> @Override<a name="line.275"></a> +<span class="sourceLineNo">276</span> public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.276"></a> +<span class="sourceLineNo">277</span> return this.filterListBase.isFamilyEssential(name);<a name="line.277"></a> <span class="sourceLineNo">278</span> }<a name="line.278"></a> <span class="sourceLineNo">279</span><a name="line.279"></a> <span class="sourceLineNo">280</span> @Override<a name="line.280"></a> -<span class="sourceLineNo">281</span> public boolean isReversed() {<a name="line.281"></a> -<span class="sourceLineNo">282</span> assert this.reversed == this.filterListBase.isReversed();<a name="line.282"></a> -<span class="sourceLineNo">283</span> return this.reversed;<a name="line.283"></a> +<span class="sourceLineNo">281</span> public void setReversed(boolean reversed) {<a name="line.281"></a> +<span class="sourceLineNo">282</span> this.reversed = reversed;<a name="line.282"></a> +<span class="sourceLineNo">283</span> this.filterListBase.setReversed(reversed);<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> @Override<a name="line.286"></a> -<span class="sourceLineNo">287</span> public String toString() {<a name="line.287"></a> -<span class="sourceLineNo">288</span> return this.filterListBase.toString();<a name="line.288"></a> -<span class="sourceLineNo">289</span> }<a name="line.289"></a> -<span class="sourceLineNo">290</span>}<a name="line.290"></a> +<span class="sourceLineNo">287</span> public boolean isReversed() {<a name="line.287"></a> +<span class="sourceLineNo">288</span> assert this.reversed == this.filterListBase.isReversed();<a name="line.288"></a> +<span class="sourceLineNo">289</span> return this.reversed;<a name="line.289"></a> +<span class="sourceLineNo">290</span> }<a name="line.290"></a> +<span class="sourceLineNo">291</span><a name="line.291"></a> +<span class="sourceLineNo">292</span> @Override<a name="line.292"></a> +<span class="sourceLineNo">293</span> public String toString() {<a name="line.293"></a> +<span class="sourceLineNo">294</span> return this.filterListBase.toString();<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span>}<a name="line.296"></a>
