http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ed0004f8/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html index e1f7de1..a10d265 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html @@ -30,207 +30,206 @@ <span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a> <span class="sourceLineNo">023</span><a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.Cell;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellComparator;<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.yetus.audience.InterfaceAudience;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<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><a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferException;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.UnsafeByteOperations;<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span>/**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * This filter can be used for row-based indexing, where references to other tables are stored across many columns,<a name="line.38"></a> -<span class="sourceLineNo">039</span> * in order to efficient lookups and paginated results for end users. Only most recent versions are considered<a name="line.39"></a> -<span class="sourceLineNo">040</span> * for pagination.<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span>@InterfaceAudience.Public<a name="line.42"></a> -<span class="sourceLineNo">043</span>public class ColumnPaginationFilter extends FilterBase {<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> private int limit = 0;<a name="line.45"></a> -<span class="sourceLineNo">046</span> private int offset = -1;<a name="line.46"></a> -<span class="sourceLineNo">047</span> private byte[] columnOffset = null;<a name="line.47"></a> -<span class="sourceLineNo">048</span> private int count = 0;<a name="line.48"></a> -<span class="sourceLineNo">049</span><a name="line.49"></a> -<span class="sourceLineNo">050</span> /**<a name="line.50"></a> -<span class="sourceLineNo">051</span> * Initializes filter with an integer offset and limit. The offset is arrived at<a name="line.51"></a> -<span class="sourceLineNo">052</span> * scanning sequentially and skipping entries. @limit number of columns are<a name="line.52"></a> -<span class="sourceLineNo">053</span> * then retrieved. If multiple column families are involved, the columns may be spread<a name="line.53"></a> -<span class="sourceLineNo">054</span> * across them.<a name="line.54"></a> -<span class="sourceLineNo">055</span> *<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @param limit Max number of columns to return.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param offset The integer offset where to start pagination.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> public ColumnPaginationFilter(final int limit, final int offset)<a name="line.59"></a> -<span class="sourceLineNo">060</span> {<a name="line.60"></a> -<span class="sourceLineNo">061</span> Preconditions.checkArgument(limit >= 0, "limit must be positive %s", limit);<a name="line.61"></a> -<span class="sourceLineNo">062</span> Preconditions.checkArgument(offset >= 0, "offset must be positive %s", offset);<a name="line.62"></a> -<span class="sourceLineNo">063</span> this.limit = limit;<a name="line.63"></a> -<span class="sourceLineNo">064</span> this.offset = offset;<a name="line.64"></a> -<span class="sourceLineNo">065</span> }<a name="line.65"></a> -<span class="sourceLineNo">066</span><a name="line.66"></a> -<span class="sourceLineNo">067</span> /**<a name="line.67"></a> -<span class="sourceLineNo">068</span> * Initializes filter with a string/bookmark based offset and limit. The offset is arrived<a name="line.68"></a> -<span class="sourceLineNo">069</span> * at, by seeking to it using scanner hints. If multiple column families are involved,<a name="line.69"></a> -<span class="sourceLineNo">070</span> * pagination starts at the first column family which contains @columnOffset. Columns are<a name="line.70"></a> -<span class="sourceLineNo">071</span> * then retrieved sequentially upto @limit number of columns which maybe spread across<a name="line.71"></a> -<span class="sourceLineNo">072</span> * multiple column families, depending on how the scan is setup.<a name="line.72"></a> -<span class="sourceLineNo">073</span> *<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @param limit Max number of columns to return.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @param columnOffset The string/bookmark offset on where to start pagination.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> public ColumnPaginationFilter(final int limit, final byte[] columnOffset) {<a name="line.77"></a> -<span class="sourceLineNo">078</span> Preconditions.checkArgument(limit >= 0, "limit must be positive %s", limit);<a name="line.78"></a> -<span class="sourceLineNo">079</span> Preconditions.checkArgument(columnOffset != null,<a name="line.79"></a> -<span class="sourceLineNo">080</span> "columnOffset must be non-null %s",<a name="line.80"></a> -<span class="sourceLineNo">081</span> columnOffset);<a name="line.81"></a> -<span class="sourceLineNo">082</span> this.limit = limit;<a name="line.82"></a> -<span class="sourceLineNo">083</span> this.columnOffset = columnOffset;<a name="line.83"></a> -<span class="sourceLineNo">084</span> }<a name="line.84"></a> -<span class="sourceLineNo">085</span><a name="line.85"></a> -<span class="sourceLineNo">086</span> /**<a name="line.86"></a> -<span class="sourceLineNo">087</span> * @return limit<a name="line.87"></a> -<span class="sourceLineNo">088</span> */<a name="line.88"></a> -<span class="sourceLineNo">089</span> public int getLimit() {<a name="line.89"></a> -<span class="sourceLineNo">090</span> return limit;<a name="line.90"></a> -<span class="sourceLineNo">091</span> }<a name="line.91"></a> -<span class="sourceLineNo">092</span><a name="line.92"></a> -<span class="sourceLineNo">093</span> /**<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @return offset<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> public int getOffset() {<a name="line.96"></a> -<span class="sourceLineNo">097</span> return offset;<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span><a name="line.99"></a> -<span class="sourceLineNo">100</span> /**<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @return columnOffset<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> public byte[] getColumnOffset() {<a name="line.103"></a> -<span class="sourceLineNo">104</span> return columnOffset;<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> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<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 filterKeyValue(Cell v)<a name="line.114"></a> -<span class="sourceLineNo">115</span> {<a name="line.115"></a> -<span class="sourceLineNo">116</span> if (columnOffset != null) {<a name="line.116"></a> -<span class="sourceLineNo">117</span> if (count >= limit) {<a name="line.117"></a> -<span class="sourceLineNo">118</span> return ReturnCode.NEXT_ROW;<a name="line.118"></a> -<span class="sourceLineNo">119</span> }<a name="line.119"></a> -<span class="sourceLineNo">120</span> int cmp = 0;<a name="line.120"></a> -<span class="sourceLineNo">121</span> // Only compare if no KV's have been seen so far.<a name="line.121"></a> -<span class="sourceLineNo">122</span> if (count == 0) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> cmp = CellComparator.compareQualifiers(v, this.columnOffset, 0, this.columnOffset.length);<a name="line.123"></a> -<span class="sourceLineNo">124</span> }<a name="line.124"></a> -<span class="sourceLineNo">125</span> if (cmp < 0) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.126"></a> -<span class="sourceLineNo">127</span> } else {<a name="line.127"></a> -<span class="sourceLineNo">128</span> count++;<a name="line.128"></a> -<span class="sourceLineNo">129</span> return ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.129"></a> -<span class="sourceLineNo">130</span> }<a name="line.130"></a> -<span class="sourceLineNo">131</span> } else {<a name="line.131"></a> -<span class="sourceLineNo">132</span> if (count >= offset + limit) {<a name="line.132"></a> -<span class="sourceLineNo">133</span> return ReturnCode.NEXT_ROW;<a name="line.133"></a> -<span class="sourceLineNo">134</span> }<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> ReturnCode code = count < offset ? ReturnCode.NEXT_COL :<a name="line.136"></a> -<span class="sourceLineNo">137</span> ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.137"></a> -<span class="sourceLineNo">138</span> count++;<a name="line.138"></a> -<span class="sourceLineNo">139</span> return code;<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> @Override<a name="line.143"></a> -<span class="sourceLineNo">144</span> public Cell getNextCellHint(Cell cell) {<a name="line.144"></a> -<span class="sourceLineNo">145</span> return CellUtil.createFirstOnRowCol(cell, columnOffset, 0, columnOffset.length);<a name="line.145"></a> -<span class="sourceLineNo">146</span> }<a name="line.146"></a> -<span class="sourceLineNo">147</span><a name="line.147"></a> -<span class="sourceLineNo">148</span> @Override<a name="line.148"></a> -<span class="sourceLineNo">149</span> public void reset()<a name="line.149"></a> -<span class="sourceLineNo">150</span> {<a name="line.150"></a> -<span class="sourceLineNo">151</span> this.count = 0;<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> public static Filter createFilterFromArguments(ArrayList<byte []> filterArguments) {<a name="line.154"></a> -<span class="sourceLineNo">155</span> Preconditions.checkArgument(filterArguments.size() == 2,<a name="line.155"></a> -<span class="sourceLineNo">156</span> "Expected 2 but got: %s", filterArguments.size());<a name="line.156"></a> -<span class="sourceLineNo">157</span> int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));<a name="line.157"></a> -<span class="sourceLineNo">158</span> int offset = ParseFilter.convertByteArrayToInt(filterArguments.get(1));<a name="line.158"></a> -<span class="sourceLineNo">159</span> return new ColumnPaginationFilter(limit, offset);<a name="line.159"></a> -<span class="sourceLineNo">160</span> }<a name="line.160"></a> -<span class="sourceLineNo">161</span><a name="line.161"></a> -<span class="sourceLineNo">162</span> /**<a name="line.162"></a> -<span class="sourceLineNo">163</span> * @return The filter serialized using pb<a name="line.163"></a> -<span class="sourceLineNo">164</span> */<a name="line.164"></a> -<span class="sourceLineNo">165</span> public byte [] toByteArray() {<a name="line.165"></a> -<span class="sourceLineNo">166</span> FilterProtos.ColumnPaginationFilter.Builder builder =<a name="line.166"></a> -<span class="sourceLineNo">167</span> FilterProtos.ColumnPaginationFilter.newBuilder();<a name="line.167"></a> -<span class="sourceLineNo">168</span> builder.setLimit(this.limit);<a name="line.168"></a> -<span class="sourceLineNo">169</span> if (this.offset >= 0) {<a name="line.169"></a> -<span class="sourceLineNo">170</span> builder.setOffset(this.offset);<a name="line.170"></a> -<span class="sourceLineNo">171</span> }<a name="line.171"></a> -<span class="sourceLineNo">172</span> if (this.columnOffset != null) {<a name="line.172"></a> -<span class="sourceLineNo">173</span> builder.setColumnOffset(UnsafeByteOperations.unsafeWrap(this.columnOffset));<a name="line.173"></a> -<span class="sourceLineNo">174</span> }<a name="line.174"></a> -<span class="sourceLineNo">175</span> return builder.build().toByteArray();<a name="line.175"></a> -<span class="sourceLineNo">176</span> }<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @param pbBytes A pb serialized {@link ColumnPaginationFilter} instance<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return An instance of {@link ColumnPaginationFilter} made from <code>bytes</code><a name="line.180"></a> -<span class="sourceLineNo">181</span> * @throws DeserializationException<a name="line.181"></a> -<span class="sourceLineNo">182</span> * @see #toByteArray<a name="line.182"></a> -<span class="sourceLineNo">183</span> */<a name="line.183"></a> -<span class="sourceLineNo">184</span> public static ColumnPaginationFilter parseFrom(final byte [] pbBytes)<a name="line.184"></a> -<span class="sourceLineNo">185</span> throws DeserializationException {<a name="line.185"></a> -<span class="sourceLineNo">186</span> FilterProtos.ColumnPaginationFilter proto;<a name="line.186"></a> -<span class="sourceLineNo">187</span> try {<a name="line.187"></a> -<span class="sourceLineNo">188</span> proto = FilterProtos.ColumnPaginationFilter.parseFrom(pbBytes);<a name="line.188"></a> -<span class="sourceLineNo">189</span> } catch (InvalidProtocolBufferException e) {<a name="line.189"></a> -<span class="sourceLineNo">190</span> throw new DeserializationException(e);<a name="line.190"></a> -<span class="sourceLineNo">191</span> }<a name="line.191"></a> -<span class="sourceLineNo">192</span> if (proto.hasColumnOffset()) {<a name="line.192"></a> -<span class="sourceLineNo">193</span> return new ColumnPaginationFilter(proto.getLimit(),<a name="line.193"></a> -<span class="sourceLineNo">194</span> proto.getColumnOffset().toByteArray());<a name="line.194"></a> -<span class="sourceLineNo">195</span> }<a name="line.195"></a> -<span class="sourceLineNo">196</span> return new ColumnPaginationFilter(proto.getLimit(),proto.getOffset());<a name="line.196"></a> -<span class="sourceLineNo">197</span> }<a name="line.197"></a> -<span class="sourceLineNo">198</span><a name="line.198"></a> -<span class="sourceLineNo">199</span> /**<a name="line.199"></a> -<span class="sourceLineNo">200</span> * @param other<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @return true if and only if the fields of the filter that are serialized<a name="line.201"></a> -<span class="sourceLineNo">202</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.202"></a> -<span class="sourceLineNo">203</span> */<a name="line.203"></a> -<span class="sourceLineNo">204</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.204"></a> -<span class="sourceLineNo">205</span> if (o == this) return true;<a name="line.205"></a> -<span class="sourceLineNo">206</span> if (!(o instanceof ColumnPaginationFilter)) return false;<a name="line.206"></a> -<span class="sourceLineNo">207</span><a name="line.207"></a> -<span class="sourceLineNo">208</span> ColumnPaginationFilter other = (ColumnPaginationFilter)o;<a name="line.208"></a> -<span class="sourceLineNo">209</span> if (this.columnOffset != null) {<a name="line.209"></a> -<span class="sourceLineNo">210</span> return this.getLimit() == other.getLimit() &&<a name="line.210"></a> -<span class="sourceLineNo">211</span> Bytes.equals(this.getColumnOffset(), other.getColumnOffset());<a name="line.211"></a> -<span class="sourceLineNo">212</span> }<a name="line.212"></a> -<span class="sourceLineNo">213</span> return this.getLimit() == other.getLimit() && this.getOffset() == other.getOffset();<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 String toString() {<a name="line.217"></a> -<span class="sourceLineNo">218</span> if (this.columnOffset != null) {<a name="line.218"></a> -<span class="sourceLineNo">219</span> return (this.getClass().getSimpleName() + "(" + this.limit + ", " +<a name="line.219"></a> -<span class="sourceLineNo">220</span> Bytes.toStringBinary(this.columnOffset) + ")");<a name="line.220"></a> -<span class="sourceLineNo">221</span> }<a name="line.221"></a> -<span class="sourceLineNo">222</span> return String.format("%s (%d, %d)", this.getClass().getSimpleName(),<a name="line.222"></a> -<span class="sourceLineNo">223</span> this.limit, this.offset);<a name="line.223"></a> -<span class="sourceLineNo">224</span> }<a name="line.224"></a> -<span class="sourceLineNo">225</span>}<a name="line.225"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.29"></a> +<span class="sourceLineNo">030</span><a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferException;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.UnsafeByteOperations;<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span>/**<a name="line.35"></a> +<span class="sourceLineNo">036</span> * A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.<a name="line.36"></a> +<span class="sourceLineNo">037</span> * This filter can be used for row-based indexing, where references to other tables are stored across many columns,<a name="line.37"></a> +<span class="sourceLineNo">038</span> * in order to efficient lookups and paginated results for end users. Only most recent versions are considered<a name="line.38"></a> +<span class="sourceLineNo">039</span> * for pagination.<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span>@InterfaceAudience.Public<a name="line.41"></a> +<span class="sourceLineNo">042</span>public class ColumnPaginationFilter extends FilterBase {<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> +<span class="sourceLineNo">044</span> private int limit = 0;<a name="line.44"></a> +<span class="sourceLineNo">045</span> private int offset = -1;<a name="line.45"></a> +<span class="sourceLineNo">046</span> private byte[] columnOffset = null;<a name="line.46"></a> +<span class="sourceLineNo">047</span> private int count = 0;<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span> /**<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Initializes filter with an integer offset and limit. The offset is arrived at<a name="line.50"></a> +<span class="sourceLineNo">051</span> * scanning sequentially and skipping entries. @limit number of columns are<a name="line.51"></a> +<span class="sourceLineNo">052</span> * then retrieved. If multiple column families are involved, the columns may be spread<a name="line.52"></a> +<span class="sourceLineNo">053</span> * across them.<a name="line.53"></a> +<span class="sourceLineNo">054</span> *<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @param limit Max number of columns to return.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param offset The integer offset where to start pagination.<a name="line.56"></a> +<span class="sourceLineNo">057</span> */<a name="line.57"></a> +<span class="sourceLineNo">058</span> public ColumnPaginationFilter(final int limit, final int offset)<a name="line.58"></a> +<span class="sourceLineNo">059</span> {<a name="line.59"></a> +<span class="sourceLineNo">060</span> Preconditions.checkArgument(limit >= 0, "limit must be positive %s", limit);<a name="line.60"></a> +<span class="sourceLineNo">061</span> Preconditions.checkArgument(offset >= 0, "offset must be positive %s", offset);<a name="line.61"></a> +<span class="sourceLineNo">062</span> this.limit = limit;<a name="line.62"></a> +<span class="sourceLineNo">063</span> this.offset = offset;<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> /**<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Initializes filter with a string/bookmark based offset and limit. The offset is arrived<a name="line.67"></a> +<span class="sourceLineNo">068</span> * at, by seeking to it using scanner hints. If multiple column families are involved,<a name="line.68"></a> +<span class="sourceLineNo">069</span> * pagination starts at the first column family which contains @columnOffset. Columns are<a name="line.69"></a> +<span class="sourceLineNo">070</span> * then retrieved sequentially upto @limit number of columns which maybe spread across<a name="line.70"></a> +<span class="sourceLineNo">071</span> * multiple column families, depending on how the scan is setup.<a name="line.71"></a> +<span class="sourceLineNo">072</span> *<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param limit Max number of columns to return.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @param columnOffset The string/bookmark offset on where to start pagination.<a name="line.74"></a> +<span class="sourceLineNo">075</span> */<a name="line.75"></a> +<span class="sourceLineNo">076</span> public ColumnPaginationFilter(final int limit, final byte[] columnOffset) {<a name="line.76"></a> +<span class="sourceLineNo">077</span> Preconditions.checkArgument(limit >= 0, "limit must be positive %s", limit);<a name="line.77"></a> +<span class="sourceLineNo">078</span> Preconditions.checkArgument(columnOffset != null,<a name="line.78"></a> +<span class="sourceLineNo">079</span> "columnOffset must be non-null %s",<a name="line.79"></a> +<span class="sourceLineNo">080</span> columnOffset);<a name="line.80"></a> +<span class="sourceLineNo">081</span> this.limit = limit;<a name="line.81"></a> +<span class="sourceLineNo">082</span> this.columnOffset = columnOffset;<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> /**<a name="line.85"></a> +<span class="sourceLineNo">086</span> * @return limit<a name="line.86"></a> +<span class="sourceLineNo">087</span> */<a name="line.87"></a> +<span class="sourceLineNo">088</span> public int getLimit() {<a name="line.88"></a> +<span class="sourceLineNo">089</span> return limit;<a name="line.89"></a> +<span class="sourceLineNo">090</span> }<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> /**<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @return offset<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> public int getOffset() {<a name="line.95"></a> +<span class="sourceLineNo">096</span> return offset;<a name="line.96"></a> +<span class="sourceLineNo">097</span> }<a name="line.97"></a> +<span class="sourceLineNo">098</span><a name="line.98"></a> +<span class="sourceLineNo">099</span> /**<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @return columnOffset<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> public byte[] getColumnOffset() {<a name="line.102"></a> +<span class="sourceLineNo">103</span> return columnOffset;<a name="line.103"></a> +<span class="sourceLineNo">104</span> }<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> @Override<a name="line.106"></a> +<span class="sourceLineNo">107</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.107"></a> +<span class="sourceLineNo">108</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<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 filterKeyValue(Cell v)<a name="line.113"></a> +<span class="sourceLineNo">114</span> {<a name="line.114"></a> +<span class="sourceLineNo">115</span> if (columnOffset != null) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> if (count >= limit) {<a name="line.116"></a> +<span class="sourceLineNo">117</span> return ReturnCode.NEXT_ROW;<a name="line.117"></a> +<span class="sourceLineNo">118</span> }<a name="line.118"></a> +<span class="sourceLineNo">119</span> int cmp = 0;<a name="line.119"></a> +<span class="sourceLineNo">120</span> // Only compare if no KV's have been seen so far.<a name="line.120"></a> +<span class="sourceLineNo">121</span> if (count == 0) {<a name="line.121"></a> +<span class="sourceLineNo">122</span> cmp = CellUtil.compareQualifiers(v, this.columnOffset, 0, this.columnOffset.length);<a name="line.122"></a> +<span class="sourceLineNo">123</span> }<a name="line.123"></a> +<span class="sourceLineNo">124</span> if (cmp < 0) {<a name="line.124"></a> +<span class="sourceLineNo">125</span> return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.125"></a> +<span class="sourceLineNo">126</span> } else {<a name="line.126"></a> +<span class="sourceLineNo">127</span> count++;<a name="line.127"></a> +<span class="sourceLineNo">128</span> return ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.128"></a> +<span class="sourceLineNo">129</span> }<a name="line.129"></a> +<span class="sourceLineNo">130</span> } else {<a name="line.130"></a> +<span class="sourceLineNo">131</span> if (count >= offset + limit) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> return ReturnCode.NEXT_ROW;<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> ReturnCode code = count < offset ? ReturnCode.NEXT_COL :<a name="line.135"></a> +<span class="sourceLineNo">136</span> ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.136"></a> +<span class="sourceLineNo">137</span> count++;<a name="line.137"></a> +<span class="sourceLineNo">138</span> return code;<a name="line.138"></a> +<span class="sourceLineNo">139</span> }<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> @Override<a name="line.142"></a> +<span class="sourceLineNo">143</span> public Cell getNextCellHint(Cell cell) {<a name="line.143"></a> +<span class="sourceLineNo">144</span> return CellUtil.createFirstOnRowCol(cell, columnOffset, 0, columnOffset.length);<a name="line.144"></a> +<span class="sourceLineNo">145</span> }<a name="line.145"></a> +<span class="sourceLineNo">146</span><a name="line.146"></a> +<span class="sourceLineNo">147</span> @Override<a name="line.147"></a> +<span class="sourceLineNo">148</span> public void reset()<a name="line.148"></a> +<span class="sourceLineNo">149</span> {<a name="line.149"></a> +<span class="sourceLineNo">150</span> this.count = 0;<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> public static Filter createFilterFromArguments(ArrayList<byte []> filterArguments) {<a name="line.153"></a> +<span class="sourceLineNo">154</span> Preconditions.checkArgument(filterArguments.size() == 2,<a name="line.154"></a> +<span class="sourceLineNo">155</span> "Expected 2 but got: %s", filterArguments.size());<a name="line.155"></a> +<span class="sourceLineNo">156</span> int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));<a name="line.156"></a> +<span class="sourceLineNo">157</span> int offset = ParseFilter.convertByteArrayToInt(filterArguments.get(1));<a name="line.157"></a> +<span class="sourceLineNo">158</span> return new ColumnPaginationFilter(limit, offset);<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * @return The filter serialized using pb<a name="line.162"></a> +<span class="sourceLineNo">163</span> */<a name="line.163"></a> +<span class="sourceLineNo">164</span> public byte [] toByteArray() {<a name="line.164"></a> +<span class="sourceLineNo">165</span> FilterProtos.ColumnPaginationFilter.Builder builder =<a name="line.165"></a> +<span class="sourceLineNo">166</span> FilterProtos.ColumnPaginationFilter.newBuilder();<a name="line.166"></a> +<span class="sourceLineNo">167</span> builder.setLimit(this.limit);<a name="line.167"></a> +<span class="sourceLineNo">168</span> if (this.offset >= 0) {<a name="line.168"></a> +<span class="sourceLineNo">169</span> builder.setOffset(this.offset);<a name="line.169"></a> +<span class="sourceLineNo">170</span> }<a name="line.170"></a> +<span class="sourceLineNo">171</span> if (this.columnOffset != null) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> builder.setColumnOffset(UnsafeByteOperations.unsafeWrap(this.columnOffset));<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span> return builder.build().toByteArray();<a name="line.174"></a> +<span class="sourceLineNo">175</span> }<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> /**<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @param pbBytes A pb serialized {@link ColumnPaginationFilter} instance<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @return An instance of {@link ColumnPaginationFilter} made from <code>bytes</code><a name="line.179"></a> +<span class="sourceLineNo">180</span> * @throws DeserializationException<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @see #toByteArray<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> public static ColumnPaginationFilter parseFrom(final byte [] pbBytes)<a name="line.183"></a> +<span class="sourceLineNo">184</span> throws DeserializationException {<a name="line.184"></a> +<span class="sourceLineNo">185</span> FilterProtos.ColumnPaginationFilter proto;<a name="line.185"></a> +<span class="sourceLineNo">186</span> try {<a name="line.186"></a> +<span class="sourceLineNo">187</span> proto = FilterProtos.ColumnPaginationFilter.parseFrom(pbBytes);<a name="line.187"></a> +<span class="sourceLineNo">188</span> } catch (InvalidProtocolBufferException e) {<a name="line.188"></a> +<span class="sourceLineNo">189</span> throw new DeserializationException(e);<a name="line.189"></a> +<span class="sourceLineNo">190</span> }<a name="line.190"></a> +<span class="sourceLineNo">191</span> if (proto.hasColumnOffset()) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> return new ColumnPaginationFilter(proto.getLimit(),<a name="line.192"></a> +<span class="sourceLineNo">193</span> proto.getColumnOffset().toByteArray());<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span> return new ColumnPaginationFilter(proto.getLimit(),proto.getOffset());<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> /**<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param other<a name="line.199"></a> +<span class="sourceLineNo">200</span> * @return true if and only if the fields of the filter that are serialized<a name="line.200"></a> +<span class="sourceLineNo">201</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.201"></a> +<span class="sourceLineNo">202</span> */<a name="line.202"></a> +<span class="sourceLineNo">203</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.203"></a> +<span class="sourceLineNo">204</span> if (o == this) return true;<a name="line.204"></a> +<span class="sourceLineNo">205</span> if (!(o instanceof ColumnPaginationFilter)) return false;<a name="line.205"></a> +<span class="sourceLineNo">206</span><a name="line.206"></a> +<span class="sourceLineNo">207</span> ColumnPaginationFilter other = (ColumnPaginationFilter)o;<a name="line.207"></a> +<span class="sourceLineNo">208</span> if (this.columnOffset != null) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> return this.getLimit() == other.getLimit() &&<a name="line.209"></a> +<span class="sourceLineNo">210</span> Bytes.equals(this.getColumnOffset(), other.getColumnOffset());<a name="line.210"></a> +<span class="sourceLineNo">211</span> }<a name="line.211"></a> +<span class="sourceLineNo">212</span> return this.getLimit() == other.getLimit() && this.getOffset() == other.getOffset();<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> public String toString() {<a name="line.216"></a> +<span class="sourceLineNo">217</span> if (this.columnOffset != null) {<a name="line.217"></a> +<span class="sourceLineNo">218</span> return (this.getClass().getSimpleName() + "(" + this.limit + ", " +<a name="line.218"></a> +<span class="sourceLineNo">219</span> Bytes.toStringBinary(this.columnOffset) + ")");<a name="line.219"></a> +<span class="sourceLineNo">220</span> }<a name="line.220"></a> +<span class="sourceLineNo">221</span> return String.format("%s (%d, %d)", this.getClass().getSimpleName(),<a name="line.221"></a> +<span class="sourceLineNo">222</span> this.limit, this.offset);<a name="line.222"></a> +<span class="sourceLineNo">223</span> }<a name="line.223"></a> +<span class="sourceLineNo">224</span>}<a name="line.224"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ed0004f8/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html index e554659..08ef551 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html @@ -33,211 +33,210 @@ <span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a> <span class="sourceLineNo">026</span><a name="line.26"></a> <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Cell;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferException;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.UnsafeByteOperations;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.Bytes;<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.com.google.common.base.Preconditions;<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span>/**<a name="line.39"></a> -<span class="sourceLineNo">040</span> * This filter is used for selecting only those keys with columns that are<a name="line.40"></a> -<span class="sourceLineNo">041</span> * between minColumn to maxColumn. For example, if minColumn is 'an', and<a name="line.41"></a> -<span class="sourceLineNo">042</span> * maxColumn is 'be', it will pass keys with columns like 'ana', 'bad', but not<a name="line.42"></a> -<span class="sourceLineNo">043</span> * keys with columns like 'bed', 'eye'<a name="line.43"></a> -<span class="sourceLineNo">044</span> *<a name="line.44"></a> -<span class="sourceLineNo">045</span> * If minColumn is null, there is no lower bound. If maxColumn is null, there is<a name="line.45"></a> -<span class="sourceLineNo">046</span> * no upper bound.<a name="line.46"></a> -<span class="sourceLineNo">047</span> *<a name="line.47"></a> -<span class="sourceLineNo">048</span> * minColumnInclusive and maxColumnInclusive specify if the ranges are inclusive<a name="line.48"></a> -<span class="sourceLineNo">049</span> * or not.<a name="line.49"></a> -<span class="sourceLineNo">050</span> */<a name="line.50"></a> -<span class="sourceLineNo">051</span>@InterfaceAudience.Public<a name="line.51"></a> -<span class="sourceLineNo">052</span>public class ColumnRangeFilter extends FilterBase {<a name="line.52"></a> -<span class="sourceLineNo">053</span> protected byte[] minColumn = null;<a name="line.53"></a> -<span class="sourceLineNo">054</span> protected boolean minColumnInclusive = true;<a name="line.54"></a> -<span class="sourceLineNo">055</span> protected byte[] maxColumn = null;<a name="line.55"></a> -<span class="sourceLineNo">056</span> protected boolean maxColumnInclusive = false;<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> * Create a filter to select those keys with columns that are between minColumn<a name="line.59"></a> -<span class="sourceLineNo">060</span> * and maxColumn.<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @param minColumn minimum value for the column range. If if it's null,<a name="line.61"></a> -<span class="sourceLineNo">062</span> * there is no lower bound.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @param minColumnInclusive if true, include minColumn in the range.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * @param maxColumn maximum value for the column range. If it's null,<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @param maxColumnInclusive if true, include maxColumn in the range.<a name="line.65"></a> -<span class="sourceLineNo">066</span> * there is no upper bound.<a name="line.66"></a> -<span class="sourceLineNo">067</span> */<a name="line.67"></a> -<span class="sourceLineNo">068</span> public ColumnRangeFilter(final byte[] minColumn, boolean minColumnInclusive,<a name="line.68"></a> -<span class="sourceLineNo">069</span> final byte[] maxColumn, boolean maxColumnInclusive) {<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.minColumn = minColumn;<a name="line.70"></a> -<span class="sourceLineNo">071</span> this.minColumnInclusive = minColumnInclusive;<a name="line.71"></a> -<span class="sourceLineNo">072</span> this.maxColumn = maxColumn;<a name="line.72"></a> -<span class="sourceLineNo">073</span> this.maxColumnInclusive = maxColumnInclusive;<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> /**<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @return if min column range is inclusive.<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> public boolean isMinColumnInclusive() {<a name="line.79"></a> -<span class="sourceLineNo">080</span> return minColumnInclusive;<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> /**<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @return if max column range is inclusive.<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> public boolean isMaxColumnInclusive() {<a name="line.86"></a> -<span class="sourceLineNo">087</span> return maxColumnInclusive;<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> /**<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @return the min column range for the filter<a name="line.91"></a> -<span class="sourceLineNo">092</span> */<a name="line.92"></a> -<span class="sourceLineNo">093</span> public byte[] getMinColumn() {<a name="line.93"></a> -<span class="sourceLineNo">094</span> return this.minColumn;<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> /**<a name="line.97"></a> -<span class="sourceLineNo">098</span> * @return true if min column is inclusive, false otherwise<a name="line.98"></a> -<span class="sourceLineNo">099</span> */<a name="line.99"></a> -<span class="sourceLineNo">100</span> public boolean getMinColumnInclusive() {<a name="line.100"></a> -<span class="sourceLineNo">101</span> return this.minColumnInclusive;<a name="line.101"></a> -<span class="sourceLineNo">102</span> }<a name="line.102"></a> -<span class="sourceLineNo">103</span><a name="line.103"></a> -<span class="sourceLineNo">104</span> /**<a name="line.104"></a> -<span class="sourceLineNo">105</span> * @return the max column range for the filter<a name="line.105"></a> -<span class="sourceLineNo">106</span> */<a name="line.106"></a> -<span class="sourceLineNo">107</span> public byte[] getMaxColumn() {<a name="line.107"></a> -<span class="sourceLineNo">108</span> return this.maxColumn;<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<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> * @return true if max column is inclusive, false otherwise<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> public boolean getMaxColumnInclusive() {<a name="line.114"></a> -<span class="sourceLineNo">115</span> return this.maxColumnInclusive;<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> @Override<a name="line.118"></a> -<span class="sourceLineNo">119</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.119"></a> -<span class="sourceLineNo">120</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.120"></a> -<span class="sourceLineNo">121</span> return false;<a name="line.121"></a> -<span class="sourceLineNo">122</span> }<a name="line.122"></a> -<span class="sourceLineNo">123</span><a name="line.123"></a> -<span class="sourceLineNo">124</span> @Override<a name="line.124"></a> -<span class="sourceLineNo">125</span> public ReturnCode filterKeyValue(Cell kv) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> int cmpMin = 1;<a name="line.126"></a> -<span class="sourceLineNo">127</span><a name="line.127"></a> -<span class="sourceLineNo">128</span> if (this.minColumn != null) {<a name="line.128"></a> -<span class="sourceLineNo">129</span> cmpMin = CellComparator.compareQualifiers(kv, this.minColumn, 0, this.minColumn.length);<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> if (cmpMin < 0) {<a name="line.132"></a> -<span class="sourceLineNo">133</span> return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.133"></a> -<span class="sourceLineNo">134</span> }<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> if (!this.minColumnInclusive && cmpMin == 0) {<a name="line.136"></a> -<span class="sourceLineNo">137</span> return ReturnCode.NEXT_COL;<a name="line.137"></a> -<span class="sourceLineNo">138</span> }<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> if (this.maxColumn == null) {<a name="line.140"></a> -<span class="sourceLineNo">141</span> return ReturnCode.INCLUDE;<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> int cmpMax = CellComparator.compareQualifiers(kv, this.maxColumn, 0, this.maxColumn.length);<a name="line.144"></a> -<span class="sourceLineNo">145</span><a name="line.145"></a> -<span class="sourceLineNo">146</span> if (this.maxColumnInclusive && cmpMax <= 0 ||<a name="line.146"></a> -<span class="sourceLineNo">147</span> !this.maxColumnInclusive && cmpMax < 0) {<a name="line.147"></a> -<span class="sourceLineNo">148</span> return ReturnCode.INCLUDE;<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 ReturnCode.NEXT_ROW;<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> public static Filter createFilterFromArguments(ArrayList<byte []> filterArguments) {<a name="line.154"></a> -<span class="sourceLineNo">155</span> Preconditions.checkArgument(filterArguments.size() == 4,<a name="line.155"></a> -<span class="sourceLineNo">156</span> "Expected 4 but got: %s", filterArguments.size());<a name="line.156"></a> -<span class="sourceLineNo">157</span> byte [] minColumn = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a name="line.157"></a> -<span class="sourceLineNo">158</span> boolean minColumnInclusive = ParseFilter.convertByteArrayToBoolean(filterArguments.get(1));<a name="line.158"></a> -<span class="sourceLineNo">159</span> byte [] maxColumn = ParseFilter.removeQuotesFromByteArray(filterArguments.get(2));<a name="line.159"></a> -<span class="sourceLineNo">160</span> boolean maxColumnInclusive = ParseFilter.convertByteArrayToBoolean(filterArguments.get(3));<a name="line.160"></a> -<span class="sourceLineNo">161</span><a name="line.161"></a> -<span class="sourceLineNo">162</span> if (minColumn.length == 0)<a name="line.162"></a> -<span class="sourceLineNo">163</span> minColumn = null;<a name="line.163"></a> -<span class="sourceLineNo">164</span> if (maxColumn.length == 0)<a name="line.164"></a> -<span class="sourceLineNo">165</span> maxColumn = null;<a name="line.165"></a> -<span class="sourceLineNo">166</span> return new ColumnRangeFilter(minColumn, minColumnInclusive,<a name="line.166"></a> -<span class="sourceLineNo">167</span> maxColumn, maxColumnInclusive);<a name="line.167"></a> -<span class="sourceLineNo">168</span> }<a name="line.168"></a> -<span class="sourceLineNo">169</span><a name="line.169"></a> -<span class="sourceLineNo">170</span> /**<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @return The filter serialized using pb<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> public byte [] toByteArray() {<a name="line.173"></a> -<span class="sourceLineNo">174</span> FilterProtos.ColumnRangeFilter.Builder builder =<a name="line.174"></a> -<span class="sourceLineNo">175</span> FilterProtos.ColumnRangeFilter.newBuilder();<a name="line.175"></a> -<span class="sourceLineNo">176</span> if (this.minColumn != null) builder.setMinColumn(<a name="line.176"></a> -<span class="sourceLineNo">177</span> UnsafeByteOperations.unsafeWrap(this.minColumn));<a name="line.177"></a> -<span class="sourceLineNo">178</span> builder.setMinColumnInclusive(this.minColumnInclusive);<a name="line.178"></a> -<span class="sourceLineNo">179</span> if (this.maxColumn != null) builder.setMaxColumn(<a name="line.179"></a> -<span class="sourceLineNo">180</span> UnsafeByteOperations.unsafeWrap(this.maxColumn));<a name="line.180"></a> -<span class="sourceLineNo">181</span> builder.setMaxColumnInclusive(this.maxColumnInclusive);<a name="line.181"></a> -<span class="sourceLineNo">182</span> return builder.build().toByteArray();<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> * @param pbBytes A pb serialized {@link ColumnRangeFilter} instance<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @return An instance of {@link ColumnRangeFilter} made from <code>bytes</code><a name="line.187"></a> -<span class="sourceLineNo">188</span> * @throws DeserializationException<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @see #toByteArray<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> public static ColumnRangeFilter parseFrom(final byte [] pbBytes)<a name="line.191"></a> -<span class="sourceLineNo">192</span> throws DeserializationException {<a name="line.192"></a> -<span class="sourceLineNo">193</span> FilterProtos.ColumnRangeFilter proto;<a name="line.193"></a> -<span class="sourceLineNo">194</span> try {<a name="line.194"></a> -<span class="sourceLineNo">195</span> proto = FilterProtos.ColumnRangeFilter.parseFrom(pbBytes);<a name="line.195"></a> -<span class="sourceLineNo">196</span> } catch (InvalidProtocolBufferException e) {<a name="line.196"></a> -<span class="sourceLineNo">197</span> throw new DeserializationException(e);<a name="line.197"></a> -<span class="sourceLineNo">198</span> }<a name="line.198"></a> -<span class="sourceLineNo">199</span> return new ColumnRangeFilter(proto.hasMinColumn()?proto.getMinColumn().toByteArray():null,<a name="line.199"></a> -<span class="sourceLineNo">200</span> proto.getMinColumnInclusive(),proto.hasMaxColumn()?proto.getMaxColumn().toByteArray():null,<a name="line.200"></a> -<span class="sourceLineNo">201</span> proto.getMaxColumnInclusive());<a name="line.201"></a> -<span class="sourceLineNo">202</span> }<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> * @param other<a name="line.205"></a> -<span class="sourceLineNo">206</span> * @return true if and only if the fields of the filter that are serialized<a name="line.206"></a> -<span class="sourceLineNo">207</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.209"></a> -<span class="sourceLineNo">210</span> if (o == this) return true;<a name="line.210"></a> -<span class="sourceLineNo">211</span> if (!(o instanceof ColumnRangeFilter)) return false;<a name="line.211"></a> -<span class="sourceLineNo">212</span><a name="line.212"></a> -<span class="sourceLineNo">213</span> ColumnRangeFilter other = (ColumnRangeFilter)o;<a name="line.213"></a> -<span class="sourceLineNo">214</span> return Bytes.equals(this.getMinColumn(),other.getMinColumn())<a name="line.214"></a> -<span class="sourceLineNo">215</span> && this.getMinColumnInclusive() == other.getMinColumnInclusive()<a name="line.215"></a> -<span class="sourceLineNo">216</span> && Bytes.equals(this.getMaxColumn(), other.getMaxColumn())<a name="line.216"></a> -<span class="sourceLineNo">217</span> && this.getMaxColumnInclusive() == other.getMaxColumnInclusive();<a name="line.217"></a> -<span class="sourceLineNo">218</span> }<a name="line.218"></a> -<span class="sourceLineNo">219</span><a name="line.219"></a> -<span class="sourceLineNo">220</span> @Override<a name="line.220"></a> -<span class="sourceLineNo">221</span> public Cell getNextCellHint(Cell cell) {<a name="line.221"></a> -<span class="sourceLineNo">222</span> return CellUtil.createFirstOnRowCol(cell, this.minColumn, 0, len(this.minColumn));<a name="line.222"></a> -<span class="sourceLineNo">223</span> }<a name="line.223"></a> -<span class="sourceLineNo">224</span><a name="line.224"></a> -<span class="sourceLineNo">225</span> @Override<a name="line.225"></a> -<span class="sourceLineNo">226</span> public String toString() {<a name="line.226"></a> -<span class="sourceLineNo">227</span> return this.getClass().getSimpleName() + " "<a name="line.227"></a> -<span class="sourceLineNo">228</span> + (this.minColumnInclusive ? "[" : "(") + Bytes.toStringBinary(this.minColumn)<a name="line.228"></a> -<span class="sourceLineNo">229</span> + ", " + Bytes.toStringBinary(this.maxColumn)<a name="line.229"></a> -<span class="sourceLineNo">230</span> + (this.maxColumnInclusive ? "]" : ")");<a name="line.230"></a> -<span class="sourceLineNo">231</span> }<a name="line.231"></a> -<span class="sourceLineNo">232</span>}<a name="line.232"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferException;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.UnsafeByteOperations;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.protobuf.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><a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<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 are<a name="line.39"></a> +<span class="sourceLineNo">040</span> * between minColumn to maxColumn. For example, if minColumn is 'an', and<a name="line.40"></a> +<span class="sourceLineNo">041</span> * maxColumn is 'be', it will pass keys with columns like 'ana', 'bad', but not<a name="line.41"></a> +<span class="sourceLineNo">042</span> * keys with columns like 'bed', 'eye'<a name="line.42"></a> +<span class="sourceLineNo">043</span> *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * If minColumn is null, there is no lower bound. If maxColumn is null, there is<a name="line.44"></a> +<span class="sourceLineNo">045</span> * no upper bound.<a name="line.45"></a> +<span class="sourceLineNo">046</span> *<a name="line.46"></a> +<span class="sourceLineNo">047</span> * minColumnInclusive and maxColumnInclusive specify if the ranges are inclusive<a name="line.47"></a> +<span class="sourceLineNo">048</span> * or not.<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 ColumnRangeFilter extends FilterBase {<a name="line.51"></a> +<span class="sourceLineNo">052</span> protected byte[] minColumn = null;<a name="line.52"></a> +<span class="sourceLineNo">053</span> protected boolean minColumnInclusive = true;<a name="line.53"></a> +<span class="sourceLineNo">054</span> protected byte[] maxColumn = null;<a name="line.54"></a> +<span class="sourceLineNo">055</span> protected boolean maxColumnInclusive = false;<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> * Create a filter to select those keys with columns that are between minColumn<a name="line.58"></a> +<span class="sourceLineNo">059</span> * and maxColumn.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param minColumn minimum value for the column range. If if it's null,<a name="line.60"></a> +<span class="sourceLineNo">061</span> * there is no lower bound.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param minColumnInclusive if true, include minColumn in the range.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @param maxColumn maximum value for the column range. If it's null,<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param maxColumnInclusive if true, include maxColumn in the range.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * there is no upper bound.<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public ColumnRangeFilter(final byte[] minColumn, boolean minColumnInclusive,<a name="line.67"></a> +<span class="sourceLineNo">068</span> final byte[] maxColumn, boolean maxColumnInclusive) {<a name="line.68"></a> +<span class="sourceLineNo">069</span> this.minColumn = minColumn;<a name="line.69"></a> +<span class="sourceLineNo">070</span> this.minColumnInclusive = minColumnInclusive;<a name="line.70"></a> +<span class="sourceLineNo">071</span> this.maxColumn = maxColumn;<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.maxColumnInclusive = maxColumnInclusive;<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 if min column range is inclusive.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> public boolean isMinColumnInclusive() {<a name="line.78"></a> +<span class="sourceLineNo">079</span> return minColumnInclusive;<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 if max column range is inclusive.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> public boolean isMaxColumnInclusive() {<a name="line.85"></a> +<span class="sourceLineNo">086</span> return maxColumnInclusive;<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 min column range for the filter<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> public byte[] getMinColumn() {<a name="line.92"></a> +<span class="sourceLineNo">093</span> return this.minColumn;<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 true if min column is inclusive, false otherwise<a name="line.97"></a> +<span class="sourceLineNo">098</span> */<a name="line.98"></a> +<span class="sourceLineNo">099</span> public boolean getMinColumnInclusive() {<a name="line.99"></a> +<span class="sourceLineNo">100</span> return this.minColumnInclusive;<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> /**<a name="line.103"></a> +<span class="sourceLineNo">104</span> * @return the max column range for the filter<a name="line.104"></a> +<span class="sourceLineNo">105</span> */<a name="line.105"></a> +<span class="sourceLineNo">106</span> public byte[] getMaxColumn() {<a name="line.106"></a> +<span class="sourceLineNo">107</span> return this.maxColumn;<a name="line.107"></a> +<span class="sourceLineNo">108</span> }<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> /**<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return true if max column is inclusive, false otherwise<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> public boolean getMaxColumnInclusive() {<a name="line.113"></a> +<span class="sourceLineNo">114</span> return this.maxColumnInclusive;<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<a name="line.115"></a> +<span class="sourceLineNo">116</span><a name="line.116"></a> +<span class="sourceLineNo">117</span> @Override<a name="line.117"></a> +<span class="sourceLineNo">118</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.118"></a> +<span class="sourceLineNo">119</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.119"></a> +<span class="sourceLineNo">120</span> return false;<a name="line.120"></a> +<span class="sourceLineNo">121</span> }<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> @Override<a name="line.123"></a> +<span class="sourceLineNo">124</span> public ReturnCode filterKeyValue(Cell kv) {<a name="line.124"></a> +<span class="sourceLineNo">125</span> int cmpMin = 1;<a name="line.125"></a> +<span class="sourceLineNo">126</span><a name="line.126"></a> +<span class="sourceLineNo">127</span> if (this.minColumn != null) {<a name="line.127"></a> +<span class="sourceLineNo">128</span> cmpMin = CellUtil.compareQualifiers(kv, this.minColumn, 0, this.minColumn.length);<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> if (cmpMin < 0) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> if (!this.minColumnInclusive && cmpMin == 0) {<a name="line.135"></a> +<span class="sourceLineNo">136</span> return ReturnCode.NEXT_COL;<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> if (this.maxColumn == null) {<a name="line.139"></a> +<span class="sourceLineNo">140</span> return ReturnCode.INCLUDE;<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> int cmpMax = CellUtil.compareQualifiers(kv, this.maxColumn, 0, this.maxColumn.length);<a name="line.143"></a> +<span class="sourceLineNo">144</span><a name="line.144"></a> +<span class="sourceLineNo">145</span> if (this.maxColumnInclusive && cmpMax <= 0 ||<a name="line.145"></a> +<span class="sourceLineNo">146</span> !this.maxColumnInclusive && cmpMax < 0) {<a name="line.146"></a> +<span class="sourceLineNo">147</span> return ReturnCode.INCLUDE;<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> return ReturnCode.NEXT_ROW;<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> public static Filter createFilterFromArguments(ArrayList<byte []> filterArguments) {<a name="line.153"></a> +<span class="sourceLineNo">154</span> Preconditions.checkArgument(filterArguments.size() == 4,<a name="line.154"></a> +<span class="sourceLineNo">155</span> "Expected 4 but got: %s", filterArguments.size());<a name="line.155"></a> +<span class="sourceLineNo">156</span> byte [] minColumn = ParseFilter.removeQuotesFromByteArray(filterArguments.get(0));<a name="line.156"></a> +<span class="sourceLineNo">157</span> boolean minColumnInclusive = ParseFilter.convertByteArrayToBoolean(filterArguments.get(1));<a name="line.157"></a> +<span class="sourceLineNo">158</span> byte [] maxColumn = ParseFilter.removeQuotesFromByteArray(filterArguments.get(2));<a name="line.158"></a> +<span class="sourceLineNo">159</span> boolean maxColumnInclusive = ParseFilter.convertByteArrayToBoolean(filterArguments.get(3));<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> if (minColumn.length == 0)<a name="line.161"></a> +<span class="sourceLineNo">162</span> minColumn = null;<a name="line.162"></a> +<span class="sourceLineNo">163</span> if (maxColumn.length == 0)<a name="line.163"></a> +<span class="sourceLineNo">164</span> maxColumn = null;<a name="line.164"></a> +<span class="sourceLineNo">165</span> return new ColumnRangeFilter(minColumn, minColumnInclusive,<a name="line.165"></a> +<span class="sourceLineNo">166</span> maxColumn, maxColumnInclusive);<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 The filter serialized using pb<a name="line.170"></a> +<span class="sourceLineNo">171</span> */<a name="line.171"></a> +<span class="sourceLineNo">172</span> public byte [] toByteArray() {<a name="line.172"></a> +<span class="sourceLineNo">173</span> FilterProtos.ColumnRangeFilter.Builder builder =<a name="line.173"></a> +<span class="sourceLineNo">174</span> FilterProtos.ColumnRangeFilter.newBuilder();<a name="line.174"></a> +<span class="sourceLineNo">175</span> if (this.minColumn != null) builder.setMinColumn(<a name="line.175"></a> +<span class="sourceLineNo">176</span> UnsafeByteOperations.unsafeWrap(this.minColumn));<a name="line.176"></a> +<span class="sourceLineNo">177</span> builder.setMinColumnInclusive(this.minColumnInclusive);<a name="line.177"></a> +<span class="sourceLineNo">178</span> if (this.maxColumn != null) builder.setMaxColumn(<a name="line.178"></a> +<span class="sourceLineNo">179</span> UnsafeByteOperations.unsafeWrap(this.maxColumn));<a name="line.179"></a> +<span class="sourceLineNo">180</span> builder.setMaxColumnInclusive(this.maxColumnInclusive);<a name="line.180"></a> +<span class="sourceLineNo">181</span> return builder.build().toByteArray();<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> * @param pbBytes A pb serialized {@link ColumnRangeFilter} instance<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @return An instance of {@link ColumnRangeFilter} made from <code>bytes</code><a name="line.186"></a> +<span class="sourceLineNo">187</span> * @throws DeserializationException<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @see #toByteArray<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> public static ColumnRangeFilter parseFrom(final byte [] pbBytes)<a name="line.190"></a> +<span class="sourceLineNo">191</span> throws DeserializationException {<a name="line.191"></a> +<span class="sourceLineNo">192</span> FilterProtos.ColumnRangeFilter proto;<a name="line.192"></a> +<span class="sourceLineNo">193</span> try {<a name="line.193"></a> +<span class="sourceLineNo">194</span> proto = FilterProtos.ColumnRangeFilter.parseFrom(pbBytes);<a name="line.194"></a> +<span class="sourceLineNo">195</span> } catch (InvalidProtocolBufferException e) {<a name="line.195"></a> +<span class="sourceLineNo">196</span> throw new DeserializationException(e);<a name="line.196"></a> +<span class="sourceLineNo">197</span> }<a name="line.197"></a> +<span class="sourceLineNo">198</span> return new ColumnRangeFilter(proto.hasMinColumn()?proto.getMinColumn().toByteArray():null,<a name="line.198"></a> +<span class="sourceLineNo">199</span> proto.getMinColumnInclusive(),proto.hasMaxColumn()?proto.getMaxColumn().toByteArray():null,<a name="line.199"></a> +<span class="sourceLineNo">200</span> proto.getMaxColumnInclusive());<a name="line.200"></a> +<span class="sourceLineNo">201</span> }<a name="line.201"></a> +<span class="sourceLineNo">202</span><a name="line.202"></a> +<span class="sourceLineNo">203</span> /**<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @param other<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @return true if and only if the fields of the filter that are serialized<a name="line.205"></a> +<span class="sourceLineNo">206</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.206"></a> +<span class="sourceLineNo">207</span> */<a name="line.207"></a> +<span class="sourceLineNo">208</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> if (o == this) return true;<a name="line.209"></a> +<span class="sourceLineNo">210</span> if (!(o instanceof ColumnRangeFilter)) return false;<a name="line.210"></a> +<span class="sourceLineNo">211</span><a name="line.211"></a> +<span class="sourceLineNo">212</span> ColumnRangeFilter other = (ColumnRangeFilter)o;<a name="line.212"></a> +<span class="sourceLineNo">213</span> return Bytes.equals(this.getMinColumn(),other.getMinColumn())<a name="line.213"></a> +<span class="sourceLineNo">214</span> && this.getMinColumnInclusive() == other.getMinColumnInclusive()<a name="line.214"></a> +<span class="sourceLineNo">215</span> && Bytes.equals(this.getMaxColumn(), other.getMaxColumn())<a name="line.215"></a> +<span class="sourceLineNo">216</span> && this.getMaxColumnInclusive() == other.getMaxColumnInclusive();<a name="line.216"></a> +<span class="sourceLineNo">217</span> }<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> @Override<a name="line.219"></a> +<span class="sourceLineNo">220</span> public Cell getNextCellHint(Cell cell) {<a name="line.220"></a> +<span class="sourceLineNo">221</span> return CellUtil.createFirstOnRowCol(cell, this.minColumn, 0, len(this.minColumn));<a name="line.221"></a> +<span class="sourceLineNo">222</span> }<a name="line.222"></a> +<span class="sourceLineNo">223</span><a name="line.223"></a> +<span class="sourceLineNo">224</span> @Override<a name="line.224"></a> +<span class="sourceLineNo">225</span> public String toString() {<a name="line.225"></a> +<span class="sourceLineNo">226</span> return this.getClass().getSimpleName() + " "<a name="line.226"></a> +<span class="sourceLineNo">227</span> + (this.minColumnInclusive ? "[" : "(") + Bytes.toStringBinary(this.minColumn)<a name="line.227"></a> +<span class="sourceLineNo">228</span> + ", " + Bytes.toStringBinary(this.maxColumn)<a name="line.228"></a> +<span class="sourceLineNo">229</span> + (this.maxColumnInclusive ? "]" : ")");<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span>}<a name="line.231"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ed0004f8/apidocs/src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html index 07c10b3..a116d25 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html @@ -31,7 +31,7 @@ <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.CellComparator;<a name="line.26"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.26"></a> <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.27"></a> <span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a> <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.29"></a> @@ -145,7 +145,7 @@ <span class="sourceLineNo">137</span> if (compareOp == CompareOp.NO_OP) {<a name="line.137"></a> <span class="sourceLineNo">138</span> return true;<a name="line.138"></a> <span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span> int compareResult = CellComparator.compareRow(cell, comparator);<a name="line.140"></a> +<span class="sourceLineNo">140</span> int compareResult = CellUtil.compareRow(cell, comparator);<a name="line.140"></a> <span class="sourceLineNo">141</span> return compare(compareOp, compareResult);<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> @@ -154,7 +154,7 @@ <span class="sourceLineNo">146</span> if (op == CompareOperator.NO_OP) {<a name="line.146"></a> <span class="sourceLineNo">147</span> return true;<a name="line.147"></a> <span class="sourceLineNo">148</span> }<a name="line.148"></a> -<span class="sourceLineNo">149</span> int compareResult = CellComparator.compareRow(cell, comparator);<a name="line.149"></a> +<span class="sourceLineNo">149</span> int compareResult = CellUtil.compareRow(cell, comparator);<a name="line.149"></a> <span class="sourceLineNo">150</span> return compare(op, compareResult);<a name="line.150"></a> <span class="sourceLineNo">151</span> }<a name="line.151"></a> <span class="sourceLineNo">152</span><a name="line.152"></a> @@ -168,7 +168,7 @@ <span class="sourceLineNo">160</span> if (compareOp == CompareOp.NO_OP) {<a name="line.160"></a> <span class="sourceLineNo">161</span> return true;<a name="line.161"></a> <span class="sourceLineNo">162</span> }<a name="line.162"></a> -<span class="sourceLineNo">163</span> int compareResult = CellComparator.compareFamily(cell, comparator);<a name="line.163"></a> +<span class="sourceLineNo">163</span> int compareResult = CellUtil.compareFamily(cell, comparator);<a name="line.163"></a> <span class="sourceLineNo">164</span> return compare(compareOp, compareResult);<a name="line.164"></a> <span class="sourceLineNo">165</span> }<a name="line.165"></a> <span class="sourceLineNo">166</span><a name="line.166"></a> @@ -177,7 +177,7 @@ <span class="sourceLineNo">169</span> if (op == CompareOperator.NO_OP) {<a name="line.169"></a> <span class="sourceLineNo">170</span> return true;<a name="line.170"></a> <span class="sourceLineNo">171</span> }<a name="line.171"></a> -<span class="sourceLineNo">172</span> int compareResult = CellComparator.compareFamily(cell, comparator);<a name="line.172"></a> +<span class="sourceLineNo">172</span> int compareResult = CellUtil.compareFamily(cell, comparator);<a name="line.172"></a> <span class="sourceLineNo">173</span> return compare(op, compareResult);<a name="line.173"></a> <span class="sourceLineNo">174</span> }<a name="line.174"></a> <span class="sourceLineNo">175</span><a name="line.175"></a> @@ -192,7 +192,7 @@ <span class="sourceLineNo">184</span> if (compareOp == CompareOp.NO_OP) {<a name="line.184"></a> <span class="sourceLineNo">185</span> return true;<a name="line.185"></a> <span class="sourceLineNo">186</span> }<a name="line.186"></a> -<span class="sourceLineNo">187</span> int compareResult = CellComparator.compareQualifier(cell, comparator);<a name="line.187"></a> +<span class="sourceLineNo">187</span> int compareResult = CellUtil.compareQualifier(cell, comparator);<a name="line.187"></a> <span class="sourceLineNo">188</span> return compare(compareOp, compareResult);<a name="line.188"></a> <span class="sourceLineNo">189</span> }<a name="line.189"></a> <span class="sourceLineNo">190</span><a name="line.190"></a> @@ -202,7 +202,7 @@ <span class="sourceLineNo">194</span> if (op == CompareOperator.NO_OP) {<a name="line.194"></a> <span class="sourceLineNo">195</span> return true;<a name="line.195"></a> <span class="sourceLineNo">196</span> }<a name="line.196"></a> -<span class="sourceLineNo">197</span> int compareResult = CellComparator.compareQualifier(cell, comparator);<a name="line.197"></a> +<span class="sourceLineNo">197</span> int compareResult = CellUtil.compareQualifier(cell, comparator);<a name="line.197"></a> <span class="sourceLineNo">198</span> return compare(op, compareResult);<a name="line.198"></a> <span class="sourceLineNo">199</span> }<a name="line.199"></a> <span class="sourceLineNo">200</span><a name="line.200"></a> @@ -217,7 +217,7 @@ <span class="sourceLineNo">209</span> if (compareOp == CompareOp.NO_OP) {<a name="line.209"></a> <span class="sourceLineNo">210</span> return true;<a name="line.210"></a> <span class="sourceLineNo">211</span> }<a name="line.211"></a> -<span class="sourceLineNo">212</span> int compareResult = CellComparator.compareValue(cell, comparator);<a name="line.212"></a> +<span class="sourceLineNo">212</span> int compareResult = CellUtil.compareValue(cell, comparator);<a name="line.212"></a> <span class="sourceLineNo">213</span> return compare(compareOp, compareResult);<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> @@ -226,7 +226,7 @@ <span class="sourceLineNo">218</span> if (op == CompareOperator.NO_OP) {<a name="line.218"></a> <span class="sourceLineNo">219</span> return true;<a name="line.219"></a> <span class="sourceLineNo">220</span> }<a name="line.220"></a> -<span class="sourceLineNo">221</span> int compareResult = CellComparator.compareValue(cell, comparator);<a name="line.221"></a> +<span class="sourceLineNo">221</span> int compareResult = CellUtil.compareValue(cell, comparator);<a name="line.221"></a> <span class="sourceLineNo">222</span> return compare(op, compareResult);<a name="line.222"></a> <span class="sourceLineNo">223</span> }<a name="line.223"></a> <span class="sourceLineNo">224</span><a name="line.224"></a>
