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