http://git-wip-us.apache.org/repos/asf/hbase-site/blob/0cf79db0/apidocs/src-html/org/apache/hadoop/hbase/filter/SkipFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/SkipFilter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/SkipFilter.html index 9f62fe6..9a40948 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/SkipFilter.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/SkipFilter.html @@ -28,148 +28,163 @@ <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.filter;<a name="line.20"></a> <span class="sourceLineNo">021</span><a name="line.21"></a> <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> -<span class="sourceLineNo">023</span><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.yetus.audience.InterfaceAudience;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<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.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.29"></a> -<span class="sourceLineNo">030</span><a name="line.30"></a> -<span class="sourceLineNo">031</span>/**<a name="line.31"></a> -<span class="sourceLineNo">032</span> * A wrapper filter that filters an entire row if any of the Cell checks do<a name="line.32"></a> -<span class="sourceLineNo">033</span> * not pass.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * For example, if all columns in a row represent weights of different things,<a name="line.35"></a> -<span class="sourceLineNo">036</span> * with the values being the actual weights, and we want to filter out the<a name="line.36"></a> -<span class="sourceLineNo">037</span> * entire row if any of its weights are zero. In this case, we want to prevent<a name="line.37"></a> -<span class="sourceLineNo">038</span> * rows from being emitted if a single key is filtered. Combine this filter<a name="line.38"></a> -<span class="sourceLineNo">039</span> * with a {@link ValueFilter}:<a name="line.39"></a> -<span class="sourceLineNo">040</span> * </p><a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * <code><a name="line.42"></a> -<span class="sourceLineNo">043</span> * scan.setFilter(new SkipFilter(new ValueFilter(CompareOp.NOT_EQUAL,<a name="line.43"></a> -<span class="sourceLineNo">044</span> * new BinaryComparator(Bytes.toBytes(0))));<a name="line.44"></a> -<span class="sourceLineNo">045</span> * </code><a name="line.45"></a> -<span class="sourceLineNo">046</span> * Any row which contained a column whose value was 0 will be filtered out<a name="line.46"></a> -<span class="sourceLineNo">047</span> * (since ValueFilter will not pass that Cell).<a name="line.47"></a> -<span class="sourceLineNo">048</span> * Without this filter, the other non-zero valued columns in the row would still<a name="line.48"></a> -<span class="sourceLineNo">049</span> * be emitted.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * </p><a name="line.50"></a> -<span class="sourceLineNo">051</span> */<a name="line.51"></a> -<span class="sourceLineNo">052</span>@InterfaceAudience.Public<a name="line.52"></a> -<span class="sourceLineNo">053</span>public class SkipFilter extends FilterBase {<a name="line.53"></a> -<span class="sourceLineNo">054</span> private boolean filterRow = false;<a name="line.54"></a> -<span class="sourceLineNo">055</span> private Filter filter;<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> public SkipFilter(Filter filter) {<a name="line.57"></a> -<span class="sourceLineNo">058</span> this.filter = filter;<a name="line.58"></a> -<span class="sourceLineNo">059</span> }<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> public Filter getFilter() {<a name="line.61"></a> -<span class="sourceLineNo">062</span> return filter;<a name="line.62"></a> -<span class="sourceLineNo">063</span> }<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> @Override<a name="line.65"></a> -<span class="sourceLineNo">066</span> public void reset() throws IOException {<a name="line.66"></a> -<span class="sourceLineNo">067</span> filter.reset();<a name="line.67"></a> -<span class="sourceLineNo">068</span> filterRow = false;<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> private void changeFR(boolean value) {<a name="line.71"></a> -<span class="sourceLineNo">072</span> filterRow = filterRow || value;<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> @Override<a name="line.75"></a> -<span class="sourceLineNo">076</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.76"></a> -<span class="sourceLineNo">077</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.77"></a> -<span class="sourceLineNo">078</span> return false;<a name="line.78"></a> -<span class="sourceLineNo">079</span> }<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> @Deprecated<a name="line.81"></a> -<span class="sourceLineNo">082</span> @Override<a name="line.82"></a> -<span class="sourceLineNo">083</span> public ReturnCode filterKeyValue(final Cell c) throws IOException {<a name="line.83"></a> -<span class="sourceLineNo">084</span> return filterCell(c);<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> @Override<a name="line.87"></a> -<span class="sourceLineNo">088</span> public ReturnCode filterCell(final Cell c) throws IOException {<a name="line.88"></a> -<span class="sourceLineNo">089</span> ReturnCode rc = filter.filterCell(c);<a name="line.89"></a> -<span class="sourceLineNo">090</span> changeFR(rc != ReturnCode.INCLUDE);<a name="line.90"></a> -<span class="sourceLineNo">091</span> return rc;<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> @Override<a name="line.94"></a> -<span class="sourceLineNo">095</span> public Cell transformCell(Cell v) throws IOException {<a name="line.95"></a> -<span class="sourceLineNo">096</span> return filter.transformCell(v);<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> @Override<a name="line.99"></a> -<span class="sourceLineNo">100</span> public boolean filterRow() {<a name="line.100"></a> -<span class="sourceLineNo">101</span> return filterRow;<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> @Override<a name="line.104"></a> -<span class="sourceLineNo">105</span> public boolean hasFilterRow() {<a name="line.105"></a> -<span class="sourceLineNo">106</span> return true;<a name="line.106"></a> -<span class="sourceLineNo">107</span> }<a name="line.107"></a> -<span class="sourceLineNo">108</span><a name="line.108"></a> -<span class="sourceLineNo">109</span> /**<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @return The filter serialized using pb<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 byte[] toByteArray() throws IOException {<a name="line.113"></a> -<span class="sourceLineNo">114</span> FilterProtos.SkipFilter.Builder builder =<a name="line.114"></a> -<span class="sourceLineNo">115</span> FilterProtos.SkipFilter.newBuilder();<a name="line.115"></a> -<span class="sourceLineNo">116</span> builder.setFilter(ProtobufUtil.toFilter(this.filter));<a name="line.116"></a> -<span class="sourceLineNo">117</span> return builder.build().toByteArray();<a name="line.117"></a> -<span class="sourceLineNo">118</span> }<a name="line.118"></a> -<span class="sourceLineNo">119</span><a name="line.119"></a> -<span class="sourceLineNo">120</span> /**<a name="line.120"></a> -<span class="sourceLineNo">121</span> * @param pbBytes A pb serialized {@link SkipFilter} instance<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @return An instance of {@link SkipFilter} made from <code>bytes</code><a name="line.122"></a> -<span class="sourceLineNo">123</span> * @throws DeserializationException<a name="line.123"></a> -<span class="sourceLineNo">124</span> * @see #toByteArray<a name="line.124"></a> -<span class="sourceLineNo">125</span> */<a name="line.125"></a> -<span class="sourceLineNo">126</span> public static SkipFilter parseFrom(final byte [] pbBytes)<a name="line.126"></a> -<span class="sourceLineNo">127</span> throws DeserializationException {<a name="line.127"></a> -<span class="sourceLineNo">128</span> FilterProtos.SkipFilter proto;<a name="line.128"></a> -<span class="sourceLineNo">129</span> try {<a name="line.129"></a> -<span class="sourceLineNo">130</span> proto = FilterProtos.SkipFilter.parseFrom(pbBytes);<a name="line.130"></a> -<span class="sourceLineNo">131</span> } catch (InvalidProtocolBufferException e) {<a name="line.131"></a> -<span class="sourceLineNo">132</span> throw new DeserializationException(e);<a name="line.132"></a> -<span class="sourceLineNo">133</span> }<a name="line.133"></a> -<span class="sourceLineNo">134</span> try {<a name="line.134"></a> -<span class="sourceLineNo">135</span> return new SkipFilter(ProtobufUtil.toFilter(proto.getFilter()));<a name="line.135"></a> -<span class="sourceLineNo">136</span> } catch (IOException ioe) {<a name="line.136"></a> -<span class="sourceLineNo">137</span> throw new DeserializationException(ioe);<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><a name="line.140"></a> -<span class="sourceLineNo">141</span> /**<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @param o the other filter to compare with<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @return true if and only if the fields of the filter that are serialized<a name="line.143"></a> -<span class="sourceLineNo">144</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> @Override<a name="line.146"></a> -<span class="sourceLineNo">147</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.147"></a> -<span class="sourceLineNo">148</span> if (o == this) return true;<a name="line.148"></a> -<span class="sourceLineNo">149</span> if (!(o instanceof SkipFilter)) return false;<a name="line.149"></a> -<span class="sourceLineNo">150</span><a name="line.150"></a> -<span class="sourceLineNo">151</span> SkipFilter other = (SkipFilter)o;<a name="line.151"></a> -<span class="sourceLineNo">152</span> return getFilter().areSerializedFieldsEqual(other.getFilter());<a name="line.152"></a> -<span class="sourceLineNo">153</span> }<a name="line.153"></a> -<span class="sourceLineNo">154</span><a name="line.154"></a> -<span class="sourceLineNo">155</span> @Override<a name="line.155"></a> -<span class="sourceLineNo">156</span> public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.156"></a> -<span class="sourceLineNo">157</span> return filter.isFamilyEssential(name);<a name="line.157"></a> -<span class="sourceLineNo">158</span> }<a name="line.158"></a> -<span class="sourceLineNo">159</span><a name="line.159"></a> -<span class="sourceLineNo">160</span> @Override<a name="line.160"></a> -<span class="sourceLineNo">161</span> public String toString() {<a name="line.161"></a> -<span class="sourceLineNo">162</span> return this.getClass().getSimpleName() + " " + this.filter.toString();<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span>}<a name="line.164"></a> +<span class="sourceLineNo">023</span>import java.util.Objects;<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.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.ProtobufUtil;<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.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span>/**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * A wrapper filter that filters an entire row if any of the Cell checks do<a name="line.33"></a> +<span class="sourceLineNo">034</span> * not pass.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * For example, if all columns in a row represent weights of different things,<a name="line.36"></a> +<span class="sourceLineNo">037</span> * with the values being the actual weights, and we want to filter out the<a name="line.37"></a> +<span class="sourceLineNo">038</span> * entire row if any of its weights are zero. In this case, we want to prevent<a name="line.38"></a> +<span class="sourceLineNo">039</span> * rows from being emitted if a single key is filtered. Combine this filter<a name="line.39"></a> +<span class="sourceLineNo">040</span> * with a {@link ValueFilter}:<a name="line.40"></a> +<span class="sourceLineNo">041</span> * </p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <code><a name="line.43"></a> +<span class="sourceLineNo">044</span> * scan.setFilter(new SkipFilter(new ValueFilter(CompareOp.NOT_EQUAL,<a name="line.44"></a> +<span class="sourceLineNo">045</span> * new BinaryComparator(Bytes.toBytes(0))));<a name="line.45"></a> +<span class="sourceLineNo">046</span> * </code><a name="line.46"></a> +<span class="sourceLineNo">047</span> * Any row which contained a column whose value was 0 will be filtered out<a name="line.47"></a> +<span class="sourceLineNo">048</span> * (since ValueFilter will not pass that Cell).<a name="line.48"></a> +<span class="sourceLineNo">049</span> * Without this filter, the other non-zero valued columns in the row would still<a name="line.49"></a> +<span class="sourceLineNo">050</span> * be emitted.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * </p><a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span>@InterfaceAudience.Public<a name="line.53"></a> +<span class="sourceLineNo">054</span>public class SkipFilter extends FilterBase {<a name="line.54"></a> +<span class="sourceLineNo">055</span> private boolean filterRow = false;<a name="line.55"></a> +<span class="sourceLineNo">056</span> private Filter filter;<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> public SkipFilter(Filter filter) {<a name="line.58"></a> +<span class="sourceLineNo">059</span> this.filter = filter;<a name="line.59"></a> +<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> public Filter getFilter() {<a name="line.62"></a> +<span class="sourceLineNo">063</span> return filter;<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> @Override<a name="line.66"></a> +<span class="sourceLineNo">067</span> public void reset() throws IOException {<a name="line.67"></a> +<span class="sourceLineNo">068</span> filter.reset();<a name="line.68"></a> +<span class="sourceLineNo">069</span> filterRow = false;<a name="line.69"></a> +<span class="sourceLineNo">070</span> }<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> private void changeFR(boolean value) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> filterRow = filterRow || value;<a name="line.73"></a> +<span class="sourceLineNo">074</span> }<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> @Override<a name="line.76"></a> +<span class="sourceLineNo">077</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.77"></a> +<span class="sourceLineNo">078</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.78"></a> +<span class="sourceLineNo">079</span> return false;<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> @Deprecated<a name="line.82"></a> +<span class="sourceLineNo">083</span> @Override<a name="line.83"></a> +<span class="sourceLineNo">084</span> public ReturnCode filterKeyValue(final Cell c) throws IOException {<a name="line.84"></a> +<span class="sourceLineNo">085</span> return filterCell(c);<a name="line.85"></a> +<span class="sourceLineNo">086</span> }<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span> @Override<a name="line.88"></a> +<span class="sourceLineNo">089</span> public ReturnCode filterCell(final Cell c) throws IOException {<a name="line.89"></a> +<span class="sourceLineNo">090</span> ReturnCode rc = filter.filterCell(c);<a name="line.90"></a> +<span class="sourceLineNo">091</span> changeFR(rc != ReturnCode.INCLUDE);<a name="line.91"></a> +<span class="sourceLineNo">092</span> return rc;<a name="line.92"></a> +<span class="sourceLineNo">093</span> }<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> @Override<a name="line.95"></a> +<span class="sourceLineNo">096</span> public Cell transformCell(Cell v) throws IOException {<a name="line.96"></a> +<span class="sourceLineNo">097</span> return filter.transformCell(v);<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> @Override<a name="line.100"></a> +<span class="sourceLineNo">101</span> public boolean filterRow() {<a name="line.101"></a> +<span class="sourceLineNo">102</span> return filterRow;<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> @Override<a name="line.105"></a> +<span class="sourceLineNo">106</span> public boolean hasFilterRow() {<a name="line.106"></a> +<span class="sourceLineNo">107</span> return true;<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 The filter serialized using pb<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 byte[] toByteArray() throws IOException {<a name="line.114"></a> +<span class="sourceLineNo">115</span> FilterProtos.SkipFilter.Builder builder =<a name="line.115"></a> +<span class="sourceLineNo">116</span> FilterProtos.SkipFilter.newBuilder();<a name="line.116"></a> +<span class="sourceLineNo">117</span> builder.setFilter(ProtobufUtil.toFilter(this.filter));<a name="line.117"></a> +<span class="sourceLineNo">118</span> return builder.build().toByteArray();<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> /**<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @param pbBytes A pb serialized {@link SkipFilter} instance<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @return An instance of {@link SkipFilter} made from <code>bytes</code><a name="line.123"></a> +<span class="sourceLineNo">124</span> * @throws DeserializationException<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @see #toByteArray<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> public static SkipFilter parseFrom(final byte [] pbBytes)<a name="line.127"></a> +<span class="sourceLineNo">128</span> throws DeserializationException {<a name="line.128"></a> +<span class="sourceLineNo">129</span> FilterProtos.SkipFilter proto;<a name="line.129"></a> +<span class="sourceLineNo">130</span> try {<a name="line.130"></a> +<span class="sourceLineNo">131</span> proto = FilterProtos.SkipFilter.parseFrom(pbBytes);<a name="line.131"></a> +<span class="sourceLineNo">132</span> } catch (InvalidProtocolBufferException e) {<a name="line.132"></a> +<span class="sourceLineNo">133</span> throw new DeserializationException(e);<a name="line.133"></a> +<span class="sourceLineNo">134</span> }<a name="line.134"></a> +<span class="sourceLineNo">135</span> try {<a name="line.135"></a> +<span class="sourceLineNo">136</span> return new SkipFilter(ProtobufUtil.toFilter(proto.getFilter()));<a name="line.136"></a> +<span class="sourceLineNo">137</span> } catch (IOException ioe) {<a name="line.137"></a> +<span class="sourceLineNo">138</span> throw new DeserializationException(ioe);<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> /**<a name="line.142"></a> +<span class="sourceLineNo">143</span> * @param o the other filter to compare with<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @return true if and only if the fields of the filter that are serialized<a name="line.144"></a> +<span class="sourceLineNo">145</span> * are equal to the corresponding fields in other. Used for testing.<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> boolean areSerializedFieldsEqual(Filter o) {<a name="line.148"></a> +<span class="sourceLineNo">149</span> if (o == this) return true;<a name="line.149"></a> +<span class="sourceLineNo">150</span> if (!(o instanceof SkipFilter)) return false;<a name="line.150"></a> +<span class="sourceLineNo">151</span><a name="line.151"></a> +<span class="sourceLineNo">152</span> SkipFilter other = (SkipFilter)o;<a name="line.152"></a> +<span class="sourceLineNo">153</span> return getFilter().areSerializedFieldsEqual(other.getFilter());<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> @Override<a name="line.156"></a> +<span class="sourceLineNo">157</span> public boolean isFamilyEssential(byte[] name) throws IOException {<a name="line.157"></a> +<span class="sourceLineNo">158</span> return filter.isFamilyEssential(name);<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> @Override<a name="line.161"></a> +<span class="sourceLineNo">162</span> public String toString() {<a name="line.162"></a> +<span class="sourceLineNo">163</span> return this.getClass().getSimpleName() + " " + this.filter.toString();<a name="line.163"></a> +<span class="sourceLineNo">164</span> }<a name="line.164"></a> +<span class="sourceLineNo">165</span><a name="line.165"></a> +<span class="sourceLineNo">166</span> @Override<a name="line.166"></a> +<span class="sourceLineNo">167</span> public boolean equals(Object obj) {<a name="line.167"></a> +<span class="sourceLineNo">168</span> if (obj == null || (!(obj.getClass() == this.getClass()))) {<a name="line.168"></a> +<span class="sourceLineNo">169</span> return false;<a name="line.169"></a> +<span class="sourceLineNo">170</span> }<a name="line.170"></a> +<span class="sourceLineNo">171</span> SkipFilter f = (SkipFilter) obj;<a name="line.171"></a> +<span class="sourceLineNo">172</span> return this.areSerializedFieldsEqual(f);<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span><a name="line.174"></a> +<span class="sourceLineNo">175</span> @Override<a name="line.175"></a> +<span class="sourceLineNo">176</span> public int hashCode() {<a name="line.176"></a> +<span class="sourceLineNo">177</span> return Objects.hash(this.filter);<a name="line.177"></a> +<span class="sourceLineNo">178</span> }<a name="line.178"></a> +<span class="sourceLineNo">179</span>}<a name="line.179"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/0cf79db0/apidocs/src-html/org/apache/hadoop/hbase/filter/TimestampsFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/TimestampsFilter.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/TimestampsFilter.html index 54d784d..076540c 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/TimestampsFilter.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/TimestampsFilter.html @@ -28,225 +28,240 @@ <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> <span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.TreeSet;<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.PrivateCellUtil;<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><a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.32"></a> -<span class="sourceLineNo">033</span><a name="line.33"></a> -<span class="sourceLineNo">034</span>/**<a name="line.34"></a> -<span class="sourceLineNo">035</span> * Filter that returns only cells whose timestamp (version) is<a name="line.35"></a> -<span class="sourceLineNo">036</span> * in the specified list of timestamps (versions).<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> -<span class="sourceLineNo">038</span> * Note: Use of this filter overrides any time range/time stamp<a name="line.38"></a> -<span class="sourceLineNo">039</span> * options specified using {@link org.apache.hadoop.hbase.client.Get#setTimeRange(long, long)},<a name="line.39"></a> -<span class="sourceLineNo">040</span> * {@link org.apache.hadoop.hbase.client.Scan#setTimeRange(long, long)},<a name="line.40"></a> -<span class="sourceLineNo">041</span> * {@link org.apache.hadoop.hbase.client.Get#setTimestamp(long)},<a name="line.41"></a> -<span class="sourceLineNo">042</span> * or {@link org.apache.hadoop.hbase.client.Scan#setTimestamp(long)}.<a name="line.42"></a> -<span class="sourceLineNo">043</span> */<a name="line.43"></a> -<span class="sourceLineNo">044</span>@InterfaceAudience.Public<a name="line.44"></a> -<span class="sourceLineNo">045</span>public class TimestampsFilter extends FilterBase {<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span> private final boolean canHint;<a name="line.47"></a> -<span class="sourceLineNo">048</span> TreeSet<Long> timestamps;<a name="line.48"></a> -<span class="sourceLineNo">049</span> private static final int MAX_LOG_TIMESTAMPS = 5;<a name="line.49"></a> -<span class="sourceLineNo">050</span><a name="line.50"></a> -<span class="sourceLineNo">051</span> // Used during scans to hint the scan to stop early<a name="line.51"></a> -<span class="sourceLineNo">052</span> // once the timestamps fall below the minTimestamp.<a name="line.52"></a> -<span class="sourceLineNo">053</span> long minTimestamp = Long.MAX_VALUE;<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> /**<a name="line.55"></a> -<span class="sourceLineNo">056</span> * Constructor for filter that retains only the specified timestamps in the list.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param timestamps<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> public TimestampsFilter(List<Long> timestamps) {<a name="line.59"></a> -<span class="sourceLineNo">060</span> this(timestamps, false);<a name="line.60"></a> -<span class="sourceLineNo">061</span> }<a name="line.61"></a> -<span class="sourceLineNo">062</span><a name="line.62"></a> -<span class="sourceLineNo">063</span> /**<a name="line.63"></a> -<span class="sourceLineNo">064</span> * Constructor for filter that retains only those<a name="line.64"></a> -<span class="sourceLineNo">065</span> * cells whose timestamp (version) is in the specified<a name="line.65"></a> -<span class="sourceLineNo">066</span> * list of timestamps.<a name="line.66"></a> -<span class="sourceLineNo">067</span> *<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @param timestamps list of timestamps that are wanted.<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @param canHint should the filter provide a seek hint? This can skip<a name="line.69"></a> -<span class="sourceLineNo">070</span> * past delete tombstones, so it should only be used when that<a name="line.70"></a> -<span class="sourceLineNo">071</span> * is not an issue ( no deletes, or don't care if data<a name="line.71"></a> -<span class="sourceLineNo">072</span> * becomes visible)<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> public TimestampsFilter(List<Long> timestamps, boolean canHint) {<a name="line.74"></a> -<span class="sourceLineNo">075</span> for (Long timestamp : timestamps) {<a name="line.75"></a> -<span class="sourceLineNo">076</span> Preconditions.checkArgument(timestamp >= 0, "must be positive %s", timestamp);<a name="line.76"></a> -<span class="sourceLineNo">077</span> }<a name="line.77"></a> -<span class="sourceLineNo">078</span> this.canHint = canHint;<a name="line.78"></a> -<span class="sourceLineNo">079</span> this.timestamps = new TreeSet<>(timestamps);<a name="line.79"></a> -<span class="sourceLineNo">080</span> init();<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 the list of timestamps<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> public List<Long> getTimestamps() {<a name="line.86"></a> -<span class="sourceLineNo">087</span> List<Long> list = new ArrayList<>(timestamps.size());<a name="line.87"></a> -<span class="sourceLineNo">088</span> list.addAll(timestamps);<a name="line.88"></a> -<span class="sourceLineNo">089</span> return list;<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> private void init() {<a name="line.92"></a> -<span class="sourceLineNo">093</span> if (this.timestamps.size() > 0) {<a name="line.93"></a> -<span class="sourceLineNo">094</span> minTimestamp = this.timestamps.first();<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> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * Gets the minimum timestamp requested by filter.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return minimum timestamp requested by filter.<a name="line.100"></a> -<span class="sourceLineNo">101</span> */<a name="line.101"></a> -<span class="sourceLineNo">102</span> public long getMin() {<a name="line.102"></a> -<span class="sourceLineNo">103</span> return minTimestamp;<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> @Deprecated<a name="line.112"></a> -<span class="sourceLineNo">113</span> @Override<a name="line.113"></a> -<span class="sourceLineNo">114</span> public ReturnCode filterKeyValue(final Cell c) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> return filterCell(c);<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 ReturnCode filterCell(final Cell c) {<a name="line.119"></a> -<span class="sourceLineNo">120</span> if (this.timestamps.contains(c.getTimestamp())) {<a name="line.120"></a> -<span class="sourceLineNo">121</span> return ReturnCode.INCLUDE;<a name="line.121"></a> -<span class="sourceLineNo">122</span> } else if (c.getTimestamp() < minTimestamp) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> // The remaining versions of this column are guaranteed<a name="line.123"></a> -<span class="sourceLineNo">124</span> // to be lesser than all of the other values.<a name="line.124"></a> -<span class="sourceLineNo">125</span> return ReturnCode.NEXT_COL;<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span> return canHint ? ReturnCode.SEEK_NEXT_USING_HINT : ReturnCode.SKIP;<a name="line.127"></a> -<span class="sourceLineNo">128</span> }<a name="line.128"></a> -<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.TreeSet;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Cell;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.PrivateCellUtil;<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.exceptions.DeserializationException;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<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> * Filter that returns only cells whose timestamp (version) is<a name="line.36"></a> +<span class="sourceLineNo">037</span> * in the specified list of timestamps (versions).<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * Note: Use of this filter overrides any time range/time stamp<a name="line.39"></a> +<span class="sourceLineNo">040</span> * options specified using {@link org.apache.hadoop.hbase.client.Get#setTimeRange(long, long)},<a name="line.40"></a> +<span class="sourceLineNo">041</span> * {@link org.apache.hadoop.hbase.client.Scan#setTimeRange(long, long)},<a name="line.41"></a> +<span class="sourceLineNo">042</span> * {@link org.apache.hadoop.hbase.client.Get#setTimestamp(long)},<a name="line.42"></a> +<span class="sourceLineNo">043</span> * or {@link org.apache.hadoop.hbase.client.Scan#setTimestamp(long)}.<a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span>@InterfaceAudience.Public<a name="line.45"></a> +<span class="sourceLineNo">046</span>public class TimestampsFilter extends FilterBase {<a name="line.46"></a> +<span class="sourceLineNo">047</span><a name="line.47"></a> +<span class="sourceLineNo">048</span> private final boolean canHint;<a name="line.48"></a> +<span class="sourceLineNo">049</span> TreeSet<Long> timestamps;<a name="line.49"></a> +<span class="sourceLineNo">050</span> private static final int MAX_LOG_TIMESTAMPS = 5;<a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> // Used during scans to hint the scan to stop early<a name="line.52"></a> +<span class="sourceLineNo">053</span> // once the timestamps fall below the minTimestamp.<a name="line.53"></a> +<span class="sourceLineNo">054</span> long minTimestamp = Long.MAX_VALUE;<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Constructor for filter that retains only the specified timestamps in the list.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param timestamps<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> public TimestampsFilter(List<Long> timestamps) {<a name="line.60"></a> +<span class="sourceLineNo">061</span> this(timestamps, false);<a name="line.61"></a> +<span class="sourceLineNo">062</span> }<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> /**<a name="line.64"></a> +<span class="sourceLineNo">065</span> * Constructor for filter that retains only those<a name="line.65"></a> +<span class="sourceLineNo">066</span> * cells whose timestamp (version) is in the specified<a name="line.66"></a> +<span class="sourceLineNo">067</span> * list of timestamps.<a name="line.67"></a> +<span class="sourceLineNo">068</span> *<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @param timestamps list of timestamps that are wanted.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @param canHint should the filter provide a seek hint? This can skip<a name="line.70"></a> +<span class="sourceLineNo">071</span> * past delete tombstones, so it should only be used when that<a name="line.71"></a> +<span class="sourceLineNo">072</span> * is not an issue ( no deletes, or don't care if data<a name="line.72"></a> +<span class="sourceLineNo">073</span> * becomes visible)<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> public TimestampsFilter(List<Long> timestamps, boolean canHint) {<a name="line.75"></a> +<span class="sourceLineNo">076</span> for (Long timestamp : timestamps) {<a name="line.76"></a> +<span class="sourceLineNo">077</span> Preconditions.checkArgument(timestamp >= 0, "must be positive %s", timestamp);<a name="line.77"></a> +<span class="sourceLineNo">078</span> }<a name="line.78"></a> +<span class="sourceLineNo">079</span> this.canHint = canHint;<a name="line.79"></a> +<span class="sourceLineNo">080</span> this.timestamps = new TreeSet<>(timestamps);<a name="line.80"></a> +<span class="sourceLineNo">081</span> init();<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> /**<a name="line.84"></a> +<span class="sourceLineNo">085</span> * @return the list of timestamps<a name="line.85"></a> +<span class="sourceLineNo">086</span> */<a name="line.86"></a> +<span class="sourceLineNo">087</span> public List<Long> getTimestamps() {<a name="line.87"></a> +<span class="sourceLineNo">088</span> List<Long> list = new ArrayList<>(timestamps.size());<a name="line.88"></a> +<span class="sourceLineNo">089</span> list.addAll(timestamps);<a name="line.89"></a> +<span class="sourceLineNo">090</span> return list;<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> private void init() {<a name="line.93"></a> +<span class="sourceLineNo">094</span> if (this.timestamps.size() > 0) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> minTimestamp = this.timestamps.first();<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><a name="line.98"></a> +<span class="sourceLineNo">099</span> /**<a name="line.99"></a> +<span class="sourceLineNo">100</span> * Gets the minimum timestamp requested by filter.<a name="line.100"></a> +<span class="sourceLineNo">101</span> * @return minimum timestamp requested by filter.<a name="line.101"></a> +<span class="sourceLineNo">102</span> */<a name="line.102"></a> +<span class="sourceLineNo">103</span> public long getMin() {<a name="line.103"></a> +<span class="sourceLineNo">104</span> return minTimestamp;<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> @Deprecated<a name="line.113"></a> +<span class="sourceLineNo">114</span> @Override<a name="line.114"></a> +<span class="sourceLineNo">115</span> public ReturnCode filterKeyValue(final Cell c) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> return filterCell(c);<a name="line.116"></a> +<span class="sourceLineNo">117</span> }<a name="line.117"></a> +<span class="sourceLineNo">118</span><a name="line.118"></a> +<span class="sourceLineNo">119</span> @Override<a name="line.119"></a> +<span class="sourceLineNo">120</span> public ReturnCode filterCell(final Cell c) {<a name="line.120"></a> +<span class="sourceLineNo">121</span> if (this.timestamps.contains(c.getTimestamp())) {<a name="line.121"></a> +<span class="sourceLineNo">122</span> return ReturnCode.INCLUDE;<a name="line.122"></a> +<span class="sourceLineNo">123</span> } else if (c.getTimestamp() < minTimestamp) {<a name="line.123"></a> +<span class="sourceLineNo">124</span> // The remaining versions of this column are guaranteed<a name="line.124"></a> +<span class="sourceLineNo">125</span> // to be lesser than all of the other values.<a name="line.125"></a> +<span class="sourceLineNo">126</span> return ReturnCode.NEXT_COL;<a name="line.126"></a> +<span class="sourceLineNo">127</span> }<a name="line.127"></a> +<span class="sourceLineNo">128</span> return canHint ? ReturnCode.SEEK_NEXT_USING_HINT : ReturnCode.SKIP;<a name="line.128"></a> +<span class="sourceLineNo">129</span> }<a name="line.129"></a> <span class="sourceLineNo">130</span><a name="line.130"></a> -<span class="sourceLineNo">131</span> /**<a name="line.131"></a> -<span class="sourceLineNo">132</span> * Pick the next cell that the scanner should seek to. Since this can skip any number of cells<a name="line.132"></a> -<span class="sourceLineNo">133</span> * any of which can be a delete this can resurect old data.<a name="line.133"></a> -<span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * The method will only be used if canHint was set to true while creating the filter.<a name="line.135"></a> -<span class="sourceLineNo">136</span> *<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @throws IOException This will never happen.<a name="line.137"></a> -<span class="sourceLineNo">138</span> */<a name="line.138"></a> -<span class="sourceLineNo">139</span> @Override<a name="line.139"></a> -<span class="sourceLineNo">140</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.140"></a> -<span class="sourceLineNo">141</span> if (!canHint) {<a name="line.141"></a> -<span class="sourceLineNo">142</span> return null;<a name="line.142"></a> -<span class="sourceLineNo">143</span> }<a name="line.143"></a> -<span class="sourceLineNo">144</span><a name="line.144"></a> -<span class="sourceLineNo">145</span> Long nextTimestampObject = timestamps.lower(currentCell.getTimestamp());<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> if (nextTimestampObject == null) {<a name="line.147"></a> -<span class="sourceLineNo">148</span> // This should only happen if the current column's<a name="line.148"></a> -<span class="sourceLineNo">149</span> // timestamp is below the last one in the list.<a name="line.149"></a> -<span class="sourceLineNo">150</span> //<a name="line.150"></a> -<span class="sourceLineNo">151</span> // It should never happen as the filterCell should return NEXT_COL<a name="line.151"></a> -<span class="sourceLineNo">152</span> // but it's always better to be extra safe and protect against future<a name="line.152"></a> -<span class="sourceLineNo">153</span> // behavioral changes.<a name="line.153"></a> -<span class="sourceLineNo">154</span><a name="line.154"></a> -<span class="sourceLineNo">155</span> return PrivateCellUtil.createLastOnRowCol(currentCell);<a name="line.155"></a> -<span class="sourceLineNo">156</span> }<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> // Since we know the nextTimestampObject isn't null here there must still be<a name="line.158"></a> -<span class="sourceLineNo">159</span> // timestamps that can be included. Cast the Long to a long and return the<a name="line.159"></a> -<span class="sourceLineNo">160</span> // a cell with the current row/cf/col and the next found timestamp.<a name="line.160"></a> -<span class="sourceLineNo">161</span> long nextTimestamp = nextTimestampObject;<a name="line.161"></a> -<span class="sourceLineNo">162</span> return PrivateCellUtil.createFirstOnRowColTS(currentCell, nextTimestamp);<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> public static Filter createFilterFromArguments(ArrayList<byte []> filterArguments) {<a name="line.165"></a> -<span class="sourceLineNo">166</span> ArrayList<Long> timestamps = new ArrayList<>(filterArguments.size());<a name="line.166"></a> -<span class="sourceLineNo">167</span> for (int i = 0; i<filterArguments.size(); i++) {<a name="line.167"></a> -<span class="sourceLineNo">168</span> long timestamp = ParseFilter.convertByteArrayToLong(filterArguments.get(i));<a name="line.168"></a> -<span class="sourceLineNo">169</span> timestamps.add(timestamp);<a name="line.169"></a> -<span class="sourceLineNo">170</span> }<a name="line.170"></a> -<span class="sourceLineNo">171</span> return new TimestampsFilter(timestamps);<a name="line.171"></a> -<span class="sourceLineNo">172</span> }<a name="line.172"></a> -<span class="sourceLineNo">173</span><a name="line.173"></a> -<span class="sourceLineNo">174</span> /**<a name="line.174"></a> -<span class="sourceLineNo">175</span> * @return The filter serialized using pb<a name="line.175"></a> -<span class="sourceLineNo">176</span> */<a name="line.176"></a> -<span class="sourceLineNo">177</span> @Override<a name="line.177"></a> -<span class="sourceLineNo">178</span> public byte[] toByteArray() {<a name="line.178"></a> -<span class="sourceLineNo">179</span> FilterProtos.TimestampsFilter.Builder builder =<a name="line.179"></a> -<span class="sourceLineNo">180</span> FilterProtos.TimestampsFilter.newBuilder();<a name="line.180"></a> -<span class="sourceLineNo">181</span> builder.addAllTimestamps(this.timestamps);<a name="line.181"></a> -<span class="sourceLineNo">182</span> builder.setCanHint(canHint);<a name="line.182"></a> -<span class="sourceLineNo">183</span> return builder.build().toByteArray();<a name="line.183"></a> -<span class="sourceLineNo">184</span> }<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @param pbBytes A pb serialized {@link TimestampsFilter} instance<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @return An instance of {@link TimestampsFilter} made from <code>bytes</code><a name="line.189"></a> -<span class="sourceLineNo">190</span> * @see #toByteArray<a name="line.190"></a> -<span class="sourceLineNo">191</span> */<a name="line.191"></a> -<span class="sourceLineNo">192</span> public static TimestampsFilter parseFrom(final byte[] pbBytes)<a name="line.192"></a> -<span class="sourceLineNo">193</span> throws DeserializationException {<a name="line.193"></a> -<span class="sourceLineNo">194</span> FilterProtos.TimestampsFilter proto;<a name="line.194"></a> -<span class="sourceLineNo">195</span> try {<a name="line.195"></a> -<span class="sourceLineNo">196</span> proto = FilterProtos.TimestampsFilter.parseFrom(pbBytes);<a name="line.196"></a> -<span class="sourceLineNo">197</span> } catch (InvalidProtocolBufferException e) {<a name="line.197"></a> -<span class="sourceLineNo">198</span> throw new DeserializationException(e);<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span> return new TimestampsFilter(proto.getTimestampsList(),<a name="line.200"></a> -<span class="sourceLineNo">201</span> proto.hasCanHint() && proto.getCanHint());<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 o the other filter to compare with<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> @Override<a name="line.209"></a> -<span class="sourceLineNo">210</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.210"></a> -<span class="sourceLineNo">211</span> if (o == this) return true;<a name="line.211"></a> -<span class="sourceLineNo">212</span> if (!(o instanceof TimestampsFilter)) return false;<a name="line.212"></a> -<span class="sourceLineNo">213</span><a name="line.213"></a> -<span class="sourceLineNo">214</span> TimestampsFilter other = (TimestampsFilter)o;<a name="line.214"></a> -<span class="sourceLineNo">215</span> return this.getTimestamps().equals(other.getTimestamps());<a name="line.215"></a> -<span class="sourceLineNo">216</span> }<a name="line.216"></a> -<span class="sourceLineNo">217</span><a name="line.217"></a> -<span class="sourceLineNo">218</span> @Override<a name="line.218"></a> -<span class="sourceLineNo">219</span> public String toString() {<a name="line.219"></a> -<span class="sourceLineNo">220</span> return toString(MAX_LOG_TIMESTAMPS);<a name="line.220"></a> -<span class="sourceLineNo">221</span> }<a name="line.221"></a> -<span class="sourceLineNo">222</span><a name="line.222"></a> -<span class="sourceLineNo">223</span> protected String toString(int maxTimestamps) {<a name="line.223"></a> -<span class="sourceLineNo">224</span> StringBuilder tsList = new StringBuilder();<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> int count = 0;<a name="line.226"></a> -<span class="sourceLineNo">227</span> for (Long ts : this.timestamps) {<a name="line.227"></a> -<span class="sourceLineNo">228</span> if (count >= maxTimestamps) {<a name="line.228"></a> -<span class="sourceLineNo">229</span> break;<a name="line.229"></a> -<span class="sourceLineNo">230</span> }<a name="line.230"></a> -<span class="sourceLineNo">231</span> ++count;<a name="line.231"></a> -<span class="sourceLineNo">232</span> tsList.append(ts.toString());<a name="line.232"></a> -<span class="sourceLineNo">233</span> if (count < this.timestamps.size() && count < maxTimestamps) {<a name="line.233"></a> -<span class="sourceLineNo">234</span> tsList.append(", ");<a name="line.234"></a> -<span class="sourceLineNo">235</span> }<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> return String.format("%s (%d/%d): [%s] canHint: [%b]", this.getClass().getSimpleName(),<a name="line.238"></a> -<span class="sourceLineNo">239</span> count, this.timestamps.size(), tsList.toString(), canHint);<a name="line.239"></a> -<span class="sourceLineNo">240</span> }<a name="line.240"></a> -<span class="sourceLineNo">241</span>}<a name="line.241"></a> +<span class="sourceLineNo">131</span><a name="line.131"></a> +<span class="sourceLineNo">132</span> /**<a name="line.132"></a> +<span class="sourceLineNo">133</span> * Pick the next cell that the scanner should seek to. Since this can skip any number of cells<a name="line.133"></a> +<span class="sourceLineNo">134</span> * any of which can be a delete this can resurect old data.<a name="line.134"></a> +<span class="sourceLineNo">135</span> *<a name="line.135"></a> +<span class="sourceLineNo">136</span> * The method will only be used if canHint was set to true while creating the filter.<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @throws IOException This will never happen.<a name="line.138"></a> +<span class="sourceLineNo">139</span> */<a name="line.139"></a> +<span class="sourceLineNo">140</span> @Override<a name="line.140"></a> +<span class="sourceLineNo">141</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.141"></a> +<span class="sourceLineNo">142</span> if (!canHint) {<a name="line.142"></a> +<span class="sourceLineNo">143</span> return null;<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> Long nextTimestampObject = timestamps.lower(currentCell.getTimestamp());<a name="line.146"></a> +<span class="sourceLineNo">147</span><a name="line.147"></a> +<span class="sourceLineNo">148</span> if (nextTimestampObject == null) {<a name="line.148"></a> +<span class="sourceLineNo">149</span> // This should only happen if the current column's<a name="line.149"></a> +<span class="sourceLineNo">150</span> // timestamp is below the last one in the list.<a name="line.150"></a> +<span class="sourceLineNo">151</span> //<a name="line.151"></a> +<span class="sourceLineNo">152</span> // It should never happen as the filterCell should return NEXT_COL<a name="line.152"></a> +<span class="sourceLineNo">153</span> // but it's always better to be extra safe and protect against future<a name="line.153"></a> +<span class="sourceLineNo">154</span> // behavioral changes.<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> return PrivateCellUtil.createLastOnRowCol(currentCell);<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> // Since we know the nextTimestampObject isn't null here there must still be<a name="line.159"></a> +<span class="sourceLineNo">160</span> // timestamps that can be included. Cast the Long to a long and return the<a name="line.160"></a> +<span class="sourceLineNo">161</span> // a cell with the current row/cf/col and the next found timestamp.<a name="line.161"></a> +<span class="sourceLineNo">162</span> long nextTimestamp = nextTimestampObject;<a name="line.162"></a> +<span class="sourceLineNo">163</span> return PrivateCellUtil.createFirstOnRowColTS(currentCell, nextTimestamp);<a name="line.163"></a> +<span class="sourceLineNo">164</span> }<a name="line.164"></a> +<span class="sourceLineNo">165</span><a name="line.165"></a> +<span class="sourceLineNo">166</span> public static Filter createFilterFromArguments(ArrayList<byte []> filterArguments) {<a name="line.166"></a> +<span class="sourceLineNo">167</span> ArrayList<Long> timestamps = new ArrayList<>(filterArguments.size());<a name="line.167"></a> +<span class="sourceLineNo">168</span> for (int i = 0; i<filterArguments.size(); i++) {<a name="line.168"></a> +<span class="sourceLineNo">169</span> long timestamp = ParseFilter.convertByteArrayToLong(filterArguments.get(i));<a name="line.169"></a> +<span class="sourceLineNo">170</span> timestamps.add(timestamp);<a name="line.170"></a> +<span class="sourceLineNo">171</span> }<a name="line.171"></a> +<span class="sourceLineNo">172</span> return new TimestampsFilter(timestamps);<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<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> +<span class="sourceLineNo">176</span> * @return The filter serialized using pb<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> @Override<a name="line.178"></a> +<span class="sourceLineNo">179</span> public byte[] toByteArray() {<a name="line.179"></a> +<span class="sourceLineNo">180</span> FilterProtos.TimestampsFilter.Builder builder =<a name="line.180"></a> +<span class="sourceLineNo">181</span> FilterProtos.TimestampsFilter.newBuilder();<a name="line.181"></a> +<span class="sourceLineNo">182</span> builder.addAllTimestamps(this.timestamps);<a name="line.182"></a> +<span class="sourceLineNo">183</span> builder.setCanHint(canHint);<a name="line.183"></a> +<span class="sourceLineNo">184</span> return builder.build().toByteArray();<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span><a name="line.186"></a> +<span class="sourceLineNo">187</span> /**<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param pbBytes A pb serialized {@link TimestampsFilter} instance<a name="line.188"></a> +<span class="sourceLineNo">189</span> *<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @return An instance of {@link TimestampsFilter} made from <code>bytes</code><a name="line.190"></a> +<span class="sourceLineNo">191</span> * @see #toByteArray<a name="line.191"></a> +<span class="sourceLineNo">192</span> */<a name="line.192"></a> +<span class="sourceLineNo">193</span> public static TimestampsFilter parseFrom(final byte[] pbBytes)<a name="line.193"></a> +<span class="sourceLineNo">194</span> throws DeserializationException {<a name="line.194"></a> +<span class="sourceLineNo">195</span> FilterProtos.TimestampsFilter proto;<a name="line.195"></a> +<span class="sourceLineNo">196</span> try {<a name="line.196"></a> +<span class="sourceLineNo">197</span> proto = FilterProtos.TimestampsFilter.parseFrom(pbBytes);<a name="line.197"></a> +<span class="sourceLineNo">198</span> } catch (InvalidProtocolBufferException e) {<a name="line.198"></a> +<span class="sourceLineNo">199</span> throw new DeserializationException(e);<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span> return new TimestampsFilter(proto.getTimestampsList(),<a name="line.201"></a> +<span class="sourceLineNo">202</span> proto.hasCanHint() && proto.getCanHint());<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> /**<a name="line.205"></a> +<span class="sourceLineNo">206</span> * @param o the other filter to compare with<a name="line.206"></a> +<span class="sourceLineNo">207</span> * @return true if and only if the fields of the filter that are serialized<a name="line.207"></a> +<span class="sourceLineNo">208</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.208"></a> +<span class="sourceLineNo">209</span> */<a name="line.209"></a> +<span class="sourceLineNo">210</span> @Override<a name="line.210"></a> +<span class="sourceLineNo">211</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.211"></a> +<span class="sourceLineNo">212</span> if (o == this) return true;<a name="line.212"></a> +<span class="sourceLineNo">213</span> if (!(o instanceof TimestampsFilter)) return false;<a name="line.213"></a> +<span class="sourceLineNo">214</span><a name="line.214"></a> +<span class="sourceLineNo">215</span> TimestampsFilter other = (TimestampsFilter)o;<a name="line.215"></a> +<span class="sourceLineNo">216</span> return this.getTimestamps().equals(other.getTimestamps());<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 String toString() {<a name="line.220"></a> +<span class="sourceLineNo">221</span> return toString(MAX_LOG_TIMESTAMPS);<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> protected String toString(int maxTimestamps) {<a name="line.224"></a> +<span class="sourceLineNo">225</span> StringBuilder tsList = new StringBuilder();<a name="line.225"></a> +<span class="sourceLineNo">226</span><a name="line.226"></a> +<span class="sourceLineNo">227</span> int count = 0;<a name="line.227"></a> +<span class="sourceLineNo">228</span> for (Long ts : this.timestamps) {<a name="line.228"></a> +<span class="sourceLineNo">229</span> if (count >= maxTimestamps) {<a name="line.229"></a> +<span class="sourceLineNo">230</span> break;<a name="line.230"></a> +<span class="sourceLineNo">231</span> }<a name="line.231"></a> +<span class="sourceLineNo">232</span> ++count;<a name="line.232"></a> +<span class="sourceLineNo">233</span> tsList.append(ts.toString());<a name="line.233"></a> +<span class="sourceLineNo">234</span> if (count < this.timestamps.size() && count < maxTimestamps) {<a name="line.234"></a> +<span class="sourceLineNo">235</span> tsList.append(", ");<a name="line.235"></a> +<span class="sourceLineNo">236</span> }<a name="line.236"></a> +<span class="sourceLineNo">237</span> }<a name="line.237"></a> +<span class="sourceLineNo">238</span><a name="line.238"></a> +<span class="sourceLineNo">239</span> return String.format("%s (%d/%d): [%s] canHint: [%b]", this.getClass().getSimpleName(),<a name="line.239"></a> +<span class="sourceLineNo">240</span> count, this.timestamps.size(), tsList.toString(), canHint);<a name="line.240"></a> +<span class="sourceLineNo">241</span> }<a name="line.241"></a> +<span class="sourceLineNo">242</span><a name="line.242"></a> +<span class="sourceLineNo">243</span> @Override<a name="line.243"></a> +<span class="sourceLineNo">244</span> public boolean equals(Object obj) {<a name="line.244"></a> +<span class="sourceLineNo">245</span> if (obj == null || (!(obj instanceof TimestampsFilter))) {<a name="line.245"></a> +<span class="sourceLineNo">246</span> return false;<a name="line.246"></a> +<span class="sourceLineNo">247</span> }<a name="line.247"></a> +<span class="sourceLineNo">248</span> TimestampsFilter f = (TimestampsFilter) obj;<a name="line.248"></a> +<span class="sourceLineNo">249</span> return this.areSerializedFieldsEqual(f);<a name="line.249"></a> +<span class="sourceLineNo">250</span> }<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> @Override<a name="line.252"></a> +<span class="sourceLineNo">253</span> public int hashCode() {<a name="line.253"></a> +<span class="sourceLineNo">254</span> return Objects.hash(this.getTimestamps().toArray());<a name="line.254"></a> +<span class="sourceLineNo">255</span> }<a name="line.255"></a> +<span class="sourceLineNo">256</span>}<a name="line.256"></a>
