| <!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: ColumnPaginationFilter"> |
| <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.Objects;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.Cell;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.CellUtil;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.PrivateCellUtil;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.exceptions.DeserializationException;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;</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.hadoop.hbase.shaded.protobuf.generated.FilterProtos;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">/**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset. This filter</span> |
| <span class="source-line-no">038</span><span id="line-38"> * can be used for row-based indexing, where references to other tables are stored across many</span> |
| <span class="source-line-no">039</span><span id="line-39"> * columns, in order to efficient lookups and paginated results for end users. Only most recent</span> |
| <span class="source-line-no">040</span><span id="line-40"> * versions are considered for pagination.</span> |
| <span class="source-line-no">041</span><span id="line-41"> * @apiNote This filter is in awkward place, as even though it can return SEEK_NEXT_USING_HINT, it</span> |
| <span class="source-line-no">042</span><span id="line-42"> * also maintains an internal row state, so it is not marked as HintingFilter. Hinted seek</span> |
| <span class="source-line-no">043</span><span id="line-43"> * information may be lost when used in a MUST_PASS_ALL FilterList, which can result in</span> |
| <span class="source-line-no">044</span><span id="line-44"> * suboptimal performance.</span> |
| <span class="source-line-no">045</span><span id="line-45"> */</span> |
| <span class="source-line-no">046</span><span id="line-46">@InterfaceAudience.Public</span> |
| <span class="source-line-no">047</span><span id="line-47">public class ColumnPaginationFilter extends FilterBase {</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> private int limit = 0;</span> |
| <span class="source-line-no">050</span><span id="line-50"> private int offset = -1;</span> |
| <span class="source-line-no">051</span><span id="line-51"> private byte[] columnOffset = null;</span> |
| <span class="source-line-no">052</span><span id="line-52"> private int count = 0;</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Initializes filter with an integer offset and limit. The offset is arrived at scanning</span> |
| <span class="source-line-no">056</span><span id="line-56"> * sequentially and skipping entries. @limit number of columns are then retrieved. If multiple</span> |
| <span class="source-line-no">057</span><span id="line-57"> * column families are involved, the columns may be spread across them.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param limit Max number of columns to return.</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @param offset The integer offset where to start pagination.</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> public ColumnPaginationFilter(final int limit, final int offset) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> Preconditions.checkArgument(limit >= 0, "limit must be positive %s", limit);</span> |
| <span class="source-line-no">063</span><span id="line-63"> Preconditions.checkArgument(offset >= 0, "offset must be positive %s", offset);</span> |
| <span class="source-line-no">064</span><span id="line-64"> this.limit = limit;</span> |
| <span class="source-line-no">065</span><span id="line-65"> this.offset = offset;</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> /**</span> |
| <span class="source-line-no">069</span><span id="line-69"> * Initializes filter with a string/bookmark based offset and limit. The offset is arrived at, by</span> |
| <span class="source-line-no">070</span><span id="line-70"> * seeking to it using scanner hints. If multiple column families are involved, pagination starts</span> |
| <span class="source-line-no">071</span><span id="line-71"> * at the first column family which contains @columnOffset. Columns are then retrieved</span> |
| <span class="source-line-no">072</span><span id="line-72"> * sequentially upto @limit number of columns which maybe spread across multiple column families,</span> |
| <span class="source-line-no">073</span><span id="line-73"> * depending on how the scan is setup.</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @param limit Max number of columns to return.</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param columnOffset The string/bookmark offset on where to start pagination.</span> |
| <span class="source-line-no">076</span><span id="line-76"> */</span> |
| <span class="source-line-no">077</span><span id="line-77"> public ColumnPaginationFilter(final int limit, final byte[] columnOffset) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> Preconditions.checkArgument(limit >= 0, "limit must be positive %s", limit);</span> |
| <span class="source-line-no">079</span><span id="line-79"> Preconditions.checkArgument(columnOffset != null, "columnOffset must be non-null %s",</span> |
| <span class="source-line-no">080</span><span id="line-80"> columnOffset);</span> |
| <span class="source-line-no">081</span><span id="line-81"> this.limit = limit;</span> |
| <span class="source-line-no">082</span><span id="line-82"> this.columnOffset = columnOffset;</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"> public int getLimit() {</span> |
| <span class="source-line-no">086</span><span id="line-86"> return limit;</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> public int getOffset() {</span> |
| <span class="source-line-no">090</span><span id="line-90"> return offset;</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> public byte[] getColumnOffset() {</span> |
| <span class="source-line-no">094</span><span id="line-94"> return columnOffset;</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> @Override</span> |
| <span class="source-line-no">098</span><span id="line-98"> public boolean filterRowKey(Cell cell) throws IOException {</span> |
| <span class="source-line-no">099</span><span id="line-99"> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.</span> |
| <span class="source-line-no">100</span><span id="line-100"> return false;</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> @Override</span> |
| <span class="source-line-no">104</span><span id="line-104"> public ReturnCode filterCell(final Cell c) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> if (columnOffset != null) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> if (count >= limit) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> return ReturnCode.NEXT_ROW;</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"> int cmp = 0;</span> |
| <span class="source-line-no">110</span><span id="line-110"> // Only compare if no KV's have been seen so far.</span> |
| <span class="source-line-no">111</span><span id="line-111"> if (count == 0) {</span> |
| <span class="source-line-no">112</span><span id="line-112"> cmp = CellUtil.compareQualifiers(c, this.columnOffset, 0, this.columnOffset.length);</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"> if (cmp < 0) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> return ReturnCode.SEEK_NEXT_USING_HINT;</span> |
| <span class="source-line-no">116</span><span id="line-116"> } else {</span> |
| <span class="source-line-no">117</span><span id="line-117"> count++;</span> |
| <span class="source-line-no">118</span><span id="line-118"> return ReturnCode.INCLUDE_AND_NEXT_COL;</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"> } else {</span> |
| <span class="source-line-no">121</span><span id="line-121"> if (count >= offset + limit) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> return ReturnCode.NEXT_ROW;</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> ReturnCode code = count < offset ? ReturnCode.NEXT_COL : ReturnCode.INCLUDE_AND_NEXT_COL;</span> |
| <span class="source-line-no">126</span><span id="line-126"> count++;</span> |
| <span class="source-line-no">127</span><span id="line-127"> return code;</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"> @Override</span> |
| <span class="source-line-no">132</span><span id="line-132"> public Cell getNextCellHint(Cell cell) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> return PrivateCellUtil.createFirstOnRowCol(cell, columnOffset, 0, columnOffset.length);</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"></span> |
| <span class="source-line-no">136</span><span id="line-136"> @Override</span> |
| <span class="source-line-no">137</span><span id="line-137"> public void reset() {</span> |
| <span class="source-line-no">138</span><span id="line-138"> this.count = 0;</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> Preconditions.checkArgument(filterArguments.size() == 2, "Expected 2 but got: %s",</span> |
| <span class="source-line-no">143</span><span id="line-143"> filterArguments.size());</span> |
| <span class="source-line-no">144</span><span id="line-144"> int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));</span> |
| <span class="source-line-no">145</span><span id="line-145"> int offset = ParseFilter.convertByteArrayToInt(filterArguments.get(1));</span> |
| <span class="source-line-no">146</span><span id="line-146"> return new ColumnPaginationFilter(limit, offset);</span> |
| <span class="source-line-no">147</span><span id="line-147"> }</span> |
| <span class="source-line-no">148</span><span id="line-148"></span> |
| <span class="source-line-no">149</span><span id="line-149"> /** Returns The filter serialized using pb */</span> |
| <span class="source-line-no">150</span><span id="line-150"> @Override</span> |
| <span class="source-line-no">151</span><span id="line-151"> public byte[] toByteArray() {</span> |
| <span class="source-line-no">152</span><span id="line-152"> FilterProtos.ColumnPaginationFilter.Builder builder =</span> |
| <span class="source-line-no">153</span><span id="line-153"> FilterProtos.ColumnPaginationFilter.newBuilder();</span> |
| <span class="source-line-no">154</span><span id="line-154"> builder.setLimit(this.limit);</span> |
| <span class="source-line-no">155</span><span id="line-155"> if (this.offset >= 0) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> builder.setOffset(this.offset);</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"> if (this.columnOffset != null) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> builder.setColumnOffset(UnsafeByteOperations.unsafeWrap(this.columnOffset));</span> |
| <span class="source-line-no">160</span><span id="line-160"> }</span> |
| <span class="source-line-no">161</span><span id="line-161"> return builder.build().toByteArray();</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164"> /**</span> |
| <span class="source-line-no">165</span><span id="line-165"> * Parse a serialized representation of {@link ColumnPaginationFilter}</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @param pbBytes A pb serialized {@link ColumnPaginationFilter} instance</span> |
| <span class="source-line-no">167</span><span id="line-167"> * @return An instance of {@link ColumnPaginationFilter} made from <code>bytes</code></span> |
| <span class="source-line-no">168</span><span id="line-168"> * @throws DeserializationException if an error occurred</span> |
| <span class="source-line-no">169</span><span id="line-169"> * @see #toByteArray</span> |
| <span class="source-line-no">170</span><span id="line-170"> */</span> |
| <span class="source-line-no">171</span><span id="line-171"> public static ColumnPaginationFilter parseFrom(final byte[] pbBytes)</span> |
| <span class="source-line-no">172</span><span id="line-172"> throws DeserializationException {</span> |
| <span class="source-line-no">173</span><span id="line-173"> FilterProtos.ColumnPaginationFilter proto;</span> |
| <span class="source-line-no">174</span><span id="line-174"> try {</span> |
| <span class="source-line-no">175</span><span id="line-175"> proto = FilterProtos.ColumnPaginationFilter.parseFrom(pbBytes);</span> |
| <span class="source-line-no">176</span><span id="line-176"> } catch (InvalidProtocolBufferException e) {</span> |
| <span class="source-line-no">177</span><span id="line-177"> throw new DeserializationException(e);</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"> if (proto.hasColumnOffset()) {</span> |
| <span class="source-line-no">180</span><span id="line-180"> return new ColumnPaginationFilter(proto.getLimit(), proto.getColumnOffset().toByteArray());</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182"> return new ColumnPaginationFilter(proto.getLimit(), proto.getOffset());</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</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"> * Returns true if and only if the fields of the filter that are serialized are equal to the</span> |
| <span class="source-line-no">187</span><span id="line-187"> * corresponding fields in other. Used for testing.</span> |
| <span class="source-line-no">188</span><span id="line-188"> */</span> |
| <span class="source-line-no">189</span><span id="line-189"> @Override</span> |
| <span class="source-line-no">190</span><span id="line-190"> boolean areSerializedFieldsEqual(Filter o) {</span> |
| <span class="source-line-no">191</span><span id="line-191"> if (o == this) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> return true;</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</span> |
| <span class="source-line-no">194</span><span id="line-194"> if (!(o instanceof ColumnPaginationFilter)) {</span> |
| <span class="source-line-no">195</span><span id="line-195"> return false;</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197"> ColumnPaginationFilter other = (ColumnPaginationFilter) o;</span> |
| <span class="source-line-no">198</span><span id="line-198"> if (this.columnOffset != null) {</span> |
| <span class="source-line-no">199</span><span id="line-199"> return this.getLimit() == other.getLimit()</span> |
| <span class="source-line-no">200</span><span id="line-200"> && Bytes.equals(this.getColumnOffset(), other.getColumnOffset());</span> |
| <span class="source-line-no">201</span><span id="line-201"> }</span> |
| <span class="source-line-no">202</span><span id="line-202"> return this.getLimit() == other.getLimit() && this.getOffset() == other.getOffset();</span> |
| <span class="source-line-no">203</span><span id="line-203"> }</span> |
| <span class="source-line-no">204</span><span id="line-204"></span> |
| <span class="source-line-no">205</span><span id="line-205"> @Override</span> |
| <span class="source-line-no">206</span><span id="line-206"> public String toString() {</span> |
| <span class="source-line-no">207</span><span id="line-207"> if (this.columnOffset != null) {</span> |
| <span class="source-line-no">208</span><span id="line-208"> return (this.getClass().getSimpleName() + "(" + this.limit + ", "</span> |
| <span class="source-line-no">209</span><span id="line-209"> + Bytes.toStringBinary(this.columnOffset) + ")");</span> |
| <span class="source-line-no">210</span><span id="line-210"> }</span> |
| <span class="source-line-no">211</span><span id="line-211"> return String.format("%s (%d, %d)", this.getClass().getSimpleName(), this.limit, this.offset);</span> |
| <span class="source-line-no">212</span><span id="line-212"> }</span> |
| <span class="source-line-no">213</span><span id="line-213"></span> |
| <span class="source-line-no">214</span><span id="line-214"> @Override</span> |
| <span class="source-line-no">215</span><span id="line-215"> public boolean equals(Object obj) {</span> |
| <span class="source-line-no">216</span><span id="line-216"> return obj instanceof Filter && areSerializedFieldsEqual((Filter) obj);</span> |
| <span class="source-line-no">217</span><span id="line-217"> }</span> |
| <span class="source-line-no">218</span><span id="line-218"></span> |
| <span class="source-line-no">219</span><span id="line-219"> @Override</span> |
| <span class="source-line-no">220</span><span id="line-220"> public int hashCode() {</span> |
| <span class="source-line-no">221</span><span id="line-221"> return columnOffset == null</span> |
| <span class="source-line-no">222</span><span id="line-222"> ? Objects.hash(this.limit, this.offset)</span> |
| <span class="source-line-no">223</span><span id="line-223"> : Objects.hash(this.limit, Bytes.hashCode(this.columnOffset));</span> |
| <span class="source-line-no">224</span><span id="line-224"> }</span> |
| <span class="source-line-no">225</span><span id="line-225">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
