hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From git-site-r...@apache.org
Subject [40/51] [partial] hbase-site git commit: Published site at a452487a9b82bfd33bc10683c3f8b8ae74d58883.
Date Fri, 24 Aug 2018 14:47:54 GMT
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/0cf79db0/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html
----------------------------------------------------------------------
diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html
index ee5595f..961079a 100644
--- a/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html
+++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html
@@ -29,224 +29,240 @@
 <span class="sourceLineNo">021</span><a name="line.21"></a>
 <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
 <span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a>
-<span class="sourceLineNo">024</span><a name="line.24"></a>
-<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.hadoop.hbase.PrivateCellUtil;<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.util.Bytes;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.31"></a>
-<span class="sourceLineNo">032</span><a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.34"></a>
-<span class="sourceLineNo">035</span>import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;<a name="line.35"></a>
-<span class="sourceLineNo">036</span><a name="line.36"></a>
-<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.37"></a>
-<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.38"></a>
-<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;<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> * Different from {@link SingleColumnValueFilter} which returns an &lt;b&gt;entire&lt;/b&gt; row<a name="line.42"></a>
-<span class="sourceLineNo">043</span> * when specified condition is matched, {@link ColumnValueFilter} return the matched cell only.<a name="line.43"></a>
-<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
-<span class="sourceLineNo">045</span> * This filter is used to filter cells based on column and value.<a name="line.45"></a>
-<span class="sourceLineNo">046</span> * It takes a {@link org.apache.hadoop.hbase.CompareOperator} operator (&lt;, &lt;=, =, !=, &gt;, &gt;=), and<a name="line.46"></a>
-<span class="sourceLineNo">047</span> * and a {@link ByteArrayComparable} comparator.<a name="line.47"></a>
-<span class="sourceLineNo">048</span> */<a name="line.48"></a>
-<span class="sourceLineNo">049</span>@InterfaceAudience.Public<a name="line.49"></a>
-<span class="sourceLineNo">050</span>public class ColumnValueFilter extends FilterBase {<a name="line.50"></a>
-<span class="sourceLineNo">051</span>  private final byte[] family;<a name="line.51"></a>
-<span class="sourceLineNo">052</span>  private final byte[] qualifier;<a name="line.52"></a>
-<span class="sourceLineNo">053</span>  private final CompareOperator op;<a name="line.53"></a>
-<span class="sourceLineNo">054</span>  private final ByteArrayComparable comparator;<a name="line.54"></a>
-<span class="sourceLineNo">055</span><a name="line.55"></a>
-<span class="sourceLineNo">056</span>  // This flag is used to speed up seeking cells when matched column is found, such that following<a name="line.56"></a>
-<span class="sourceLineNo">057</span>  // columns in the same row can be skipped faster by NEXT_ROW instead of NEXT_COL.<a name="line.57"></a>
-<span class="sourceLineNo">058</span>  private boolean columnFound = false;<a name="line.58"></a>
-<span class="sourceLineNo">059</span><a name="line.59"></a>
-<span class="sourceLineNo">060</span>  public ColumnValueFilter(final byte[] family, final byte[] qualifier,<a name="line.60"></a>
-<span class="sourceLineNo">061</span>                           final CompareOperator op, final byte[] value) {<a name="line.61"></a>
-<span class="sourceLineNo">062</span>    this(family, qualifier, op, new BinaryComparator(value));<a name="line.62"></a>
-<span class="sourceLineNo">063</span>  }<a name="line.63"></a>
-<span class="sourceLineNo">064</span><a name="line.64"></a>
-<span class="sourceLineNo">065</span>  public ColumnValueFilter(final byte[] family, final byte[] qualifier,<a name="line.65"></a>
-<span class="sourceLineNo">066</span>                           final CompareOperator op,<a name="line.66"></a>
-<span class="sourceLineNo">067</span>                           final ByteArrayComparable comparator) {<a name="line.67"></a>
-<span class="sourceLineNo">068</span>    this.family = Preconditions.checkNotNull(family, "family should not be null.");<a name="line.68"></a>
-<span class="sourceLineNo">069</span>    this.qualifier = qualifier == null ? new byte[0] : qualifier;<a name="line.69"></a>
-<span class="sourceLineNo">070</span>    this.op = Preconditions.checkNotNull(op, "CompareOperator should not be null");<a name="line.70"></a>
-<span class="sourceLineNo">071</span>    this.comparator = Preconditions.checkNotNull(comparator, "Comparator should not be null");<a name="line.71"></a>
-<span class="sourceLineNo">072</span>  }<a name="line.72"></a>
-<span class="sourceLineNo">073</span><a name="line.73"></a>
-<span class="sourceLineNo">074</span>  /**<a name="line.74"></a>
-<span class="sourceLineNo">075</span>   * @return operator<a name="line.75"></a>
-<span class="sourceLineNo">076</span>   */<a name="line.76"></a>
-<span class="sourceLineNo">077</span>  public CompareOperator getCompareOperator() {<a name="line.77"></a>
-<span class="sourceLineNo">078</span>    return op;<a name="line.78"></a>
-<span class="sourceLineNo">079</span>  }<a name="line.79"></a>
-<span class="sourceLineNo">080</span><a name="line.80"></a>
-<span class="sourceLineNo">081</span>  /**<a name="line.81"></a>
-<span class="sourceLineNo">082</span>   * @return the comparator<a name="line.82"></a>
-<span class="sourceLineNo">083</span>   */<a name="line.83"></a>
-<span class="sourceLineNo">084</span>  public ByteArrayComparable getComparator() {<a name="line.84"></a>
-<span class="sourceLineNo">085</span>    return comparator;<a name="line.85"></a>
-<span class="sourceLineNo">086</span>  }<a name="line.86"></a>
-<span class="sourceLineNo">087</span><a name="line.87"></a>
-<span class="sourceLineNo">088</span>  /**<a name="line.88"></a>
-<span class="sourceLineNo">089</span>   * @return the column family<a name="line.89"></a>
-<span class="sourceLineNo">090</span>   */<a name="line.90"></a>
-<span class="sourceLineNo">091</span>  public byte[] getFamily() {<a name="line.91"></a>
-<span class="sourceLineNo">092</span>    return family;<a name="line.92"></a>
-<span class="sourceLineNo">093</span>  }<a name="line.93"></a>
-<span class="sourceLineNo">094</span><a name="line.94"></a>
-<span class="sourceLineNo">095</span>  /**<a name="line.95"></a>
-<span class="sourceLineNo">096</span>   * @return the qualifier<a name="line.96"></a>
-<span class="sourceLineNo">097</span>   */<a name="line.97"></a>
-<span class="sourceLineNo">098</span>  public byte[] getQualifier() {<a name="line.98"></a>
-<span class="sourceLineNo">099</span>    return qualifier;<a name="line.99"></a>
-<span class="sourceLineNo">100</span>  }<a name="line.100"></a>
-<span class="sourceLineNo">101</span><a name="line.101"></a>
-<span class="sourceLineNo">102</span>  @Override<a name="line.102"></a>
-<span class="sourceLineNo">103</span>  public void reset() throws IOException {<a name="line.103"></a>
-<span class="sourceLineNo">104</span>    columnFound = false;<a name="line.104"></a>
-<span class="sourceLineNo">105</span>  }<a name="line.105"></a>
-<span class="sourceLineNo">106</span><a name="line.106"></a>
-<span class="sourceLineNo">107</span>  @Override<a name="line.107"></a>
-<span class="sourceLineNo">108</span>  public boolean filterRowKey(Cell cell) throws IOException {<a name="line.108"></a>
-<span class="sourceLineNo">109</span>    return false;<a name="line.109"></a>
-<span class="sourceLineNo">110</span>  }<a name="line.110"></a>
-<span class="sourceLineNo">111</span><a name="line.111"></a>
-<span class="sourceLineNo">112</span>  @Override<a name="line.112"></a>
-<span class="sourceLineNo">113</span>  public ReturnCode filterCell(Cell c) throws IOException {<a name="line.113"></a>
-<span class="sourceLineNo">114</span>    // 1. Check column match<a name="line.114"></a>
-<span class="sourceLineNo">115</span>    if (!CellUtil.matchingColumn(c, this.family, this.qualifier)) {<a name="line.115"></a>
-<span class="sourceLineNo">116</span>      return columnFound ? ReturnCode.NEXT_ROW : ReturnCode.NEXT_COL;<a name="line.116"></a>
-<span class="sourceLineNo">117</span>    }<a name="line.117"></a>
-<span class="sourceLineNo">118</span>    // Column found<a name="line.118"></a>
-<span class="sourceLineNo">119</span>    columnFound = true;<a name="line.119"></a>
-<span class="sourceLineNo">120</span>    // 2. Check value match:<a name="line.120"></a>
-<span class="sourceLineNo">121</span>    // True means filter out, just skip this cell, else include it.<a name="line.121"></a>
-<span class="sourceLineNo">122</span>    return compareValue(getCompareOperator(), getComparator(), c) ?<a name="line.122"></a>
-<span class="sourceLineNo">123</span>      ReturnCode.SKIP : ReturnCode.INCLUDE;<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>  /**<a name="line.126"></a>
-<span class="sourceLineNo">127</span>   * This method is used to determine a cell should be included or filtered out.<a name="line.127"></a>
-<span class="sourceLineNo">128</span>   * @param op one of operators {@link CompareOperator}<a name="line.128"></a>
-<span class="sourceLineNo">129</span>   * @param comparator comparator used to compare cells.<a name="line.129"></a>
-<span class="sourceLineNo">130</span>   * @param cell cell to be compared.<a name="line.130"></a>
-<span class="sourceLineNo">131</span>   * @return true means cell should be filtered out, included otherwise.<a name="line.131"></a>
-<span class="sourceLineNo">132</span>   */<a name="line.132"></a>
-<span class="sourceLineNo">133</span>  private boolean compareValue(final CompareOperator op, final ByteArrayComparable comparator,<a name="line.133"></a>
-<span class="sourceLineNo">134</span>    final Cell cell) {<a name="line.134"></a>
-<span class="sourceLineNo">135</span>    if (op == CompareOperator.NO_OP) {<a name="line.135"></a>
-<span class="sourceLineNo">136</span>      return true;<a name="line.136"></a>
-<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
-<span class="sourceLineNo">138</span>    int compareResult = PrivateCellUtil.compareValue(cell, comparator);<a name="line.138"></a>
-<span class="sourceLineNo">139</span>    return CompareFilter.compare(op, compareResult);<a name="line.139"></a>
-<span class="sourceLineNo">140</span>  }<a name="line.140"></a>
-<span class="sourceLineNo">141</span><a name="line.141"></a>
-<span class="sourceLineNo">142</span>  /**<a name="line.142"></a>
-<span class="sourceLineNo">143</span>   * Creating this filter by reflection, it is used by {@link ParseFilter},<a name="line.143"></a>
-<span class="sourceLineNo">144</span>   * @param filterArguments arguments for creating a ColumnValueFilter<a name="line.144"></a>
-<span class="sourceLineNo">145</span>   * @return a ColumnValueFilter<a name="line.145"></a>
-<span class="sourceLineNo">146</span>   */<a name="line.146"></a>
-<span class="sourceLineNo">147</span>  public static Filter createFilterFromArguments(ArrayList&lt;byte[]&gt; filterArguments) {<a name="line.147"></a>
-<span class="sourceLineNo">148</span>    Preconditions.checkArgument(filterArguments.size() == 4,<a name="line.148"></a>
-<span class="sourceLineNo">149</span>      "Expect 4 arguments: %s", filterArguments.size());<a name="line.149"></a>
-<span class="sourceLineNo">150</span>    byte[] family = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a name="line.150"></a>
-<span class="sourceLineNo">151</span>    byte[] qualifier = ParseFilter.removeQuotesFromByteArray(filterArguments.get(1));<a name="line.151"></a>
-<span class="sourceLineNo">152</span>    CompareOperator operator = ParseFilter.createCompareOperator(filterArguments.get(2));<a name="line.152"></a>
-<span class="sourceLineNo">153</span>    ByteArrayComparable comparator =<a name="line.153"></a>
-<span class="sourceLineNo">154</span>      ParseFilter.createComparator(ParseFilter.removeQuotesFromByteArray(filterArguments.get(3)));<a name="line.154"></a>
-<span class="sourceLineNo">155</span><a name="line.155"></a>
-<span class="sourceLineNo">156</span>    if (comparator instanceof RegexStringComparator ||<a name="line.156"></a>
-<span class="sourceLineNo">157</span>        comparator instanceof SubstringComparator) {<a name="line.157"></a>
-<span class="sourceLineNo">158</span>      if (operator != CompareOperator.EQUAL &amp;&amp;<a name="line.158"></a>
-<span class="sourceLineNo">159</span>          operator != CompareOperator.NOT_EQUAL) {<a name="line.159"></a>
-<span class="sourceLineNo">160</span>        throw new IllegalArgumentException("A regexstring comparator and substring comparator " +<a name="line.160"></a>
-<span class="sourceLineNo">161</span>            "can only be used with EQUAL and NOT_EQUAL");<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>    return new ColumnValueFilter(family, qualifier, operator, comparator);<a name="line.165"></a>
-<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>   * @return A pb instance to represent this instance.<a name="line.169"></a>
-<span class="sourceLineNo">170</span>   */<a name="line.170"></a>
-<span class="sourceLineNo">171</span>  FilterProtos.ColumnValueFilter convert() {<a name="line.171"></a>
-<span class="sourceLineNo">172</span>    FilterProtos.ColumnValueFilter.Builder builder =<a name="line.172"></a>
-<span class="sourceLineNo">173</span>      FilterProtos.ColumnValueFilter.newBuilder();<a name="line.173"></a>
-<span class="sourceLineNo">174</span><a name="line.174"></a>
-<span class="sourceLineNo">175</span>    builder.setFamily(UnsafeByteOperations.unsafeWrap(this.family));<a name="line.175"></a>
-<span class="sourceLineNo">176</span>    builder.setQualifier(UnsafeByteOperations.unsafeWrap(this.qualifier));<a name="line.176"></a>
-<span class="sourceLineNo">177</span>    builder.setCompareOp(HBaseProtos.CompareType.valueOf(this.op.name()));<a name="line.177"></a>
-<span class="sourceLineNo">178</span>    builder.setComparator(ProtobufUtil.toComparator(this.comparator));<a name="line.178"></a>
-<span class="sourceLineNo">179</span><a name="line.179"></a>
-<span class="sourceLineNo">180</span>    return builder.build();<a name="line.180"></a>
-<span class="sourceLineNo">181</span>  }<a name="line.181"></a>
-<span class="sourceLineNo">182</span><a name="line.182"></a>
-<span class="sourceLineNo">183</span>  /**<a name="line.183"></a>
-<span class="sourceLineNo">184</span>   * Parse protobuf bytes to a ColumnValueFilter<a name="line.184"></a>
-<span class="sourceLineNo">185</span>   * @param pbBytes pbBytes<a name="line.185"></a>
-<span class="sourceLineNo">186</span>   * @return a ColumnValueFilter<a name="line.186"></a>
-<span class="sourceLineNo">187</span>   * @throws DeserializationException deserialization exception<a name="line.187"></a>
-<span class="sourceLineNo">188</span>   */<a name="line.188"></a>
-<span class="sourceLineNo">189</span>  public static ColumnValueFilter parseFrom(final byte[] pbBytes) throws DeserializationException {<a name="line.189"></a>
-<span class="sourceLineNo">190</span>    FilterProtos.ColumnValueFilter proto;<a name="line.190"></a>
-<span class="sourceLineNo">191</span>    try {<a name="line.191"></a>
-<span class="sourceLineNo">192</span>      proto = FilterProtos.ColumnValueFilter.parseFrom(pbBytes);<a name="line.192"></a>
-<span class="sourceLineNo">193</span>    } catch (InvalidProtocolBufferException e) {<a name="line.193"></a>
-<span class="sourceLineNo">194</span>      throw new DeserializationException(e);<a name="line.194"></a>
-<span class="sourceLineNo">195</span>    }<a name="line.195"></a>
-<span class="sourceLineNo">196</span><a name="line.196"></a>
-<span class="sourceLineNo">197</span>    final CompareOperator compareOp = CompareOperator.valueOf(proto.getCompareOp().name());<a name="line.197"></a>
-<span class="sourceLineNo">198</span>    final ByteArrayComparable comparator;<a name="line.198"></a>
-<span class="sourceLineNo">199</span>    try {<a name="line.199"></a>
-<span class="sourceLineNo">200</span>      comparator = ProtobufUtil.toComparator(proto.getComparator());<a name="line.200"></a>
-<span class="sourceLineNo">201</span>    } catch (IOException ioe) {<a name="line.201"></a>
-<span class="sourceLineNo">202</span>      throw new DeserializationException(ioe);<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>    return new ColumnValueFilter(proto.getFamily().toByteArray(),<a name="line.205"></a>
-<span class="sourceLineNo">206</span>      proto.getQualifier().toByteArray(), compareOp, comparator);<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>  @Override<a name="line.209"></a>
-<span class="sourceLineNo">210</span>  public byte[] toByteArray() throws IOException {<a name="line.210"></a>
-<span class="sourceLineNo">211</span>    return convert().toByteArray();<a name="line.211"></a>
-<span class="sourceLineNo">212</span>  }<a name="line.212"></a>
-<span class="sourceLineNo">213</span><a name="line.213"></a>
-<span class="sourceLineNo">214</span>  @Override<a name="line.214"></a>
-<span class="sourceLineNo">215</span>  boolean areSerializedFieldsEqual(Filter o) {<a name="line.215"></a>
-<span class="sourceLineNo">216</span>    if (o == this) {<a name="line.216"></a>
-<span class="sourceLineNo">217</span>      return true;<a name="line.217"></a>
-<span class="sourceLineNo">218</span>    } else if (!(o instanceof ColumnValueFilter)) {<a name="line.218"></a>
-<span class="sourceLineNo">219</span>      return false;<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>    ColumnValueFilter other = (ColumnValueFilter) o;<a name="line.222"></a>
-<span class="sourceLineNo">223</span>    return Bytes.equals(this.getFamily(), other.getFamily()) &amp;&amp;<a name="line.223"></a>
-<span class="sourceLineNo">224</span>      Bytes.equals(this.getQualifier(), other.getQualifier()) &amp;&amp;<a name="line.224"></a>
-<span class="sourceLineNo">225</span>      this.getCompareOperator().equals(other.getCompareOperator()) &amp;&amp;<a name="line.225"></a>
-<span class="sourceLineNo">226</span>      this.getComparator().areSerializedFieldsEqual(other.getComparator());<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>  @Override<a name="line.229"></a>
-<span class="sourceLineNo">230</span>  public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.230"></a>
-<span class="sourceLineNo">231</span>    return Bytes.equals(name, this.family);<a name="line.231"></a>
-<span class="sourceLineNo">232</span>  }<a name="line.232"></a>
-<span class="sourceLineNo">233</span><a name="line.233"></a>
-<span class="sourceLineNo">234</span>  @Override<a name="line.234"></a>
-<span class="sourceLineNo">235</span>  public String toString() {<a name="line.235"></a>
-<span class="sourceLineNo">236</span>    return String.format("%s (%s, %s, %s, %s)",<a name="line.236"></a>
-<span class="sourceLineNo">237</span>      getClass().getSimpleName(), Bytes.toStringBinary(this.family),<a name="line.237"></a>
-<span class="sourceLineNo">238</span>      Bytes.toStringBinary(this.qualifier), this.op.name(),<a name="line.238"></a>
-<span class="sourceLineNo">239</span>      Bytes.toStringBinary(this.comparator.getValue()));<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">024</span>import java.util.Objects;<a name="line.24"></a>
+<span class="sourceLineNo">025</span><a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Cell;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.PrivateCellUtil;<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.util.Bytes;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.32"></a>
+<span class="sourceLineNo">033</span><a name="line.33"></a>
+<span class="sourceLineNo">034</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;<a name="line.36"></a>
+<span class="sourceLineNo">037</span><a name="line.37"></a>
+<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.38"></a>
+<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.39"></a>
+<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;<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> * Different from {@link SingleColumnValueFilter} which returns an &lt;b&gt;entire&lt;/b&gt; row<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * when specified condition is matched, {@link ColumnValueFilter} return the matched cell only.<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * This filter is used to filter cells based on column and value.<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * It takes a {@link org.apache.hadoop.hbase.CompareOperator} operator (&lt;, &lt;=, =, !=, &gt;, &gt;=), and<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * and a {@link ByteArrayComparable} comparator.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> */<a name="line.49"></a>
+<span class="sourceLineNo">050</span>@InterfaceAudience.Public<a name="line.50"></a>
+<span class="sourceLineNo">051</span>public class ColumnValueFilter extends FilterBase {<a name="line.51"></a>
+<span class="sourceLineNo">052</span>  private final byte[] family;<a name="line.52"></a>
+<span class="sourceLineNo">053</span>  private final byte[] qualifier;<a name="line.53"></a>
+<span class="sourceLineNo">054</span>  private final CompareOperator op;<a name="line.54"></a>
+<span class="sourceLineNo">055</span>  private final ByteArrayComparable comparator;<a name="line.55"></a>
+<span class="sourceLineNo">056</span><a name="line.56"></a>
+<span class="sourceLineNo">057</span>  // This flag is used to speed up seeking cells when matched column is found, such that following<a name="line.57"></a>
+<span class="sourceLineNo">058</span>  // columns in the same row can be skipped faster by NEXT_ROW instead of NEXT_COL.<a name="line.58"></a>
+<span class="sourceLineNo">059</span>  private boolean columnFound = false;<a name="line.59"></a>
+<span class="sourceLineNo">060</span><a name="line.60"></a>
+<span class="sourceLineNo">061</span>  public ColumnValueFilter(final byte[] family, final byte[] qualifier,<a name="line.61"></a>
+<span class="sourceLineNo">062</span>                           final CompareOperator op, final byte[] value) {<a name="line.62"></a>
+<span class="sourceLineNo">063</span>    this(family, qualifier, op, new BinaryComparator(value));<a name="line.63"></a>
+<span class="sourceLineNo">064</span>  }<a name="line.64"></a>
+<span class="sourceLineNo">065</span><a name="line.65"></a>
+<span class="sourceLineNo">066</span>  public ColumnValueFilter(final byte[] family, final byte[] qualifier,<a name="line.66"></a>
+<span class="sourceLineNo">067</span>                           final CompareOperator op,<a name="line.67"></a>
+<span class="sourceLineNo">068</span>                           final ByteArrayComparable comparator) {<a name="line.68"></a>
+<span class="sourceLineNo">069</span>    this.family = Preconditions.checkNotNull(family, "family should not be null.");<a name="line.69"></a>
+<span class="sourceLineNo">070</span>    this.qualifier = qualifier == null ? new byte[0] : qualifier;<a name="line.70"></a>
+<span class="sourceLineNo">071</span>    this.op = Preconditions.checkNotNull(op, "CompareOperator should not be null");<a name="line.71"></a>
+<span class="sourceLineNo">072</span>    this.comparator = Preconditions.checkNotNull(comparator, "Comparator should not be null");<a name="line.72"></a>
+<span class="sourceLineNo">073</span>  }<a name="line.73"></a>
+<span class="sourceLineNo">074</span><a name="line.74"></a>
+<span class="sourceLineNo">075</span>  /**<a name="line.75"></a>
+<span class="sourceLineNo">076</span>   * @return operator<a name="line.76"></a>
+<span class="sourceLineNo">077</span>   */<a name="line.77"></a>
+<span class="sourceLineNo">078</span>  public CompareOperator getCompareOperator() {<a name="line.78"></a>
+<span class="sourceLineNo">079</span>    return op;<a name="line.79"></a>
+<span class="sourceLineNo">080</span>  }<a name="line.80"></a>
+<span class="sourceLineNo">081</span><a name="line.81"></a>
+<span class="sourceLineNo">082</span>  /**<a name="line.82"></a>
+<span class="sourceLineNo">083</span>   * @return the comparator<a name="line.83"></a>
+<span class="sourceLineNo">084</span>   */<a name="line.84"></a>
+<span class="sourceLineNo">085</span>  public ByteArrayComparable getComparator() {<a name="line.85"></a>
+<span class="sourceLineNo">086</span>    return comparator;<a name="line.86"></a>
+<span class="sourceLineNo">087</span>  }<a name="line.87"></a>
+<span class="sourceLineNo">088</span><a name="line.88"></a>
+<span class="sourceLineNo">089</span>  /**<a name="line.89"></a>
+<span class="sourceLineNo">090</span>   * @return the column family<a name="line.90"></a>
+<span class="sourceLineNo">091</span>   */<a name="line.91"></a>
+<span class="sourceLineNo">092</span>  public byte[] getFamily() {<a name="line.92"></a>
+<span class="sourceLineNo">093</span>    return family;<a name="line.93"></a>
+<span class="sourceLineNo">094</span>  }<a name="line.94"></a>
+<span class="sourceLineNo">095</span><a name="line.95"></a>
+<span class="sourceLineNo">096</span>  /**<a name="line.96"></a>
+<span class="sourceLineNo">097</span>   * @return the qualifier<a name="line.97"></a>
+<span class="sourceLineNo">098</span>   */<a name="line.98"></a>
+<span class="sourceLineNo">099</span>  public byte[] getQualifier() {<a name="line.99"></a>
+<span class="sourceLineNo">100</span>    return qualifier;<a name="line.100"></a>
+<span class="sourceLineNo">101</span>  }<a name="line.101"></a>
+<span class="sourceLineNo">102</span><a name="line.102"></a>
+<span class="sourceLineNo">103</span>  @Override<a name="line.103"></a>
+<span class="sourceLineNo">104</span>  public void reset() throws IOException {<a name="line.104"></a>
+<span class="sourceLineNo">105</span>    columnFound = false;<a name="line.105"></a>
+<span class="sourceLineNo">106</span>  }<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span>  @Override<a name="line.108"></a>
+<span class="sourceLineNo">109</span>  public boolean filterRowKey(Cell cell) throws IOException {<a name="line.109"></a>
+<span class="sourceLineNo">110</span>    return false;<a name="line.110"></a>
+<span class="sourceLineNo">111</span>  }<a name="line.111"></a>
+<span class="sourceLineNo">112</span><a name="line.112"></a>
+<span class="sourceLineNo">113</span>  @Override<a name="line.113"></a>
+<span class="sourceLineNo">114</span>  public ReturnCode filterCell(Cell c) throws IOException {<a name="line.114"></a>
+<span class="sourceLineNo">115</span>    // 1. Check column match<a name="line.115"></a>
+<span class="sourceLineNo">116</span>    if (!CellUtil.matchingColumn(c, this.family, this.qualifier)) {<a name="line.116"></a>
+<span class="sourceLineNo">117</span>      return columnFound ? ReturnCode.NEXT_ROW : ReturnCode.NEXT_COL;<a name="line.117"></a>
+<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
+<span class="sourceLineNo">119</span>    // Column found<a name="line.119"></a>
+<span class="sourceLineNo">120</span>    columnFound = true;<a name="line.120"></a>
+<span class="sourceLineNo">121</span>    // 2. Check value match:<a name="line.121"></a>
+<span class="sourceLineNo">122</span>    // True means filter out, just skip this cell, else include it.<a name="line.122"></a>
+<span class="sourceLineNo">123</span>    return compareValue(getCompareOperator(), getComparator(), c) ?<a name="line.123"></a>
+<span class="sourceLineNo">124</span>      ReturnCode.SKIP : ReturnCode.INCLUDE;<a name="line.124"></a>
+<span class="sourceLineNo">125</span>  }<a name="line.125"></a>
+<span class="sourceLineNo">126</span><a name="line.126"></a>
+<span class="sourceLineNo">127</span>  /**<a name="line.127"></a>
+<span class="sourceLineNo">128</span>   * This method is used to determine a cell should be included or filtered out.<a name="line.128"></a>
+<span class="sourceLineNo">129</span>   * @param op one of operators {@link CompareOperator}<a name="line.129"></a>
+<span class="sourceLineNo">130</span>   * @param comparator comparator used to compare cells.<a name="line.130"></a>
+<span class="sourceLineNo">131</span>   * @param cell cell to be compared.<a name="line.131"></a>
+<span class="sourceLineNo">132</span>   * @return true means cell should be filtered out, included otherwise.<a name="line.132"></a>
+<span class="sourceLineNo">133</span>   */<a name="line.133"></a>
+<span class="sourceLineNo">134</span>  private boolean compareValue(final CompareOperator op, final ByteArrayComparable comparator,<a name="line.134"></a>
+<span class="sourceLineNo">135</span>    final Cell cell) {<a name="line.135"></a>
+<span class="sourceLineNo">136</span>    if (op == CompareOperator.NO_OP) {<a name="line.136"></a>
+<span class="sourceLineNo">137</span>      return true;<a name="line.137"></a>
+<span class="sourceLineNo">138</span>    }<a name="line.138"></a>
+<span class="sourceLineNo">139</span>    int compareResult = PrivateCellUtil.compareValue(cell, comparator);<a name="line.139"></a>
+<span class="sourceLineNo">140</span>    return CompareFilter.compare(op, compareResult);<a name="line.140"></a>
+<span class="sourceLineNo">141</span>  }<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span>  /**<a name="line.143"></a>
+<span class="sourceLineNo">144</span>   * Creating this filter by reflection, it is used by {@link ParseFilter},<a name="line.144"></a>
+<span class="sourceLineNo">145</span>   * @param filterArguments arguments for creating a ColumnValueFilter<a name="line.145"></a>
+<span class="sourceLineNo">146</span>   * @return a ColumnValueFilter<a name="line.146"></a>
+<span class="sourceLineNo">147</span>   */<a name="line.147"></a>
+<span class="sourceLineNo">148</span>  public static Filter createFilterFromArguments(ArrayList&lt;byte[]&gt; filterArguments) {<a name="line.148"></a>
+<span class="sourceLineNo">149</span>    Preconditions.checkArgument(filterArguments.size() == 4,<a name="line.149"></a>
+<span class="sourceLineNo">150</span>      "Expect 4 arguments: %s", filterArguments.size());<a name="line.150"></a>
+<span class="sourceLineNo">151</span>    byte[] family = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a name="line.151"></a>
+<span class="sourceLineNo">152</span>    byte[] qualifier = ParseFilter.removeQuotesFromByteArray(filterArguments.get(1));<a name="line.152"></a>
+<span class="sourceLineNo">153</span>    CompareOperator operator = ParseFilter.createCompareOperator(filterArguments.get(2));<a name="line.153"></a>
+<span class="sourceLineNo">154</span>    ByteArrayComparable comparator =<a name="line.154"></a>
+<span class="sourceLineNo">155</span>      ParseFilter.createComparator(ParseFilter.removeQuotesFromByteArray(filterArguments.get(3)));<a name="line.155"></a>
+<span class="sourceLineNo">156</span><a name="line.156"></a>
+<span class="sourceLineNo">157</span>    if (comparator instanceof RegexStringComparator ||<a name="line.157"></a>
+<span class="sourceLineNo">158</span>        comparator instanceof SubstringComparator) {<a name="line.158"></a>
+<span class="sourceLineNo">159</span>      if (operator != CompareOperator.EQUAL &amp;&amp;<a name="line.159"></a>
+<span class="sourceLineNo">160</span>          operator != CompareOperator.NOT_EQUAL) {<a name="line.160"></a>
+<span class="sourceLineNo">161</span>        throw new IllegalArgumentException("A regexstring comparator and substring comparator " +<a name="line.161"></a>
+<span class="sourceLineNo">162</span>            "can only be used with EQUAL and NOT_EQUAL");<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><a name="line.165"></a>
+<span class="sourceLineNo">166</span>    return new ColumnValueFilter(family, qualifier, operator, comparator);<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>  /**<a name="line.169"></a>
+<span class="sourceLineNo">170</span>   * @return A pb instance to represent this instance.<a name="line.170"></a>
+<span class="sourceLineNo">171</span>   */<a name="line.171"></a>
+<span class="sourceLineNo">172</span>  FilterProtos.ColumnValueFilter convert() {<a name="line.172"></a>
+<span class="sourceLineNo">173</span>    FilterProtos.ColumnValueFilter.Builder builder =<a name="line.173"></a>
+<span class="sourceLineNo">174</span>      FilterProtos.ColumnValueFilter.newBuilder();<a name="line.174"></a>
+<span class="sourceLineNo">175</span><a name="line.175"></a>
+<span class="sourceLineNo">176</span>    builder.setFamily(UnsafeByteOperations.unsafeWrap(this.family));<a name="line.176"></a>
+<span class="sourceLineNo">177</span>    builder.setQualifier(UnsafeByteOperations.unsafeWrap(this.qualifier));<a name="line.177"></a>
+<span class="sourceLineNo">178</span>    builder.setCompareOp(HBaseProtos.CompareType.valueOf(this.op.name()));<a name="line.178"></a>
+<span class="sourceLineNo">179</span>    builder.setComparator(ProtobufUtil.toComparator(this.comparator));<a name="line.179"></a>
+<span class="sourceLineNo">180</span><a name="line.180"></a>
+<span class="sourceLineNo">181</span>    return builder.build();<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>  /**<a name="line.184"></a>
+<span class="sourceLineNo">185</span>   * Parse protobuf bytes to a ColumnValueFilter<a name="line.185"></a>
+<span class="sourceLineNo">186</span>   * @param pbBytes pbBytes<a name="line.186"></a>
+<span class="sourceLineNo">187</span>   * @return a ColumnValueFilter<a name="line.187"></a>
+<span class="sourceLineNo">188</span>   * @throws DeserializationException deserialization exception<a name="line.188"></a>
+<span class="sourceLineNo">189</span>   */<a name="line.189"></a>
+<span class="sourceLineNo">190</span>  public static ColumnValueFilter parseFrom(final byte[] pbBytes) throws DeserializationException {<a name="line.190"></a>
+<span class="sourceLineNo">191</span>    FilterProtos.ColumnValueFilter proto;<a name="line.191"></a>
+<span class="sourceLineNo">192</span>    try {<a name="line.192"></a>
+<span class="sourceLineNo">193</span>      proto = FilterProtos.ColumnValueFilter.parseFrom(pbBytes);<a name="line.193"></a>
+<span class="sourceLineNo">194</span>    } catch (InvalidProtocolBufferException e) {<a name="line.194"></a>
+<span class="sourceLineNo">195</span>      throw new DeserializationException(e);<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>    final CompareOperator compareOp = CompareOperator.valueOf(proto.getCompareOp().name());<a name="line.198"></a>
+<span class="sourceLineNo">199</span>    final ByteArrayComparable comparator;<a name="line.199"></a>
+<span class="sourceLineNo">200</span>    try {<a name="line.200"></a>
+<span class="sourceLineNo">201</span>      comparator = ProtobufUtil.toComparator(proto.getComparator());<a name="line.201"></a>
+<span class="sourceLineNo">202</span>    } catch (IOException ioe) {<a name="line.202"></a>
+<span class="sourceLineNo">203</span>      throw new DeserializationException(ioe);<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>    return new ColumnValueFilter(proto.getFamily().toByteArray(),<a name="line.206"></a>
+<span class="sourceLineNo">207</span>      proto.getQualifier().toByteArray(), compareOp, comparator);<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>  @Override<a name="line.210"></a>
+<span class="sourceLineNo">211</span>  public byte[] toByteArray() throws IOException {<a name="line.211"></a>
+<span class="sourceLineNo">212</span>    return convert().toByteArray();<a name="line.212"></a>
+<span class="sourceLineNo">213</span>  }<a name="line.213"></a>
+<span class="sourceLineNo">214</span><a name="line.214"></a>
+<span class="sourceLineNo">215</span>  @Override<a name="line.215"></a>
+<span class="sourceLineNo">216</span>  boolean areSerializedFieldsEqual(Filter o) {<a name="line.216"></a>
+<span class="sourceLineNo">217</span>    if (o == this) {<a name="line.217"></a>
+<span class="sourceLineNo">218</span>      return true;<a name="line.218"></a>
+<span class="sourceLineNo">219</span>    } else if (!(o instanceof ColumnValueFilter)) {<a name="line.219"></a>
+<span class="sourceLineNo">220</span>      return false;<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>    ColumnValueFilter other = (ColumnValueFilter) o;<a name="line.223"></a>
+<span class="sourceLineNo">224</span>    return Bytes.equals(this.getFamily(), other.getFamily()) &amp;&amp;<a name="line.224"></a>
+<span class="sourceLineNo">225</span>      Bytes.equals(this.getQualifier(), other.getQualifier()) &amp;&amp;<a name="line.225"></a>
+<span class="sourceLineNo">226</span>      this.getCompareOperator().equals(other.getCompareOperator()) &amp;&amp;<a name="line.226"></a>
+<span class="sourceLineNo">227</span>      this.getComparator().areSerializedFieldsEqual(other.getComparator());<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>  @Override<a name="line.230"></a>
+<span class="sourceLineNo">231</span>  public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.231"></a>
+<span class="sourceLineNo">232</span>    return Bytes.equals(name, this.family);<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>  @Override<a name="line.235"></a>
+<span class="sourceLineNo">236</span>  public String toString() {<a name="line.236"></a>
+<span class="sourceLineNo">237</span>    return String.format("%s (%s, %s, %s, %s)",<a name="line.237"></a>
+<span class="sourceLineNo">238</span>      getClass().getSimpleName(), Bytes.toStringBinary(this.family),<a name="line.238"></a>
+<span class="sourceLineNo">239</span>      Bytes.toStringBinary(this.qualifier), this.op.name(),<a name="line.239"></a>
+<span class="sourceLineNo">240</span>      Bytes.toStringBinary(this.comparator.getValue()));<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 equals(Object obj) {<a name="line.244"></a>
+<span class="sourceLineNo">245</span>    if (obj == null || (!(obj instanceof ColumnValueFilter))) {<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>    ColumnValueFilter f = (ColumnValueFilter) obj;<a name="line.248"></a>
+<span class="sourceLineNo">249</span>    return this.areSerializedFieldsEqual(f);<a name="line.249"></a>
+<span class="sourceLineNo">250</span>  }<a name="line.250"></a>
+<span class="sourceLineNo">251</span><a name="line.251"></a>
+<span class="sourceLineNo">252</span>  @Override<a name="line.252"></a>
+<span class="sourceLineNo">253</span>  public int hashCode() {<a name="line.253"></a>
+<span class="sourceLineNo">254</span>    return Objects.hash(Bytes.hashCode(this.getFamily()), Bytes.hashCode(this.getQualifier()),<a name="line.254"></a>
+<span class="sourceLineNo">255</span>        this.getCompareOperator(), this.getComparator());<a name="line.255"></a>
+<span class="sourceLineNo">256</span>  }<a name="line.256"></a>
+<span class="sourceLineNo">257</span>}<a name="line.257"></a>
 
 
 


Mime
View raw message