http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5018ccb3/apidocs/src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html
----------------------------------------------------------------------
diff --git
a/apidocs/src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html
b/apidocs/src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html
index 25e4d7d..2ded650 100644
---
a/apidocs/src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html
+++
b/apidocs/src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html
@@ -33,435 +33,436 @@
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a
name="line.25"></a>
<span class="sourceLineNo">026</span>import
org.apache.hadoop.hbase.CellUtil;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import
org.apache.hadoop.hbase.CompareOperator;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import
org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import
org.apache.hadoop.hbase.exceptions.DeserializationException;<a
name="line.29"></a>
-<span class="sourceLineNo">030</span>import
org.apache.hadoop.hbase.filter.CompareFilter.CompareOp;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import
org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferException;<a
name="line.31"></a>
-<span class="sourceLineNo">032</span>import
org.apache.hadoop.hbase.shaded.com.google.protobuf.UnsafeByteOperations;<a
name="line.32"></a>
-<span class="sourceLineNo">033</span>import
org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import
org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a
name="line.34"></a>
-<span class="sourceLineNo">035</span>import
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;<a
name="line.35"></a>
-<span class="sourceLineNo">036</span>import
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.CompareType;<a
name="line.36"></a>
-<span class="sourceLineNo">037</span>import
org.apache.hadoop.hbase.util.Bytes;<a name="line.37"></a>
-<span class="sourceLineNo">038</span><a name="line.38"></a>
-<span class="sourceLineNo">039</span>import
org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a
name="line.39"></a>
-<span class="sourceLineNo">040</span><a name="line.40"></a>
-<span class="sourceLineNo">041</span>/**<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * This filter is used to filter cells
based on value. It takes a {@link CompareFilter.CompareOp}<a name="line.42"></a>
-<span class="sourceLineNo">043</span> * operator (equal, greater, not equal,
etc), and either a byte [] value or<a name="line.43"></a>
-<span class="sourceLineNo">044</span> * a ByteArrayComparable.<a
name="line.44"></a>
-<span class="sourceLineNo">045</span> * <p><a name="line.45"></a>
-<span class="sourceLineNo">046</span> * If we have a byte [] value then we
just do a lexicographic compare. For<a name="line.46"></a>
-<span class="sourceLineNo">047</span> * example, if passed value is 'b' and
cell has 'a' and the compare operator<a name="line.47"></a>
-<span class="sourceLineNo">048</span> * is LESS, then we will filter out this
cell (return true). If this is not<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * sufficient (eg you want to deserialize
a long and then compare it to a fixed<a name="line.49"></a>
-<span class="sourceLineNo">050</span> * long value), then you can pass in your
own comparator instead.<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * <p><a name="line.51"></a>
-<span class="sourceLineNo">052</span> * You must also specify a family and
qualifier. Only the value of this column<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * will be tested. When using this filter
on a <a name="line.53"></a>
-<span class="sourceLineNo">054</span> * {@link
org.apache.hadoop.hbase.CellScanner} with specified<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * inputs, the column to be tested should
also be added as input (otherwise<a name="line.55"></a>
-<span class="sourceLineNo">056</span> * the filter will regard the column as
missing).<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * <p><a name="line.57"></a>
-<span class="sourceLineNo">058</span> * To prevent the entire row from being
emitted if the column is not found<a name="line.58"></a>
-<span class="sourceLineNo">059</span> * on a row, use {@link
#setFilterIfMissing}.<a name="line.59"></a>
-<span class="sourceLineNo">060</span> * Otherwise, if the column is found, the
entire row will be emitted only if<a name="line.60"></a>
-<span class="sourceLineNo">061</span> * the value passes. If the value fails,
the row will be filtered out.<a name="line.61"></a>
-<span class="sourceLineNo">062</span> * <p><a name="line.62"></a>
-<span class="sourceLineNo">063</span> * In order to test values of previous
versions (timestamps), set<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * {@link #setLatestVersionOnly} to
false. The default is true, meaning that<a name="line.64"></a>
-<span class="sourceLineNo">065</span> * only the latest version's value is
tested and all previous versions are ignored.<a name="line.65"></a>
-<span class="sourceLineNo">066</span> * <p><a name="line.66"></a>
-<span class="sourceLineNo">067</span> * To filter based on the value of all
scanned columns, use {@link ValueFilter}.<a name="line.67"></a>
-<span class="sourceLineNo">068</span> */<a name="line.68"></a>
-<span class="sourceLineNo">069</span>@InterfaceAudience.Public<a
name="line.69"></a>
-<span class="sourceLineNo">070</span>public class SingleColumnValueFilter
extends FilterBase {<a name="line.70"></a>
-<span class="sourceLineNo">071</span><a name="line.71"></a>
-<span class="sourceLineNo">072</span> protected byte [] columnFamily;<a
name="line.72"></a>
-<span class="sourceLineNo">073</span> protected byte [] columnQualifier;<a
name="line.73"></a>
-<span class="sourceLineNo">074</span> protected CompareOperator op;<a
name="line.74"></a>
-<span class="sourceLineNo">075</span> protected
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator;<a
name="line.75"></a>
-<span class="sourceLineNo">076</span> protected boolean foundColumn =
false;<a name="line.76"></a>
-<span class="sourceLineNo">077</span> protected boolean matchedColumn =
false;<a name="line.77"></a>
-<span class="sourceLineNo">078</span> protected boolean filterIfMissing =
false;<a name="line.78"></a>
-<span class="sourceLineNo">079</span> protected boolean latestVersionOnly =
true;<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> * Constructor for binary compare of
the value of a single column. If the<a name="line.82"></a>
-<span class="sourceLineNo">083</span> * column is found and the condition
passes, all columns of the row will be<a name="line.83"></a>
-<span class="sourceLineNo">084</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * <p><a name="line.85"></a>
-<span class="sourceLineNo">086</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.87"></a>
-<span class="sourceLineNo">088</span> * the row.<a name="line.88"></a>
-<span class="sourceLineNo">089</span> *<a name="line.89"></a>
-<span class="sourceLineNo">090</span> * @param family name of column
family<a name="line.90"></a>
-<span class="sourceLineNo">091</span> * @param qualifier name of column
qualifier<a name="line.91"></a>
-<span class="sourceLineNo">092</span> * @param compareOp operator<a
name="line.92"></a>
-<span class="sourceLineNo">093</span> * @param value value to compare column
values against<a name="line.93"></a>
-<span class="sourceLineNo">094</span> * @deprecated Since 2.0.0. Will be
removed in 3.0.0. Use<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * {@link
#SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[])} instead.<a
name="line.95"></a>
-<span class="sourceLineNo">096</span> */<a name="line.96"></a>
-<span class="sourceLineNo">097</span> @Deprecated<a name="line.97"></a>
-<span class="sourceLineNo">098</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.98"></a>
-<span class="sourceLineNo">099</span> final CompareOp compareOp, final
byte[] value) {<a name="line.99"></a>
-<span class="sourceLineNo">100</span> this(family, qualifier,
CompareOperator.valueOf(compareOp.name()),<a name="line.100"></a>
-<span class="sourceLineNo">101</span> new
org.apache.hadoop.hbase.filter.BinaryComparator(value));<a name="line.101"></a>
-<span class="sourceLineNo">102</span> }<a name="line.102"></a>
-<span class="sourceLineNo">103</span><a name="line.103"></a>
-<span class="sourceLineNo">104</span> /**<a name="line.104"></a>
-<span class="sourceLineNo">105</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.105"></a>
-<span class="sourceLineNo">106</span> * column is found and the condition
passes, all columns of the row will be<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.107"></a>
-<span class="sourceLineNo">108</span> * <p><a name="line.108"></a>
-<span class="sourceLineNo">109</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.109"></a>
-<span class="sourceLineNo">110</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.110"></a>
-<span class="sourceLineNo">111</span> * the row.<a name="line.111"></a>
-<span class="sourceLineNo">112</span> *<a name="line.112"></a>
-<span class="sourceLineNo">113</span> * @param family name of column
family<a name="line.113"></a>
-<span class="sourceLineNo">114</span> * @param qualifier name of column
qualifier<a name="line.114"></a>
-<span class="sourceLineNo">115</span> * @param op operator<a
name="line.115"></a>
-<span class="sourceLineNo">116</span> * @param value value to compare column
values against<a name="line.116"></a>
-<span class="sourceLineNo">117</span> */<a name="line.117"></a>
-<span class="sourceLineNo">118</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.118"></a>
-<span class="sourceLineNo">119</span> final
CompareOperator op, final byte[] value) {<a name="line.119"></a>
-<span class="sourceLineNo">120</span> this(family, qualifier, op,<a
name="line.120"></a>
-<span class="sourceLineNo">121</span> new
org.apache.hadoop.hbase.filter.BinaryComparator(value));<a name="line.121"></a>
-<span class="sourceLineNo">122</span> }<a name="line.122"></a>
-<span class="sourceLineNo">123</span><a name="line.123"></a>
-<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
-<span class="sourceLineNo">125</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.125"></a>
-<span class="sourceLineNo">126</span> * column is found and the condition
passes, all columns of the row will be<a name="line.126"></a>
-<span class="sourceLineNo">127</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.127"></a>
-<span class="sourceLineNo">128</span> * <p><a name="line.128"></a>
-<span class="sourceLineNo">129</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.129"></a>
-<span class="sourceLineNo">130</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.130"></a>
-<span class="sourceLineNo">131</span> * the row.<a name="line.131"></a>
-<span class="sourceLineNo">132</span> *<a name="line.132"></a>
-<span class="sourceLineNo">133</span> * @param family name of column
family<a name="line.133"></a>
-<span class="sourceLineNo">134</span> * @param qualifier name of column
qualifier<a name="line.134"></a>
-<span class="sourceLineNo">135</span> * @param compareOp operator<a
name="line.135"></a>
-<span class="sourceLineNo">136</span> * @param comparator Comparator to
use.<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * @deprecated Since 2.0.0. Will be
removed in 3.0.0. Use<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * {@link
#SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable)}
instead.<a name="line.138"></a>
-<span class="sourceLineNo">139</span> */<a name="line.139"></a>
-<span class="sourceLineNo">140</span> @Deprecated<a name="line.140"></a>
-<span class="sourceLineNo">141</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.141"></a>
-<span class="sourceLineNo">142</span> final CompareOp compareOp,<a
name="line.142"></a>
-<span class="sourceLineNo">143</span> final
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator) {<a
name="line.143"></a>
-<span class="sourceLineNo">144</span> this(family, qualifier,
CompareOperator.valueOf(compareOp.name()), comparator);<a name="line.144"></a>
-<span class="sourceLineNo">145</span> }<a name="line.145"></a>
-<span class="sourceLineNo">146</span><a name="line.146"></a>
-<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * column is found and the condition
passes, all columns of the row will be<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * <p><a name="line.151"></a>
-<span class="sourceLineNo">152</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.152"></a>
-<span class="sourceLineNo">153</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * the row.<a name="line.154"></a>
-<span class="sourceLineNo">155</span> *<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * @param family name of column
family<a name="line.156"></a>
-<span class="sourceLineNo">157</span> * @param qualifier name of column
qualifier<a name="line.157"></a>
-<span class="sourceLineNo">158</span> * @param op operator<a
name="line.158"></a>
-<span class="sourceLineNo">159</span> * @param comparator Comparator to
use.<a name="line.159"></a>
-<span class="sourceLineNo">160</span> */<a name="line.160"></a>
-<span class="sourceLineNo">161</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.161"></a>
-<span class="sourceLineNo">162</span> final CompareOperator op,<a
name="line.162"></a>
-<span class="sourceLineNo">163</span> final
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator) {<a
name="line.163"></a>
-<span class="sourceLineNo">164</span> this.columnFamily = family;<a
name="line.164"></a>
-<span class="sourceLineNo">165</span> this.columnQualifier = qualifier;<a
name="line.165"></a>
-<span class="sourceLineNo">166</span> this.op = op;<a name="line.166"></a>
-<span class="sourceLineNo">167</span> this.comparator = comparator;<a
name="line.167"></a>
-<span class="sourceLineNo">168</span> }<a name="line.168"></a>
-<span class="sourceLineNo">169</span><a name="line.169"></a>
-<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
-<span class="sourceLineNo">171</span> * Constructor for protobuf
deserialization only.<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * @param family<a name="line.172"></a>
-<span class="sourceLineNo">173</span> * @param qualifier<a
name="line.173"></a>
-<span class="sourceLineNo">174</span> * @param compareOp<a
name="line.174"></a>
-<span class="sourceLineNo">175</span> * @param comparator<a
name="line.175"></a>
-<span class="sourceLineNo">176</span> * @param filterIfMissing<a
name="line.176"></a>
-<span class="sourceLineNo">177</span> * @param latestVersionOnly<a
name="line.177"></a>
-<span class="sourceLineNo">178</span> * @deprecated Since 2.0.0. Will be
removed in 3.0.0. Use<a name="line.178"></a>
-<span class="sourceLineNo">179</span> * {@link
#SingleColumnValueFilter(byte[], byte[], CompareOperator,
ByteArrayComparable,<a name="line.179"></a>
-<span class="sourceLineNo">180</span> * boolean, boolean)} instead.<a
name="line.180"></a>
-<span class="sourceLineNo">181</span> */<a name="line.181"></a>
-<span class="sourceLineNo">182</span> @Deprecated<a name="line.182"></a>
-<span class="sourceLineNo">183</span> protected SingleColumnValueFilter(final
byte[] family, final byte[] qualifier,<a name="line.183"></a>
-<span class="sourceLineNo">184</span> final CompareOp compareOp,
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator,<a
name="line.184"></a>
-<span class="sourceLineNo">185</span> final boolean filterIfMissing,<a
name="line.185"></a>
-<span class="sourceLineNo">186</span> final boolean latestVersionOnly)
{<a name="line.186"></a>
-<span class="sourceLineNo">187</span> this(family, qualifier,
CompareOperator.valueOf(compareOp.name()), comparator, filterIfMissing,<a
name="line.187"></a>
-<span class="sourceLineNo">188</span> latestVersionOnly);<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> /**<a name="line.191"></a>
-<span class="sourceLineNo">192</span> * Constructor for protobuf
deserialization only.<a name="line.192"></a>
-<span class="sourceLineNo">193</span> * @param family<a name="line.193"></a>
-<span class="sourceLineNo">194</span> * @param qualifier<a
name="line.194"></a>
-<span class="sourceLineNo">195</span> * @param op<a name="line.195"></a>
-<span class="sourceLineNo">196</span> * @param comparator<a
name="line.196"></a>
-<span class="sourceLineNo">197</span> * @param filterIfMissing<a
name="line.197"></a>
-<span class="sourceLineNo">198</span> * @param latestVersionOnly<a
name="line.198"></a>
-<span class="sourceLineNo">199</span> */<a name="line.199"></a>
-<span class="sourceLineNo">200</span> protected SingleColumnValueFilter(final
byte[] family, final byte[] qualifier,<a name="line.200"></a>
-<span class="sourceLineNo">201</span> final CompareOperator op,
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator,<a
name="line.201"></a>
-<span class="sourceLineNo">202</span> final boolean filterIfMissing,
final boolean latestVersionOnly) {<a name="line.202"></a>
-<span class="sourceLineNo">203</span> this(family, qualifier, op,
comparator);<a name="line.203"></a>
-<span class="sourceLineNo">204</span> this.filterIfMissing =
filterIfMissing;<a name="line.204"></a>
-<span class="sourceLineNo">205</span> this.latestVersionOnly =
latestVersionOnly;<a name="line.205"></a>
-<span class="sourceLineNo">206</span> }<a name="line.206"></a>
-<span class="sourceLineNo">207</span><a name="line.207"></a>
-<span class="sourceLineNo">208</span> /**<a name="line.208"></a>
-<span class="sourceLineNo">209</span> * @return operator<a
name="line.209"></a>
-<span class="sourceLineNo">210</span> * @deprecated since 2.0.0. Will be
removed in 3.0.0. Use {@link #getCompareOperator()} instead.<a
name="line.210"></a>
-<span class="sourceLineNo">211</span> */<a name="line.211"></a>
-<span class="sourceLineNo">212</span> @Deprecated<a name="line.212"></a>
-<span class="sourceLineNo">213</span> public CompareOp getOperator() {<a
name="line.213"></a>
-<span class="sourceLineNo">214</span> return
CompareOp.valueOf(op.name());<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> public CompareOperator
getCompareOperator() {<a name="line.217"></a>
-<span class="sourceLineNo">218</span> return op;<a name="line.218"></a>
-<span class="sourceLineNo">219</span> }<a name="line.219"></a>
-<span class="sourceLineNo">220</span><a name="line.220"></a>
-<span class="sourceLineNo">221</span> /**<a name="line.221"></a>
-<span class="sourceLineNo">222</span> * @return the comparator<a
name="line.222"></a>
-<span class="sourceLineNo">223</span> */<a name="line.223"></a>
-<span class="sourceLineNo">224</span> public
org.apache.hadoop.hbase.filter.ByteArrayComparable getComparator() {<a
name="line.224"></a>
-<span class="sourceLineNo">225</span> return comparator;<a
name="line.225"></a>
-<span class="sourceLineNo">226</span> }<a name="line.226"></a>
-<span class="sourceLineNo">227</span><a name="line.227"></a>
-<span class="sourceLineNo">228</span> /**<a name="line.228"></a>
-<span class="sourceLineNo">229</span> * @return the family<a
name="line.229"></a>
-<span class="sourceLineNo">230</span> */<a name="line.230"></a>
-<span class="sourceLineNo">231</span> public byte[] getFamily() {<a
name="line.231"></a>
-<span class="sourceLineNo">232</span> return columnFamily;<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> /**<a name="line.235"></a>
-<span class="sourceLineNo">236</span> * @return the qualifier<a
name="line.236"></a>
-<span class="sourceLineNo">237</span> */<a name="line.237"></a>
-<span class="sourceLineNo">238</span> public byte[] getQualifier() {<a
name="line.238"></a>
-<span class="sourceLineNo">239</span> return columnQualifier;<a
name="line.239"></a>
-<span class="sourceLineNo">240</span> }<a name="line.240"></a>
-<span class="sourceLineNo">241</span><a name="line.241"></a>
-<span class="sourceLineNo">242</span> @Override<a name="line.242"></a>
-<span class="sourceLineNo">243</span> public boolean filterRowKey(Cell cell)
throws IOException {<a name="line.243"></a>
-<span class="sourceLineNo">244</span> // Impl in FilterBase might do
unnecessary copy for Off heap backed Cells.<a name="line.244"></a>
-<span class="sourceLineNo">245</span> return false;<a name="line.245"></a>
-<span class="sourceLineNo">246</span> }<a name="line.246"></a>
-<span class="sourceLineNo">247</span><a name="line.247"></a>
-<span class="sourceLineNo">248</span> @Deprecated<a name="line.248"></a>
-<span class="sourceLineNo">249</span> @Override<a name="line.249"></a>
-<span class="sourceLineNo">250</span> public ReturnCode filterKeyValue(final
Cell c) {<a name="line.250"></a>
-<span class="sourceLineNo">251</span> return filterCell(c);<a
name="line.251"></a>
-<span class="sourceLineNo">252</span> }<a name="line.252"></a>
-<span class="sourceLineNo">253</span><a name="line.253"></a>
-<span class="sourceLineNo">254</span> @Override<a name="line.254"></a>
-<span class="sourceLineNo">255</span> public ReturnCode filterCell(final Cell
c) {<a name="line.255"></a>
-<span class="sourceLineNo">256</span> // System.out.println("REMOVE KEY=" +
keyValue.toString() + ", value=" + Bytes.toString(keyValue.getValue()));<a
name="line.256"></a>
-<span class="sourceLineNo">257</span> if (this.matchedColumn) {<a
name="line.257"></a>
-<span class="sourceLineNo">258</span> // We already found and matched the
single column, all keys now pass<a name="line.258"></a>
-<span class="sourceLineNo">259</span> return ReturnCode.INCLUDE;<a
name="line.259"></a>
-<span class="sourceLineNo">260</span> } else if (this.latestVersionOnly
&& this.foundColumn) {<a name="line.260"></a>
-<span class="sourceLineNo">261</span> // We found but did not match the
single column, skip to next row<a name="line.261"></a>
-<span class="sourceLineNo">262</span> return ReturnCode.NEXT_ROW;<a
name="line.262"></a>
-<span class="sourceLineNo">263</span> }<a name="line.263"></a>
-<span class="sourceLineNo">264</span> if (!CellUtil.matchingColumn(c,
this.columnFamily, this.columnQualifier)) {<a name="line.264"></a>
-<span class="sourceLineNo">265</span> return ReturnCode.INCLUDE;<a
name="line.265"></a>
-<span class="sourceLineNo">266</span> }<a name="line.266"></a>
-<span class="sourceLineNo">267</span> foundColumn = true;<a
name="line.267"></a>
-<span class="sourceLineNo">268</span> if (filterColumnValue(c)) {<a
name="line.268"></a>
-<span class="sourceLineNo">269</span> return this.latestVersionOnly?
ReturnCode.NEXT_ROW: ReturnCode.INCLUDE;<a name="line.269"></a>
-<span class="sourceLineNo">270</span> }<a name="line.270"></a>
-<span class="sourceLineNo">271</span> this.matchedColumn = true;<a
name="line.271"></a>
-<span class="sourceLineNo">272</span> return ReturnCode.INCLUDE;<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> private boolean filterColumnValue(final
Cell cell) {<a name="line.275"></a>
-<span class="sourceLineNo">276</span> int compareResult =
CellUtil.compareValue(cell, this.comparator);<a name="line.276"></a>
-<span class="sourceLineNo">277</span> return CompareFilter.compare(this.op,
compareResult);<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> public boolean filterRow() {<a
name="line.280"></a>
-<span class="sourceLineNo">281</span> // If column was found, return false
if it was matched, true if it was not<a name="line.281"></a>
-<span class="sourceLineNo">282</span> // If column not found, return true
if we filter if missing, false if not<a name="line.282"></a>
-<span class="sourceLineNo">283</span> return this.foundColumn?
!this.matchedColumn: this.filterIfMissing;<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> public boolean hasFilterRow() {<a
name="line.286"></a>
-<span class="sourceLineNo">287</span> return true;<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> public void reset() {<a
name="line.290"></a>
-<span class="sourceLineNo">291</span> foundColumn = false;<a
name="line.291"></a>
-<span class="sourceLineNo">292</span> matchedColumn = false;<a
name="line.292"></a>
-<span class="sourceLineNo">293</span> }<a name="line.293"></a>
-<span class="sourceLineNo">294</span><a name="line.294"></a>
-<span class="sourceLineNo">295</span> /**<a name="line.295"></a>
-<span class="sourceLineNo">296</span> * Get whether entire row should be
filtered if column is not found.<a name="line.296"></a>
-<span class="sourceLineNo">297</span> * @return true if row should be
skipped if column not found, false if row<a name="line.297"></a>
-<span class="sourceLineNo">298</span> * should be let through anyways<a
name="line.298"></a>
-<span class="sourceLineNo">299</span> */<a name="line.299"></a>
-<span class="sourceLineNo">300</span> public boolean getFilterIfMissing() {<a
name="line.300"></a>
-<span class="sourceLineNo">301</span> return filterIfMissing;<a
name="line.301"></a>
-<span class="sourceLineNo">302</span> }<a name="line.302"></a>
-<span class="sourceLineNo">303</span><a name="line.303"></a>
-<span class="sourceLineNo">304</span> /**<a name="line.304"></a>
-<span class="sourceLineNo">305</span> * Set whether entire row should be
filtered if column is not found.<a name="line.305"></a>
-<span class="sourceLineNo">306</span> * <p><a name="line.306"></a>
-<span class="sourceLineNo">307</span> * If true, the entire row will be
skipped if the column is not found.<a name="line.307"></a>
-<span class="sourceLineNo">308</span> * <p><a name="line.308"></a>
-<span class="sourceLineNo">309</span> * If false, the row will pass if the
column is not found. This is default.<a name="line.309"></a>
-<span class="sourceLineNo">310</span> * @param filterIfMissing flag<a
name="line.310"></a>
-<span class="sourceLineNo">311</span> */<a name="line.311"></a>
-<span class="sourceLineNo">312</span> public void setFilterIfMissing(boolean
filterIfMissing) {<a name="line.312"></a>
-<span class="sourceLineNo">313</span> this.filterIfMissing =
filterIfMissing;<a name="line.313"></a>
-<span class="sourceLineNo">314</span> }<a name="line.314"></a>
-<span class="sourceLineNo">315</span><a name="line.315"></a>
-<span class="sourceLineNo">316</span> /**<a name="line.316"></a>
-<span class="sourceLineNo">317</span> * Get whether only the latest version
of the column value should be compared.<a name="line.317"></a>
-<span class="sourceLineNo">318</span> * If true, the row will be returned if
only the latest version of the column<a name="line.318"></a>
-<span class="sourceLineNo">319</span> * value matches. If false, the row
will be returned if any version of the<a name="line.319"></a>
-<span class="sourceLineNo">320</span> * column value matches. The default is
true.<a name="line.320"></a>
-<span class="sourceLineNo">321</span> * @return return value<a
name="line.321"></a>
-<span class="sourceLineNo">322</span> */<a name="line.322"></a>
-<span class="sourceLineNo">323</span> public boolean getLatestVersionOnly()
{<a name="line.323"></a>
-<span class="sourceLineNo">324</span> return latestVersionOnly;<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> /**<a name="line.327"></a>
-<span class="sourceLineNo">328</span> * Set whether only the latest version
of the column value should be compared.<a name="line.328"></a>
-<span class="sourceLineNo">329</span> * If true, the row will be returned if
only the latest version of the column<a name="line.329"></a>
-<span class="sourceLineNo">330</span> * value matches. If false, the row
will be returned if any version of the<a name="line.330"></a>
-<span class="sourceLineNo">331</span> * column value matches. The default is
true.<a name="line.331"></a>
-<span class="sourceLineNo">332</span> * @param latestVersionOnly flag<a
name="line.332"></a>
-<span class="sourceLineNo">333</span> */<a name="line.333"></a>
-<span class="sourceLineNo">334</span> public void
setLatestVersionOnly(boolean latestVersionOnly) {<a name="line.334"></a>
-<span class="sourceLineNo">335</span> this.latestVersionOnly =
latestVersionOnly;<a name="line.335"></a>
-<span class="sourceLineNo">336</span> }<a name="line.336"></a>
-<span class="sourceLineNo">337</span><a name="line.337"></a>
-<span class="sourceLineNo">338</span> public static Filter
createFilterFromArguments(ArrayList<byte []> filterArguments) {<a
name="line.338"></a>
-<span class="sourceLineNo">339</span>
Preconditions.checkArgument(filterArguments.size() == 4 ||
filterArguments.size() == 6,<a name="line.339"></a>
-<span class="sourceLineNo">340</span> "Expected
4 or 6 but got: %s", filterArguments.size());<a name="line.340"></a>
-<span class="sourceLineNo">341</span> byte [] family =
ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a
name="line.341"></a>
-<span class="sourceLineNo">342</span> byte [] qualifier =
ParseFilter.removeQuotesFromByteArray(filterArguments.get(1));<a
name="line.342"></a>
-<span class="sourceLineNo">343</span> CompareOperator op =
ParseFilter.createCompareOperator(filterArguments.get(2));<a
name="line.343"></a>
-<span class="sourceLineNo">344</span>
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator =
ParseFilter.createComparator(<a name="line.344"></a>
-<span class="sourceLineNo">345</span>
ParseFilter.removeQuotesFromByteArray(filterArguments.get(3)));<a
name="line.345"></a>
-<span class="sourceLineNo">346</span><a name="line.346"></a>
-<span class="sourceLineNo">347</span> if (comparator instanceof
RegexStringComparator ||<a name="line.347"></a>
-<span class="sourceLineNo">348</span> comparator instanceof
SubstringComparator) {<a name="line.348"></a>
-<span class="sourceLineNo">349</span> if (op != CompareOperator.EQUAL
&&<a name="line.349"></a>
-<span class="sourceLineNo">350</span> op !=
CompareOperator.NOT_EQUAL) {<a name="line.350"></a>
-<span class="sourceLineNo">351</span> throw new
IllegalArgumentException ("A regexstring comparator and substring comparator "
+<a name="line.351"></a>
-<span class="sourceLineNo">352</span>
"can only be used with EQUAL and NOT_EQUAL");<a name="line.352"></a>
-<span class="sourceLineNo">353</span> }<a name="line.353"></a>
-<span class="sourceLineNo">354</span> }<a name="line.354"></a>
-<span class="sourceLineNo">355</span><a name="line.355"></a>
-<span class="sourceLineNo">356</span> SingleColumnValueFilter filter = new
SingleColumnValueFilter(family, qualifier,<a name="line.356"></a>
-<span class="sourceLineNo">357</span>
op, comparator);<a name="line.357"></a>
-<span class="sourceLineNo">358</span><a name="line.358"></a>
-<span class="sourceLineNo">359</span> if (filterArguments.size() == 6) {<a
name="line.359"></a>
-<span class="sourceLineNo">360</span> boolean filterIfMissing =
ParseFilter.convertByteArrayToBoolean(filterArguments.get(4));<a
name="line.360"></a>
-<span class="sourceLineNo">361</span> boolean latestVersionOnly =
ParseFilter.convertByteArrayToBoolean(filterArguments.get(5));<a
name="line.361"></a>
-<span class="sourceLineNo">362</span>
filter.setFilterIfMissing(filterIfMissing);<a name="line.362"></a>
-<span class="sourceLineNo">363</span>
filter.setLatestVersionOnly(latestVersionOnly);<a name="line.363"></a>
-<span class="sourceLineNo">364</span> }<a name="line.364"></a>
-<span class="sourceLineNo">365</span> return filter;<a name="line.365"></a>
-<span class="sourceLineNo">366</span> }<a name="line.366"></a>
-<span class="sourceLineNo">367</span><a name="line.367"></a>
-<span class="sourceLineNo">368</span> FilterProtos.SingleColumnValueFilter
convert() {<a name="line.368"></a>
-<span class="sourceLineNo">369</span>
FilterProtos.SingleColumnValueFilter.Builder builder =<a name="line.369"></a>
-<span class="sourceLineNo">370</span>
FilterProtos.SingleColumnValueFilter.newBuilder();<a name="line.370"></a>
-<span class="sourceLineNo">371</span> if (this.columnFamily != null) {<a
name="line.371"></a>
-<span class="sourceLineNo">372</span>
builder.setColumnFamily(UnsafeByteOperations.unsafeWrap(this.columnFamily));<a
name="line.372"></a>
-<span class="sourceLineNo">373</span> }<a name="line.373"></a>
-<span class="sourceLineNo">374</span> if (this.columnQualifier != null) {<a
name="line.374"></a>
-<span class="sourceLineNo">375</span>
builder.setColumnQualifier(UnsafeByteOperations.unsafeWrap(this.columnQualifier));<a
name="line.375"></a>
-<span class="sourceLineNo">376</span> }<a name="line.376"></a>
-<span class="sourceLineNo">377</span> HBaseProtos.CompareType compareOp =
CompareType.valueOf(this.op.name());<a name="line.377"></a>
-<span class="sourceLineNo">378</span> builder.setCompareOp(compareOp);<a
name="line.378"></a>
-<span class="sourceLineNo">379</span>
builder.setComparator(ProtobufUtil.toComparator(this.comparator));<a
name="line.379"></a>
-<span class="sourceLineNo">380</span>
builder.setFilterIfMissing(this.filterIfMissing);<a name="line.380"></a>
-<span class="sourceLineNo">381</span>
builder.setLatestVersionOnly(this.latestVersionOnly);<a name="line.381"></a>
-<span class="sourceLineNo">382</span><a name="line.382"></a>
-<span class="sourceLineNo">383</span> return builder.build();<a
name="line.383"></a>
-<span class="sourceLineNo">384</span> }<a name="line.384"></a>
-<span class="sourceLineNo">385</span><a name="line.385"></a>
-<span class="sourceLineNo">386</span> /**<a name="line.386"></a>
-<span class="sourceLineNo">387</span> * @return The filter serialized using
pb<a name="line.387"></a>
-<span class="sourceLineNo">388</span> */<a name="line.388"></a>
-<span class="sourceLineNo">389</span> public byte [] toByteArray() {<a
name="line.389"></a>
-<span class="sourceLineNo">390</span> return convert().toByteArray();<a
name="line.390"></a>
-<span class="sourceLineNo">391</span> }<a name="line.391"></a>
-<span class="sourceLineNo">392</span><a name="line.392"></a>
-<span class="sourceLineNo">393</span> /**<a name="line.393"></a>
-<span class="sourceLineNo">394</span> * @param pbBytes A pb serialized
{@link SingleColumnValueFilter} instance<a name="line.394"></a>
-<span class="sourceLineNo">395</span> * @return An instance of {@link
SingleColumnValueFilter} made from <code>bytes</code><a
name="line.395"></a>
-<span class="sourceLineNo">396</span> * @throws
org.apache.hadoop.hbase.exceptions.DeserializationException<a
name="line.396"></a>
-<span class="sourceLineNo">397</span> * @see #toByteArray<a
name="line.397"></a>
-<span class="sourceLineNo">398</span> */<a name="line.398"></a>
-<span class="sourceLineNo">399</span> public static SingleColumnValueFilter
parseFrom(final byte [] pbBytes)<a name="line.399"></a>
-<span class="sourceLineNo">400</span> throws DeserializationException {<a
name="line.400"></a>
-<span class="sourceLineNo">401</span> FilterProtos.SingleColumnValueFilter
proto;<a name="line.401"></a>
-<span class="sourceLineNo">402</span> try {<a name="line.402"></a>
-<span class="sourceLineNo">403</span> proto =
FilterProtos.SingleColumnValueFilter.parseFrom(pbBytes);<a name="line.403"></a>
-<span class="sourceLineNo">404</span> } catch
(InvalidProtocolBufferException e) {<a name="line.404"></a>
-<span class="sourceLineNo">405</span> throw new
DeserializationException(e);<a name="line.405"></a>
-<span class="sourceLineNo">406</span> }<a name="line.406"></a>
-<span class="sourceLineNo">407</span><a name="line.407"></a>
-<span class="sourceLineNo">408</span> final CompareOperator compareOp =<a
name="line.408"></a>
-<span class="sourceLineNo">409</span>
CompareOperator.valueOf(proto.getCompareOp().name());<a name="line.409"></a>
-<span class="sourceLineNo">410</span> final
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator;<a
name="line.410"></a>
-<span class="sourceLineNo">411</span> try {<a name="line.411"></a>
-<span class="sourceLineNo">412</span> comparator =
ProtobufUtil.toComparator(proto.getComparator());<a name="line.412"></a>
-<span class="sourceLineNo">413</span> } catch (IOException ioe) {<a
name="line.413"></a>
-<span class="sourceLineNo">414</span> throw new
DeserializationException(ioe);<a name="line.414"></a>
-<span class="sourceLineNo">415</span> }<a name="line.415"></a>
-<span class="sourceLineNo">416</span><a name="line.416"></a>
-<span class="sourceLineNo">417</span> return new
SingleColumnValueFilter(proto.hasColumnFamily() ? proto.getColumnFamily()<a
name="line.417"></a>
-<span class="sourceLineNo">418</span> .toByteArray() : null,
proto.hasColumnQualifier() ? proto.getColumnQualifier()<a name="line.418"></a>
-<span class="sourceLineNo">419</span> .toByteArray() : null, compareOp,
comparator, proto.getFilterIfMissing(), proto<a name="line.419"></a>
-<span class="sourceLineNo">420</span> .getLatestVersionOnly());<a
name="line.420"></a>
-<span class="sourceLineNo">421</span> }<a name="line.421"></a>
-<span class="sourceLineNo">422</span><a name="line.422"></a>
-<span class="sourceLineNo">423</span> /**<a name="line.423"></a>
-<span class="sourceLineNo">424</span> * @return true if and only if the
fields of the filter that are serialized<a name="line.424"></a>
-<span class="sourceLineNo">425</span> * are equal to the corresponding
fields in other. Used for testing.<a name="line.425"></a>
-<span class="sourceLineNo">426</span> */<a name="line.426"></a>
-<span class="sourceLineNo">427</span> boolean areSerializedFieldsEqual(Filter
o) {<a name="line.427"></a>
-<span class="sourceLineNo">428</span> if (o == this) return true;<a
name="line.428"></a>
-<span class="sourceLineNo">429</span> if (!(o instanceof
SingleColumnValueFilter)) return false;<a name="line.429"></a>
-<span class="sourceLineNo">430</span><a name="line.430"></a>
-<span class="sourceLineNo">431</span> SingleColumnValueFilter other =
(SingleColumnValueFilter)o;<a name="line.431"></a>
-<span class="sourceLineNo">432</span> return Bytes.equals(this.getFamily(),
other.getFamily())<a name="line.432"></a>
-<span class="sourceLineNo">433</span> &&
Bytes.equals(this.getQualifier(), other.getQualifier())<a name="line.433"></a>
-<span class="sourceLineNo">434</span> &&
this.op.equals(other.op)<a name="line.434"></a>
-<span class="sourceLineNo">435</span> &&
this.getComparator().areSerializedFieldsEqual(other.getComparator())<a
name="line.435"></a>
-<span class="sourceLineNo">436</span> &&
this.getFilterIfMissing() == other.getFilterIfMissing()<a name="line.436"></a>
-<span class="sourceLineNo">437</span> &&
this.getLatestVersionOnly() == other.getLatestVersionOnly();<a
name="line.437"></a>
-<span class="sourceLineNo">438</span> }<a name="line.438"></a>
-<span class="sourceLineNo">439</span><a name="line.439"></a>
-<span class="sourceLineNo">440</span> /**<a name="line.440"></a>
-<span class="sourceLineNo">441</span> * The only CF this filter needs is
given column family. So, it's the only essential<a name="line.441"></a>
-<span class="sourceLineNo">442</span> * column in whole scan. If
filterIfMissing == false, all families are essential,<a name="line.442"></a>
-<span class="sourceLineNo">443</span> * because of possibility of skipping
the rows without any data in filtered CF.<a name="line.443"></a>
-<span class="sourceLineNo">444</span> */<a name="line.444"></a>
-<span class="sourceLineNo">445</span> public boolean isFamilyEssential(byte[]
name) {<a name="line.445"></a>
-<span class="sourceLineNo">446</span> return !this.filterIfMissing ||
Bytes.equals(name, this.columnFamily);<a name="line.446"></a>
-<span class="sourceLineNo">447</span> }<a name="line.447"></a>
-<span class="sourceLineNo">448</span><a name="line.448"></a>
-<span class="sourceLineNo">449</span> @Override<a name="line.449"></a>
-<span class="sourceLineNo">450</span> public String toString() {<a
name="line.450"></a>
-<span class="sourceLineNo">451</span> return String.format("%s (%s, %s, %s,
%s)",<a name="line.451"></a>
-<span class="sourceLineNo">452</span> this.getClass().getSimpleName(),
Bytes.toStringBinary(this.columnFamily),<a name="line.452"></a>
-<span class="sourceLineNo">453</span>
Bytes.toStringBinary(this.columnQualifier), this.op.name(),<a
name="line.453"></a>
-<span class="sourceLineNo">454</span>
Bytes.toStringBinary(this.comparator.getValue()));<a name="line.454"></a>
-<span class="sourceLineNo">455</span> }<a name="line.455"></a>
-<span class="sourceLineNo">456</span>}<a name="line.456"></a>
+<span class="sourceLineNo">028</span>import
org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import
org.apache.yetus.audience.InterfaceAudience;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import
org.apache.hadoop.hbase.exceptions.DeserializationException;<a
name="line.30"></a>
+<span class="sourceLineNo">031</span>import
org.apache.hadoop.hbase.filter.CompareFilter.CompareOp;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import
org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferException;<a
name="line.32"></a>
+<span class="sourceLineNo">033</span>import
org.apache.hadoop.hbase.shaded.com.google.protobuf.UnsafeByteOperations;<a
name="line.33"></a>
+<span class="sourceLineNo">034</span>import
org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import
org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a
name="line.35"></a>
+<span class="sourceLineNo">036</span>import
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;<a
name="line.36"></a>
+<span class="sourceLineNo">037</span>import
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.CompareType;<a
name="line.37"></a>
+<span class="sourceLineNo">038</span>import
org.apache.hadoop.hbase.util.Bytes;<a name="line.38"></a>
+<span class="sourceLineNo">039</span><a name="line.39"></a>
+<span class="sourceLineNo">040</span>import
org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a
name="line.40"></a>
+<span class="sourceLineNo">041</span><a name="line.41"></a>
+<span class="sourceLineNo">042</span>/**<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * This filter is used to filter cells
based on value. It takes a {@link CompareFilter.CompareOp}<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * operator (equal, greater, not equal,
etc), and either a byte [] value or<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * a ByteArrayComparable.<a
name="line.45"></a>
+<span class="sourceLineNo">046</span> * <p><a name="line.46"></a>
+<span class="sourceLineNo">047</span> * If we have a byte [] value then we
just do a lexicographic compare. For<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * example, if passed value is 'b' and
cell has 'a' and the compare operator<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * is LESS, then we will filter out this
cell (return true). If this is not<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * sufficient (eg you want to deserialize
a long and then compare it to a fixed<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * long value), then you can pass in your
own comparator instead.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * <p><a name="line.52"></a>
+<span class="sourceLineNo">053</span> * You must also specify a family and
qualifier. Only the value of this column<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * will be tested. When using this filter
on a <a name="line.54"></a>
+<span class="sourceLineNo">055</span> * {@link
org.apache.hadoop.hbase.CellScanner} with specified<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * inputs, the column to be tested should
also be added as input (otherwise<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * the filter will regard the column as
missing).<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * <p><a name="line.58"></a>
+<span class="sourceLineNo">059</span> * To prevent the entire row from being
emitted if the column is not found<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * on a row, use {@link
#setFilterIfMissing}.<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * Otherwise, if the column is found, the
entire row will be emitted only if<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * the value passes. If the value fails,
the row will be filtered out.<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * <p><a name="line.63"></a>
+<span class="sourceLineNo">064</span> * In order to test values of previous
versions (timestamps), set<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * {@link #setLatestVersionOnly} to
false. The default is true, meaning that<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * only the latest version's value is
tested and all previous versions are ignored.<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * <p><a name="line.67"></a>
+<span class="sourceLineNo">068</span> * To filter based on the value of all
scanned columns, use {@link ValueFilter}.<a name="line.68"></a>
+<span class="sourceLineNo">069</span> */<a name="line.69"></a>
+<span class="sourceLineNo">070</span>@InterfaceAudience.Public<a
name="line.70"></a>
+<span class="sourceLineNo">071</span>public class SingleColumnValueFilter
extends FilterBase {<a name="line.71"></a>
+<span class="sourceLineNo">072</span><a name="line.72"></a>
+<span class="sourceLineNo">073</span> protected byte [] columnFamily;<a
name="line.73"></a>
+<span class="sourceLineNo">074</span> protected byte [] columnQualifier;<a
name="line.74"></a>
+<span class="sourceLineNo">075</span> protected CompareOperator op;<a
name="line.75"></a>
+<span class="sourceLineNo">076</span> protected
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator;<a
name="line.76"></a>
+<span class="sourceLineNo">077</span> protected boolean foundColumn =
false;<a name="line.77"></a>
+<span class="sourceLineNo">078</span> protected boolean matchedColumn =
false;<a name="line.78"></a>
+<span class="sourceLineNo">079</span> protected boolean filterIfMissing =
false;<a name="line.79"></a>
+<span class="sourceLineNo">080</span> protected boolean latestVersionOnly =
true;<a name="line.80"></a>
+<span class="sourceLineNo">081</span><a name="line.81"></a>
+<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * column is found and the condition
passes, all columns of the row will be<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * <p><a name="line.86"></a>
+<span class="sourceLineNo">087</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * the row.<a name="line.89"></a>
+<span class="sourceLineNo">090</span> *<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * @param family name of column
family<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * @param qualifier name of column
qualifier<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * @param compareOp operator<a
name="line.93"></a>
+<span class="sourceLineNo">094</span> * @param value value to compare column
values against<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * @deprecated Since 2.0.0. Will be
removed in 3.0.0. Use<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * {@link
#SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[])} instead.<a
name="line.96"></a>
+<span class="sourceLineNo">097</span> */<a name="line.97"></a>
+<span class="sourceLineNo">098</span> @Deprecated<a name="line.98"></a>
+<span class="sourceLineNo">099</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.99"></a>
+<span class="sourceLineNo">100</span> final CompareOp compareOp, final
byte[] value) {<a name="line.100"></a>
+<span class="sourceLineNo">101</span> this(family, qualifier,
CompareOperator.valueOf(compareOp.name()),<a name="line.101"></a>
+<span class="sourceLineNo">102</span> new
org.apache.hadoop.hbase.filter.BinaryComparator(value));<a name="line.102"></a>
+<span class="sourceLineNo">103</span> }<a name="line.103"></a>
+<span class="sourceLineNo">104</span><a name="line.104"></a>
+<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * column is found and the condition
passes, all columns of the row will be<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * <p><a name="line.109"></a>
+<span class="sourceLineNo">110</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * the row.<a name="line.112"></a>
+<span class="sourceLineNo">113</span> *<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * @param family name of column
family<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * @param qualifier name of column
qualifier<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * @param op operator<a
name="line.116"></a>
+<span class="sourceLineNo">117</span> * @param value value to compare column
values against<a name="line.117"></a>
+<span class="sourceLineNo">118</span> */<a name="line.118"></a>
+<span class="sourceLineNo">119</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.119"></a>
+<span class="sourceLineNo">120</span> final
CompareOperator op, final byte[] value) {<a name="line.120"></a>
+<span class="sourceLineNo">121</span> this(family, qualifier, op,<a
name="line.121"></a>
+<span class="sourceLineNo">122</span> new
org.apache.hadoop.hbase.filter.BinaryComparator(value));<a name="line.122"></a>
+<span class="sourceLineNo">123</span> }<a name="line.123"></a>
+<span class="sourceLineNo">124</span><a name="line.124"></a>
+<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * column is found and the condition
passes, all columns of the row will be<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * <p><a name="line.129"></a>
+<span class="sourceLineNo">130</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * the row.<a name="line.132"></a>
+<span class="sourceLineNo">133</span> *<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * @param family name of column
family<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * @param qualifier name of column
qualifier<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * @param compareOp operator<a
name="line.136"></a>
+<span class="sourceLineNo">137</span> * @param comparator Comparator to
use.<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * @deprecated Since 2.0.0. Will be
removed in 3.0.0. Use<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * {@link
#SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable)}
instead.<a name="line.139"></a>
+<span class="sourceLineNo">140</span> */<a name="line.140"></a>
+<span class="sourceLineNo">141</span> @Deprecated<a name="line.141"></a>
+<span class="sourceLineNo">142</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.142"></a>
+<span class="sourceLineNo">143</span> final CompareOp compareOp,<a
name="line.143"></a>
+<span class="sourceLineNo">144</span> final
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator) {<a
name="line.144"></a>
+<span class="sourceLineNo">145</span> this(family, qualifier,
CompareOperator.valueOf(compareOp.name()), comparator);<a name="line.145"></a>
+<span class="sourceLineNo">146</span> }<a name="line.146"></a>
+<span class="sourceLineNo">147</span><a name="line.147"></a>
+<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
+<span class="sourceLineNo">149</span> * Constructor for binary compare of
the value of a single column. If the<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * column is found and the condition
passes, all columns of the row will be<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * emitted. If the condition fails,
the row will not be emitted.<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * <p><a name="line.152"></a>
+<span class="sourceLineNo">153</span> * Use the filterIfColumnMissing flag
to set whether the rest of the columns<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * in a row will be emitted if the
specified column to check is not found in<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * the row.<a name="line.155"></a>
+<span class="sourceLineNo">156</span> *<a name="line.156"></a>
+<span class="sourceLineNo">157</span> * @param family name of column
family<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * @param qualifier name of column
qualifier<a name="line.158"></a>
+<span class="sourceLineNo">159</span> * @param op operator<a
name="line.159"></a>
+<span class="sourceLineNo">160</span> * @param comparator Comparator to
use.<a name="line.160"></a>
+<span class="sourceLineNo">161</span> */<a name="line.161"></a>
+<span class="sourceLineNo">162</span> public SingleColumnValueFilter(final
byte [] family, final byte [] qualifier,<a name="line.162"></a>
+<span class="sourceLineNo">163</span> final CompareOperator op,<a
name="line.163"></a>
+<span class="sourceLineNo">164</span> final
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator) {<a
name="line.164"></a>
+<span class="sourceLineNo">165</span> this.columnFamily = family;<a
name="line.165"></a>
+<span class="sourceLineNo">166</span> this.columnQualifier = qualifier;<a
name="line.166"></a>
+<span class="sourceLineNo">167</span> this.op = op;<a name="line.167"></a>
+<span class="sourceLineNo">168</span> this.comparator = comparator;<a
name="line.168"></a>
+<span class="sourceLineNo">169</span> }<a name="line.169"></a>
+<span class="sourceLineNo">170</span><a name="line.170"></a>
+<span class="sourceLineNo">171</span> /**<a name="line.171"></a>
+<span class="sourceLineNo">172</span> * Constructor for protobuf
deserialization only.<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * @param family<a name="line.173"></a>
+<span class="sourceLineNo">174</span> * @param qualifier<a
name="line.174"></a>
+<span class="sourceLineNo">175</span> * @param compareOp<a
name="line.175"></a>
+<span class="sourceLineNo">176</span> * @param comparator<a
name="line.176"></a>
+<span class="sourceLineNo">177</span> * @param filterIfMissing<a
name="line.177"></a>
+<span class="sourceLineNo">178</span> * @param latestVersionOnly<a
name="line.178"></a>
+<span class="sourceLineNo">179</span> * @deprecated Since 2.0.0. Will be
removed in 3.0.0. Use<a name="line.179"></a>
+<span class="sourceLineNo">180</span> * {@link
#SingleColumnValueFilter(byte[], byte[], CompareOperator,
ByteArrayComparable,<a name="line.180"></a>
+<span class="sourceLineNo">181</span> * boolean, boolean)} instead.<a
name="line.181"></a>
+<span class="sourceLineNo">182</span> */<a name="line.182"></a>
+<span class="sourceLineNo">183</span> @Deprecated<a name="line.183"></a>
+<span class="sourceLineNo">184</span> protected SingleColumnValueFilter(final
byte[] family, final byte[] qualifier,<a name="line.184"></a>
+<span class="sourceLineNo">185</span> final CompareOp compareOp,
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator,<a
name="line.185"></a>
+<span class="sourceLineNo">186</span> final boolean filterIfMissing,<a
name="line.186"></a>
+<span class="sourceLineNo">187</span> final boolean latestVersionOnly)
{<a name="line.187"></a>
+<span class="sourceLineNo">188</span> this(family, qualifier,
CompareOperator.valueOf(compareOp.name()), comparator, filterIfMissing,<a
name="line.188"></a>
+<span class="sourceLineNo">189</span> latestVersionOnly);<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> * Constructor for protobuf
deserialization only.<a name="line.193"></a>
+<span class="sourceLineNo">194</span> * @param family<a name="line.194"></a>
+<span class="sourceLineNo">195</span> * @param qualifier<a
name="line.195"></a>
+<span class="sourceLineNo">196</span> * @param op<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * @param comparator<a
name="line.197"></a>
+<span class="sourceLineNo">198</span> * @param filterIfMissing<a
name="line.198"></a>
+<span class="sourceLineNo">199</span> * @param latestVersionOnly<a
name="line.199"></a>
+<span class="sourceLineNo">200</span> */<a name="line.200"></a>
+<span class="sourceLineNo">201</span> protected SingleColumnValueFilter(final
byte[] family, final byte[] qualifier,<a name="line.201"></a>
+<span class="sourceLineNo">202</span> final CompareOperator op,
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator,<a
name="line.202"></a>
+<span class="sourceLineNo">203</span> final boolean filterIfMissing,
final boolean latestVersionOnly) {<a name="line.203"></a>
+<span class="sourceLineNo">204</span> this(family, qualifier, op,
comparator);<a name="line.204"></a>
+<span class="sourceLineNo">205</span> this.filterIfMissing =
filterIfMissing;<a name="line.205"></a>
+<span class="sourceLineNo">206</span> this.latestVersionOnly =
latestVersionOnly;<a name="line.206"></a>
+<span class="sourceLineNo">207</span> }<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> * @return operator<a
name="line.210"></a>
+<span class="sourceLineNo">211</span> * @deprecated since 2.0.0. Will be
removed in 3.0.0. Use {@link #getCompareOperator()} instead.<a
name="line.211"></a>
+<span class="sourceLineNo">212</span> */<a name="line.212"></a>
+<span class="sourceLineNo">213</span> @Deprecated<a name="line.213"></a>
+<span class="sourceLineNo">214</span> public CompareOp getOperator() {<a
name="line.214"></a>
+<span class="sourceLineNo">215</span> return
CompareOp.valueOf(op.name());<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> public CompareOperator
getCompareOperator() {<a name="line.218"></a>
+<span class="sourceLineNo">219</span> return op;<a name="line.219"></a>
+<span class="sourceLineNo">220</span> }<a name="line.220"></a>
+<span class="sourceLineNo">221</span><a name="line.221"></a>
+<span class="sourceLineNo">222</span> /**<a name="line.222"></a>
+<span class="sourceLineNo">223</span> * @return the comparator<a
name="line.223"></a>
+<span class="sourceLineNo">224</span> */<a name="line.224"></a>
+<span class="sourceLineNo">225</span> public
org.apache.hadoop.hbase.filter.ByteArrayComparable getComparator() {<a
name="line.225"></a>
+<span class="sourceLineNo">226</span> return comparator;<a
name="line.226"></a>
+<span class="sourceLineNo">227</span> }<a name="line.227"></a>
+<span class="sourceLineNo">228</span><a name="line.228"></a>
+<span class="sourceLineNo">229</span> /**<a name="line.229"></a>
+<span class="sourceLineNo">230</span> * @return the family<a
name="line.230"></a>
+<span class="sourceLineNo">231</span> */<a name="line.231"></a>
+<span class="sourceLineNo">232</span> public byte[] getFamily() {<a
name="line.232"></a>
+<span class="sourceLineNo">233</span> return columnFamily;<a
name="line.233"></a>
+<span class="sourceLineNo">234</span> }<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> * @return the qualifier<a
name="line.237"></a>
+<span class="sourceLineNo">238</span> */<a name="line.238"></a>
+<span class="sourceLineNo">239</span> public byte[] getQualifier() {<a
name="line.239"></a>
+<span class="sourceLineNo">240</span> return columnQualifier;<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> @Override<a name="line.243"></a>
+<span class="sourceLineNo">244</span> public boolean filterRowKey(Cell cell)
throws IOException {<a name="line.244"></a>
+<span class="sourceLineNo">245</span> // Impl in FilterBase might do
unnecessary copy for Off heap backed Cells.<a name="line.245"></a>
+<span class="sourceLineNo">246</span> return false;<a name="line.246"></a>
+<span class="sourceLineNo">247</span> }<a name="line.247"></a>
+<span class="sourceLineNo">248</span><a name="line.248"></a>
+<span class="sourceLineNo">249</span> @Deprecated<a name="line.249"></a>
+<span class="sourceLineNo">250</span> @Override<a name="line.250"></a>
+<span class="sourceLineNo">251</span> public ReturnCode filterKeyValue(final
Cell c) {<a name="line.251"></a>
+<span class="sourceLineNo">252</span> return filterCell(c);<a
name="line.252"></a>
+<span class="sourceLineNo">253</span> }<a name="line.253"></a>
+<span class="sourceLineNo">254</span><a name="line.254"></a>
+<span class="sourceLineNo">255</span> @Override<a name="line.255"></a>
+<span class="sourceLineNo">256</span> public ReturnCode filterCell(final Cell
c) {<a name="line.256"></a>
+<span class="sourceLineNo">257</span> // System.out.println("REMOVE KEY=" +
keyValue.toString() + ", value=" + Bytes.toString(keyValue.getValue()));<a
name="line.257"></a>
+<span class="sourceLineNo">258</span> if (this.matchedColumn) {<a
name="line.258"></a>
+<span class="sourceLineNo">259</span> // We already found and matched the
single column, all keys now pass<a name="line.259"></a>
+<span class="sourceLineNo">260</span> return ReturnCode.INCLUDE;<a
name="line.260"></a>
+<span class="sourceLineNo">261</span> } else if (this.latestVersionOnly
&& this.foundColumn) {<a name="line.261"></a>
+<span class="sourceLineNo">262</span> // We found but did not match the
single column, skip to next row<a name="line.262"></a>
+<span class="sourceLineNo">263</span> return ReturnCode.NEXT_ROW;<a
name="line.263"></a>
+<span class="sourceLineNo">264</span> }<a name="line.264"></a>
+<span class="sourceLineNo">265</span> if (!CellUtil.matchingColumn(c,
this.columnFamily, this.columnQualifier)) {<a name="line.265"></a>
+<span class="sourceLineNo">266</span> return ReturnCode.INCLUDE;<a
name="line.266"></a>
+<span class="sourceLineNo">267</span> }<a name="line.267"></a>
+<span class="sourceLineNo">268</span> foundColumn = true;<a
name="line.268"></a>
+<span class="sourceLineNo">269</span> if (filterColumnValue(c)) {<a
name="line.269"></a>
+<span class="sourceLineNo">270</span> return this.latestVersionOnly?
ReturnCode.NEXT_ROW: ReturnCode.INCLUDE;<a name="line.270"></a>
+<span class="sourceLineNo">271</span> }<a name="line.271"></a>
+<span class="sourceLineNo">272</span> this.matchedColumn = true;<a
name="line.272"></a>
+<span class="sourceLineNo">273</span> return ReturnCode.INCLUDE;<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> private boolean filterColumnValue(final
Cell cell) {<a name="line.276"></a>
+<span class="sourceLineNo">277</span> int compareResult =
PrivateCellUtil.compareValue(cell, this.comparator);<a name="line.277"></a>
+<span class="sourceLineNo">278</span> return CompareFilter.compare(this.op,
compareResult);<a name="line.278"></a>
+<span class="sourceLineNo">279</span> }<a name="line.279"></a>
+<span class="sourceLineNo">280</span><a name="line.280"></a>
+<span class="sourceLineNo">281</span> public boolean filterRow() {<a
name="line.281"></a>
+<span class="sourceLineNo">282</span> // If column was found, return false
if it was matched, true if it was not<a name="line.282"></a>
+<span class="sourceLineNo">283</span> // If column not found, return true
if we filter if missing, false if not<a name="line.283"></a>
+<span class="sourceLineNo">284</span> return this.foundColumn?
!this.matchedColumn: this.filterIfMissing;<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> public boolean hasFilterRow() {<a
name="line.287"></a>
+<span class="sourceLineNo">288</span> return true;<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">291</span> public void reset() {<a
name="line.291"></a>
+<span class="sourceLineNo">292</span> foundColumn = false;<a
name="line.292"></a>
+<span class="sourceLineNo">293</span> matchedColumn = false;<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> /**<a name="line.296"></a>
+<span class="sourceLineNo">297</span> * Get whether entire row should be
filtered if column is not found.<a name="line.297"></a>
+<span class="sourceLineNo">298</span> * @return true if row should be
skipped if column not found, false if row<a name="line.298"></a>
+<span class="sourceLineNo">299</span> * should be let through anyways<a
name="line.299"></a>
+<span class="sourceLineNo">300</span> */<a name="line.300"></a>
+<span class="sourceLineNo">301</span> public boolean getFilterIfMissing() {<a
name="line.301"></a>
+<span class="sourceLineNo">302</span> return filterIfMissing;<a
name="line.302"></a>
+<span class="sourceLineNo">303</span> }<a name="line.303"></a>
+<span class="sourceLineNo">304</span><a name="line.304"></a>
+<span class="sourceLineNo">305</span> /**<a name="line.305"></a>
+<span class="sourceLineNo">306</span> * Set whether entire row should be
filtered if column is not found.<a name="line.306"></a>
+<span class="sourceLineNo">307</span> * <p><a name="line.307"></a>
+<span class="sourceLineNo">308</span> * If true, the entire row will be
skipped if the column is not found.<a name="line.308"></a>
+<span class="sourceLineNo">309</span> * <p><a name="line.309"></a>
+<span class="sourceLineNo">310</span> * If false, the row will pass if the
column is not found. This is default.<a name="line.310"></a>
+<span class="sourceLineNo">311</span> * @param filterIfMissing flag<a
name="line.311"></a>
+<span class="sourceLineNo">312</span> */<a name="line.312"></a>
+<span class="sourceLineNo">313</span> public void setFilterIfMissing(boolean
filterIfMissing) {<a name="line.313"></a>
+<span class="sourceLineNo">314</span> this.filterIfMissing =
filterIfMissing;<a name="line.314"></a>
+<span class="sourceLineNo">315</span> }<a name="line.315"></a>
+<span class="sourceLineNo">316</span><a name="line.316"></a>
+<span class="sourceLineNo">317</span> /**<a name="line.317"></a>
+<span class="sourceLineNo">318</span> * Get whether only the latest version
of the column value should be compared.<a name="line.318"></a>
+<span class="sourceLineNo">319</span> * If true, the row will be returned if
only the latest version of the column<a name="line.319"></a>
+<span class="sourceLineNo">320</span> * value matches. If false, the row
will be returned if any version of the<a name="line.320"></a>
+<span class="sourceLineNo">321</span> * column value matches. The default is
true.<a name="line.321"></a>
+<span class="sourceLineNo">322</span> * @return return value<a
name="line.322"></a>
+<span class="sourceLineNo">323</span> */<a name="line.323"></a>
+<span class="sourceLineNo">324</span> public boolean getLatestVersionOnly()
{<a name="line.324"></a>
+<span class="sourceLineNo">325</span> return latestVersionOnly;<a
name="line.325"></a>
+<span class="sourceLineNo">326</span> }<a name="line.326"></a>
+<span class="sourceLineNo">327</span><a name="line.327"></a>
+<span class="sourceLineNo">328</span> /**<a name="line.328"></a>
+<span class="sourceLineNo">329</span> * Set whether only the latest version
of the column value should be compared.<a name="line.329"></a>
+<span class="sourceLineNo">330</span> * If true, the row will be returned if
only the latest version of the column<a name="line.330"></a>
+<span class="sourceLineNo">331</span> * value matches. If false, the row
will be returned if any version of the<a name="line.331"></a>
+<span class="sourceLineNo">332</span> * column value matches. The default is
true.<a name="line.332"></a>
+<span class="sourceLineNo">333</span> * @param latestVersionOnly flag<a
name="line.333"></a>
+<span class="sourceLineNo">334</span> */<a name="line.334"></a>
+<span class="sourceLineNo">335</span> public void
setLatestVersionOnly(boolean latestVersionOnly) {<a name="line.335"></a>
+<span class="sourceLineNo">336</span> this.latestVersionOnly =
latestVersionOnly;<a name="line.336"></a>
+<span class="sourceLineNo">337</span> }<a name="line.337"></a>
+<span class="sourceLineNo">338</span><a name="line.338"></a>
+<span class="sourceLineNo">339</span> public static Filter
createFilterFromArguments(ArrayList<byte []> filterArguments) {<a
name="line.339"></a>
+<span class="sourceLineNo">340</span>
Preconditions.checkArgument(filterArguments.size() == 4 ||
filterArguments.size() == 6,<a name="line.340"></a>
+<span class="sourceLineNo">341</span> "Expected
4 or 6 but got: %s", filterArguments.size());<a name="line.341"></a>
+<span class="sourceLineNo">342</span> byte [] family =
ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a
name="line.342"></a>
+<span class="sourceLineNo">343</span> byte [] qualifier =
ParseFilter.removeQuotesFromByteArray(filterArguments.get(1));<a
name="line.343"></a>
+<span class="sourceLineNo">344</span> CompareOperator op =
ParseFilter.createCompareOperator(filterArguments.get(2));<a
name="line.344"></a>
+<span class="sourceLineNo">345</span>
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator =
ParseFilter.createComparator(<a name="line.345"></a>
+<span class="sourceLineNo">346</span>
ParseFilter.removeQuotesFromByteArray(filterArguments.get(3)));<a
name="line.346"></a>
+<span class="sourceLineNo">347</span><a name="line.347"></a>
+<span class="sourceLineNo">348</span> if (comparator instanceof
RegexStringComparator ||<a name="line.348"></a>
+<span class="sourceLineNo">349</span> comparator instanceof
SubstringComparator) {<a name="line.349"></a>
+<span class="sourceLineNo">350</span> if (op != CompareOperator.EQUAL
&&<a name="line.350"></a>
+<span class="sourceLineNo">351</span> op !=
CompareOperator.NOT_EQUAL) {<a name="line.351"></a>
+<span class="sourceLineNo">352</span> throw new
IllegalArgumentException ("A regexstring comparator and substring comparator "
+<a name="line.352"></a>
+<span class="sourceLineNo">353</span>
"can only be used with EQUAL and NOT_EQUAL");<a name="line.353"></a>
+<span class="sourceLineNo">354</span> }<a name="line.354"></a>
+<span class="sourceLineNo">355</span> }<a name="line.355"></a>
+<span class="sourceLineNo">356</span><a name="line.356"></a>
+<span class="sourceLineNo">357</span> SingleColumnValueFilter filter = new
SingleColumnValueFilter(family, qualifier,<a name="line.357"></a>
+<span class="sourceLineNo">358</span>
op, comparator);<a name="line.358"></a>
+<span class="sourceLineNo">359</span><a name="line.359"></a>
+<span class="sourceLineNo">360</span> if (filterArguments.size() == 6) {<a
name="line.360"></a>
+<span class="sourceLineNo">361</span> boolean filterIfMissing =
ParseFilter.convertByteArrayToBoolean(filterArguments.get(4));<a
name="line.361"></a>
+<span class="sourceLineNo">362</span> boolean latestVersionOnly =
ParseFilter.convertByteArrayToBoolean(filterArguments.get(5));<a
name="line.362"></a>
+<span class="sourceLineNo">363</span>
filter.setFilterIfMissing(filterIfMissing);<a name="line.363"></a>
+<span class="sourceLineNo">364</span>
filter.setLatestVersionOnly(latestVersionOnly);<a name="line.364"></a>
+<span class="sourceLineNo">365</span> }<a name="line.365"></a>
+<span class="sourceLineNo">366</span> return filter;<a name="line.366"></a>
+<span class="sourceLineNo">367</span> }<a name="line.367"></a>
+<span class="sourceLineNo">368</span><a name="line.368"></a>
+<span class="sourceLineNo">369</span> FilterProtos.SingleColumnValueFilter
convert() {<a name="line.369"></a>
+<span class="sourceLineNo">370</span>
FilterProtos.SingleColumnValueFilter.Builder builder =<a name="line.370"></a>
+<span class="sourceLineNo">371</span>
FilterProtos.SingleColumnValueFilter.newBuilder();<a name="line.371"></a>
+<span class="sourceLineNo">372</span> if (this.columnFamily != null) {<a
name="line.372"></a>
+<span class="sourceLineNo">373</span>
builder.setColumnFamily(UnsafeByteOperations.unsafeWrap(this.columnFamily));<a
name="line.373"></a>
+<span class="sourceLineNo">374</span> }<a name="line.374"></a>
+<span class="sourceLineNo">375</span> if (this.columnQualifier != null) {<a
name="line.375"></a>
+<span class="sourceLineNo">376</span>
builder.setColumnQualifier(UnsafeByteOperations.unsafeWrap(this.columnQualifier));<a
name="line.376"></a>
+<span class="sourceLineNo">377</span> }<a name="line.377"></a>
+<span class="sourceLineNo">378</span> HBaseProtos.CompareType compareOp =
CompareType.valueOf(this.op.name());<a name="line.378"></a>
+<span class="sourceLineNo">379</span> builder.setCompareOp(compareOp);<a
name="line.379"></a>
+<span class="sourceLineNo">380</span>
builder.setComparator(ProtobufUtil.toComparator(this.comparator));<a
name="line.380"></a>
+<span class="sourceLineNo">381</span>
builder.setFilterIfMissing(this.filterIfMissing);<a name="line.381"></a>
+<span class="sourceLineNo">382</span>
builder.setLatestVersionOnly(this.latestVersionOnly);<a name="line.382"></a>
+<span class="sourceLineNo">383</span><a name="line.383"></a>
+<span class="sourceLineNo">384</span> return builder.build();<a
name="line.384"></a>
+<span class="sourceLineNo">385</span> }<a name="line.385"></a>
+<span class="sourceLineNo">386</span><a name="line.386"></a>
+<span class="sourceLineNo">387</span> /**<a name="line.387"></a>
+<span class="sourceLineNo">388</span> * @return The filter serialized using
pb<a name="line.388"></a>
+<span class="sourceLineNo">389</span> */<a name="line.389"></a>
+<span class="sourceLineNo">390</span> public byte [] toByteArray() {<a
name="line.390"></a>
+<span class="sourceLineNo">391</span> return convert().toByteArray();<a
name="line.391"></a>
+<span class="sourceLineNo">392</span> }<a name="line.392"></a>
+<span class="sourceLineNo">393</span><a name="line.393"></a>
+<span class="sourceLineNo">394</span> /**<a name="line.394"></a>
+<span class="sourceLineNo">395</span> * @param pbBytes A pb serialized
{@link SingleColumnValueFilter} instance<a name="line.395"></a>
+<span class="sourceLineNo">396</span> * @return An instance of {@link
SingleColumnValueFilter} made from <code>bytes</code><a
name="line.396"></a>
+<span class="sourceLineNo">397</span> * @throws
org.apache.hadoop.hbase.exceptions.DeserializationException<a
name="line.397"></a>
+<span class="sourceLineNo">398</span> * @see #toByteArray<a
name="line.398"></a>
+<span class="sourceLineNo">399</span> */<a name="line.399"></a>
+<span class="sourceLineNo">400</span> public static SingleColumnValueFilter
parseFrom(final byte [] pbBytes)<a name="line.400"></a>
+<span class="sourceLineNo">401</span> throws DeserializationException {<a
name="line.401"></a>
+<span class="sourceLineNo">402</span> FilterProtos.SingleColumnValueFilter
proto;<a name="line.402"></a>
+<span class="sourceLineNo">403</span> try {<a name="line.403"></a>
+<span class="sourceLineNo">404</span> proto =
FilterProtos.SingleColumnValueFilter.parseFrom(pbBytes);<a name="line.404"></a>
+<span class="sourceLineNo">405</span> } catch
(InvalidProtocolBufferException e) {<a name="line.405"></a>
+<span class="sourceLineNo">406</span> throw new
DeserializationException(e);<a name="line.406"></a>
+<span class="sourceLineNo">407</span> }<a name="line.407"></a>
+<span class="sourceLineNo">408</span><a name="line.408"></a>
+<span class="sourceLineNo">409</span> final CompareOperator compareOp =<a
name="line.409"></a>
+<span class="sourceLineNo">410</span>
CompareOperator.valueOf(proto.getCompareOp().name());<a name="line.410"></a>
+<span class="sourceLineNo">411</span> final
org.apache.hadoop.hbase.filter.ByteArrayComparable comparator;<a
name="line.411"></a>
+<span class="sourceLineNo">412</span> try {<a name="line.412"></a>
+<span class="sourceLineNo">413</span> comparator =
ProtobufUtil.toComparator(proto.getComparator());<a name="line.413"></a>
+<span class="sourceLineNo">414</span> } catch (IOException ioe) {<a
name="line.414"></a>
+<span class="sourceLineNo">415</span> throw new
DeserializationException(ioe);<a name="line.415"></a>
+<span class="sourceLineNo">416</span> }<a name="line.416"></a>
+<span class="sourceLineNo">417</span><a name="line.417"></a>
+<span class="sourceLineNo">418</span> return new
SingleColumnValueFilter(proto.hasColumnFamily() ? proto.getColumnFamily()<a
name="line.418"></a>
+<span class="sourceLineNo">419</span> .toByteArray() : null,
proto.hasColumnQualifier() ? proto.getColumnQualifier()<a name="line.419"></a>
+<span class="sourceLineNo">420</span> .toByteArray() : null, compareOp,
comparator, proto.getFilterIfMissing(), proto<a name="line.420"></a>
+<span class="sourceLineNo">421</span> .getLatestVersionOnly());<a
name="line.421"></a>
+<span class="sourceLineNo">422</span> }<a name="line.422"></a>
+<span class="sourceLineNo">423</span><a name="line.423"></a>
+<span class="sourceLineNo">424</span> /**<a name="line.424"></a>
+<span class="sourceLineNo">425</span> * @return true if and only if the
fields of the filter that are serialized<a name="line.425"></a>
+<span class="sourceLineNo">426</span> * are equal to the corresponding
fields in other. Used for testing.<a name="line.426"></a>
+<span class="sourceLineNo">427</span> */<a name="line.427"></a>
+<span class="sourceLineNo">428</span> boolean areSerializedFieldsEqual(Filter
o) {<a name="line.428"></a>
+<span class="sourceLineNo">429</span> if (o == this) return true;<a
name="line.429"></a>
+<span class="sourceLineNo">430</span> if (!(o instanceof
SingleColumnValueFilter)) return false;<a name="line.430"></a>
+<span class="sourceLineNo">431</span><a name="line.431"></a>
+<span class="sourceLineNo">432</span> SingleColumnValueFilter other =
(SingleColumnValueFilter)o;<a name="line.432"></a>
+<span class="sourceLineNo">433</span> return Bytes.equals(this.getFamily(),
other.getFamily())<a name="line.433"></a>
+<span class="sourceLineNo">434</span> &&
Bytes.equals(this.getQualifier(), other.getQualifier())<a name="line.434"></a>
+<span class="sourceLineNo">435</span> &&
this.op.equals(other.op)<a name="line.435"></a>
+<span class="sourceLineNo">436</span> &&
this.getComparator().areSerializedFieldsEqual(other.getComparator())<a
name="line.436"></a>
+<span class="sourceLineNo">437</span> &&
this.getFilterIfMissing() == other.getFilterIfMissing()<a name="line.437"></a>
+<span class="sourceLineNo">438</span> &&
this.getLatestVersionOnly() == other.getLatestVersionOnly();<a
name="line.438"></a>
+<span class="sourceLineNo">439</span> }<a name="line.439"></a>
+<span class="sourceLineNo">440</span><a name="line.440"></a>
+<span class="sourceLineNo">441</span> /**<a name="line.441"></a>
+<span class="sourceLineNo">442</span> * The only CF this filter needs is
given column family. So, it's the only essential<a name="line.442"></a>
+<span class="sourceLineNo">443</span> * column in whole scan. If
filterIfMissing == false, all families are essential,<a name="line.443"></a>
+<span class="sourceLineNo">444</span> * because of possibility of skipping
the rows without any data in filtered CF.<a name="line.444"></a>
+<span class="sourceLineNo">445</span> */<a name="line.445"></a>
+<span class="sourceLineNo">446</span> public boolean isFamilyEssential(byte[]
name) {<a name="line.446"></a>
+<span class="sourceLineNo">447</span> return !this.filterIfMissing ||
Bytes.equals(name, this.columnFamily);<a name="line.447"></a>
+<span class="sourceLineNo">448</span> }<a name="line.448"></a>
+<span class="sourceLineNo">449</span><a name="line.449"></a>
+<span class="sourceLineNo">450</span> @Override<a name="line.450"></a>
+<span class="sourceLineNo">451</span> public String toString() {<a
name="line.451"></a>
+<span class="sourceLineNo">452</span> return String.format("%s (%s, %s, %s,
%s)",<a name="line.452"></a>
+<span class="sourceLineNo">453</span> this.getClass().getSimpleName(),
Bytes.toStringBinary(this.columnFamily),<a name="line.453"></a>
+<span class="sourceLineNo">454</span>
Bytes.toStringBinary(this.columnQualifier), this.op.name(),<a
name="line.454"></a>
+<span class="sourceLineNo">455</span>
Bytes.toStringBinary(this.comparator.getValue()));<a name="line.455"></a>
+<span class="sourceLineNo">456</span> }<a name="line.456"></a>
+<span class="sourceLineNo">457</span>}<a name="line.457"></a>