Google Git
Sign in
apache / hbase-site / 690a3160206c1db10da5912f1efe153de9843573 / . / devapidocs / src-html / org / apache / hadoop / hbase / filter / MultipleColumnPrefixFilter.html
blob: dd5ebcc21e660944a9f5f1f7c50cfc2b80af94c2 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.filter;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Comparator;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.TreeSet;<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.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.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.slf4j.Logger;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.LoggerFactory;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * This filter is used for selecting only those keys with columns that matches<a name="line.39"></a>
<span class="sourceLineNo">040</span> * a particular prefix. For example, if prefix is 'an', it will pass keys will<a name="line.40"></a>
<span class="sourceLineNo">041</span> * columns like 'and', 'anti' but not keys with columns like 'ball', 'act'.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@InterfaceAudience.Public<a name="line.43"></a>
<span class="sourceLineNo">044</span>public class MultipleColumnPrefixFilter extends FilterBase {<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final Logger LOG = LoggerFactory.getLogger(MultipleColumnPrefixFilter.class);<a name="line.45"></a>
<span class="sourceLineNo">046</span> protected byte [] hint = null;<a name="line.46"></a>
<span class="sourceLineNo">047</span> protected TreeSet&lt;byte []&gt; sortedPrefixes = createTreeSet();<a name="line.47"></a>
<span class="sourceLineNo">048</span> private final static int MAX_LOG_PREFIXES = 5;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> public MultipleColumnPrefixFilter(final byte [][] prefixes) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (prefixes != null) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> for (byte[] prefix : prefixes) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> if (!sortedPrefixes.add(prefix)) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> LOG.error("prefix {} is repeated", Bytes.toString(prefix));<a name="line.54"></a>
<span class="sourceLineNo">055</span> throw new IllegalArgumentException("prefixes must be distinct");<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> public byte [][] getPrefix() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> int count = 0;<a name="line.62"></a>
<span class="sourceLineNo">063</span> byte [][] temp = new byte [sortedPrefixes.size()][];<a name="line.63"></a>
<span class="sourceLineNo">064</span> for (byte [] prefixes : sortedPrefixes) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> temp [count++] = prefixes;<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> return temp;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @Override<a name="line.70"></a>
<span class="sourceLineNo">071</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.71"></a>
<span class="sourceLineNo">072</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.72"></a>
<span class="sourceLineNo">073</span> return false;<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> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public ReturnCode filterCell(final Cell c) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> if (sortedPrefixes.isEmpty()) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return ReturnCode.INCLUDE;<a name="line.79"></a>
<span class="sourceLineNo">080</span> } else {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return filterColumn(c);<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> public ReturnCode filterColumn(Cell cell) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> byte [] qualifier = CellUtil.cloneQualifier(cell);<a name="line.86"></a>
<span class="sourceLineNo">087</span> TreeSet&lt;byte []&gt; lesserOrEqualPrefixes =<a name="line.87"></a>
<span class="sourceLineNo">088</span> (TreeSet&lt;byte []&gt;) sortedPrefixes.headSet(qualifier, true);<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> if (lesserOrEqualPrefixes.size() != 0) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> byte [] largestPrefixSmallerThanQualifier = lesserOrEqualPrefixes.last();<a name="line.91"></a>
<span class="sourceLineNo">092</span> <a name="line.92"></a>
<span class="sourceLineNo">093</span> if (Bytes.startsWith(qualifier, largestPrefixSmallerThanQualifier)) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> return ReturnCode.INCLUDE;<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> if (lesserOrEqualPrefixes.size() == sortedPrefixes.size()) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return ReturnCode.NEXT_ROW;<a name="line.98"></a>
<span class="sourceLineNo">099</span> } else {<a name="line.99"></a>
<span class="sourceLineNo">100</span> hint = sortedPrefixes.higher(largestPrefixSmallerThanQualifier);<a name="line.100"></a>
<span class="sourceLineNo">101</span> return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> } else {<a name="line.103"></a>
<span class="sourceLineNo">104</span> hint = sortedPrefixes.first();<a name="line.104"></a>
<span class="sourceLineNo">105</span> return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> public static Filter createFilterFromArguments(ArrayList&lt;byte []&gt; filterArguments) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> byte [][] prefixes = new byte [filterArguments.size()][];<a name="line.110"></a>
<span class="sourceLineNo">111</span> for (int i = 0 ; i &lt; filterArguments.size(); i++) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> byte [] columnPrefix = ParseFilter.removeQuotesFromByteArray(filterArguments.get(i));<a name="line.112"></a>
<span class="sourceLineNo">113</span> prefixes[i] = columnPrefix;<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> return new MultipleColumnPrefixFilter(prefixes);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @return The filter serialized using pb<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> @Override<a name="line.121"></a>
<span class="sourceLineNo">122</span> public byte [] toByteArray() {<a name="line.122"></a>
<span class="sourceLineNo">123</span> FilterProtos.MultipleColumnPrefixFilter.Builder builder =<a name="line.123"></a>
<span class="sourceLineNo">124</span> FilterProtos.MultipleColumnPrefixFilter.newBuilder();<a name="line.124"></a>
<span class="sourceLineNo">125</span> for (byte [] element : sortedPrefixes) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (element != null) builder.addSortedPrefixes(UnsafeByteOperations.unsafeWrap(element));<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span> return builder.build().toByteArray();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> /**<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @param pbBytes A pb serialized {@link MultipleColumnPrefixFilter} instance<a name="line.132"></a>
<span class="sourceLineNo">133</span> * @return An instance of {@link MultipleColumnPrefixFilter} made from &lt;code&gt;bytes&lt;/code&gt;<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @throws DeserializationException<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @see #toByteArray<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> public static MultipleColumnPrefixFilter parseFrom(final byte [] pbBytes)<a name="line.137"></a>
<span class="sourceLineNo">138</span> throws DeserializationException {<a name="line.138"></a>
<span class="sourceLineNo">139</span> FilterProtos.MultipleColumnPrefixFilter proto;<a name="line.139"></a>
<span class="sourceLineNo">140</span> try {<a name="line.140"></a>
<span class="sourceLineNo">141</span> proto = FilterProtos.MultipleColumnPrefixFilter.parseFrom(pbBytes);<a name="line.141"></a>
<span class="sourceLineNo">142</span> } catch (InvalidProtocolBufferException e) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> throw new DeserializationException(e);<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> int numPrefixes = proto.getSortedPrefixesCount();<a name="line.145"></a>
<span class="sourceLineNo">146</span> byte [][] prefixes = new byte[numPrefixes][];<a name="line.146"></a>
<span class="sourceLineNo">147</span> for (int i = 0; i &lt; numPrefixes; ++i) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> prefixes[i] = proto.getSortedPrefixes(i).toByteArray();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> return new MultipleColumnPrefixFilter(prefixes);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @param o the other filter to compare with<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @return true if and only if the fields of the filter that are serialized<a name="line.156"></a>
<span class="sourceLineNo">157</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.157"></a>
<span class="sourceLineNo">158</span> */<a name="line.158"></a>
<span class="sourceLineNo">159</span> @Override<a name="line.159"></a>
<span class="sourceLineNo">160</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (o == this) return true;<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (!(o instanceof MultipleColumnPrefixFilter)) return false;<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> MultipleColumnPrefixFilter other = (MultipleColumnPrefixFilter)o;<a name="line.164"></a>
<span class="sourceLineNo">165</span> return this.sortedPrefixes.equals(other.sortedPrefixes);<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> @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span> public Cell getNextCellHint(Cell cell) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return PrivateCellUtil.createFirstOnRowCol(cell, hint, 0, hint.length);<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> public TreeSet&lt;byte []&gt; createTreeSet() {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return new TreeSet&lt;&gt;(new Comparator&lt;Object&gt;() {<a name="line.174"></a>
<span class="sourceLineNo">175</span> @Override<a name="line.175"></a>
<span class="sourceLineNo">176</span> public int compare (Object o1, Object o2) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (o1 == null || o2 == null)<a name="line.177"></a>
<span class="sourceLineNo">178</span> throw new IllegalArgumentException ("prefixes can't be null");<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> byte [] b1 = (byte []) o1;<a name="line.180"></a>
<span class="sourceLineNo">181</span> byte [] b2 = (byte []) o2;<a name="line.181"></a>
<span class="sourceLineNo">182</span> return Bytes.compareTo (b1, 0, b1.length, b2, 0, b2.length);<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> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> @Override<a name="line.187"></a>
<span class="sourceLineNo">188</span> public String toString() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> return toString(MAX_LOG_PREFIXES);<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> protected String toString(int maxPrefixes) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> StringBuilder prefixes = new StringBuilder();<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> int count = 0;<a name="line.195"></a>
<span class="sourceLineNo">196</span> for (byte[] ba : this.sortedPrefixes) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> if (count &gt;= maxPrefixes) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> break;<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span> ++count;<a name="line.200"></a>
<span class="sourceLineNo">201</span> prefixes.append(Bytes.toStringBinary(ba));<a name="line.201"></a>
<span class="sourceLineNo">202</span> if (count &lt; this.sortedPrefixes.size() &amp;&amp; count &lt; maxPrefixes) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> prefixes.append(", ");<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><a name="line.206"></a>
<span class="sourceLineNo">207</span> return String.format("%s (%d/%d): [%s]", this.getClass().getSimpleName(),<a name="line.207"></a>
<span class="sourceLineNo">208</span> count, this.sortedPrefixes.size(), prefixes.toString());<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span><a name="line.210"></a>
<span class="sourceLineNo">211</span> @Override<a name="line.211"></a>
<span class="sourceLineNo">212</span> public boolean equals(Object obj) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> return obj instanceof Filter &amp;&amp; areSerializedFieldsEqual((Filter) obj);<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> @Override<a name="line.216"></a>
<span class="sourceLineNo">217</span> public int hashCode() {<a name="line.217"></a>
<span class="sourceLineNo">218</span> return Objects.hash(this.sortedPrefixes);<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>
</pre>
</div>
</body>
</html>