1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package org.apache.hadoop.hbase.filter;
21
22 import com.google.common.base.Preconditions;
23 import org.apache.hadoop.classification.InterfaceAudience;
24 import org.apache.hadoop.classification.InterfaceStability;
25 import org.apache.hadoop.hbase.protobuf.ProtobufUtil;
26 import org.apache.hadoop.hbase.protobuf.generated.FilterProtos;
27 import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos;
28 import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.CompareType;
29 import org.apache.hadoop.hbase.util.Bytes;
30
31 import java.util.ArrayList;
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 @InterfaceAudience.Public
48 @InterfaceStability.Stable
49 public abstract class CompareFilter extends FilterBase {
50
51
52 @InterfaceAudience.Public
53 @InterfaceStability.Stable
54 public enum CompareOp {
55
56 LESS,
57
58 LESS_OR_EQUAL,
59
60 EQUAL,
61
62 NOT_EQUAL,
63
64 GREATER_OR_EQUAL,
65
66 GREATER,
67
68 NO_OP,
69 }
70
71 protected CompareOp compareOp;
72 protected ByteArrayComparable comparator;
73
74
75
76
77
78
79 public CompareFilter(final CompareOp compareOp,
80 final ByteArrayComparable comparator) {
81 this.compareOp = compareOp;
82 this.comparator = comparator;
83 }
84
85
86
87
88 public CompareOp getOperator() {
89 return compareOp;
90 }
91
92
93
94
95 public ByteArrayComparable getComparator() {
96 return comparator;
97 }
98
99 protected boolean doCompare(final CompareOp compareOp,
100 final ByteArrayComparable comparator, final byte [] data,
101 final int offset, final int length) {
102 if (compareOp == CompareOp.NO_OP) {
103 return true;
104 }
105 int compareResult = comparator.compareTo(data, offset, length);
106 switch (compareOp) {
107 case LESS:
108 return compareResult <= 0;
109 case LESS_OR_EQUAL:
110 return compareResult < 0;
111 case EQUAL:
112 return compareResult != 0;
113 case NOT_EQUAL:
114 return compareResult == 0;
115 case GREATER_OR_EQUAL:
116 return compareResult > 0;
117 case GREATER:
118 return compareResult >= 0;
119 default:
120 throw new RuntimeException("Unknown Compare op " +
121 compareOp.name());
122 }
123 }
124
125
126 public static ArrayList<Object> extractArguments(ArrayList<byte []> filterArguments) {
127 Preconditions.checkArgument(filterArguments.size() == 2,
128 "Expected 2 but got: %s", filterArguments.size());
129 CompareOp compareOp = ParseFilter.createCompareOp(filterArguments.get(0));
130 ByteArrayComparable comparator = ParseFilter.createComparator(
131 ParseFilter.removeQuotesFromByteArray(filterArguments.get(1)));
132
133 if (comparator instanceof RegexStringComparator ||
134 comparator instanceof SubstringComparator) {
135 if (compareOp != CompareOp.EQUAL &&
136 compareOp != CompareOp.NOT_EQUAL) {
137 throw new IllegalArgumentException ("A regexstring comparator and substring comparator" +
138 " can only be used with EQUAL and NOT_EQUAL");
139 }
140 }
141 ArrayList<Object> arguments = new ArrayList<Object>();
142 arguments.add(compareOp);
143 arguments.add(comparator);
144 return arguments;
145 }
146
147
148
149
150 FilterProtos.CompareFilter convert() {
151 FilterProtos.CompareFilter.Builder builder =
152 FilterProtos.CompareFilter.newBuilder();
153 HBaseProtos.CompareType compareOp = CompareType.valueOf(this.compareOp.name());
154 builder.setCompareOp(compareOp);
155 if (this.comparator != null) builder.setComparator(ProtobufUtil.toComparator(this.comparator));
156 return builder.build();
157 }
158
159
160
161
162
163
164
165 boolean areSerializedFieldsEqual(Filter o) {
166 if (o == this) return true;
167 if (!(o instanceof CompareFilter)) return false;
168
169 CompareFilter other = (CompareFilter)o;
170 return this.getOperator().equals(other.getOperator()) &&
171 (this.getComparator() == other.getComparator()
172 || this.getComparator().areSerializedFieldsEqual(other.getComparator()));
173 }
174
175 @Override
176 public String toString() {
177 return String.format("%s (%s, %s)",
178 this.getClass().getSimpleName(),
179 this.compareOp.name(),
180 Bytes.toStringBinary(this.comparator.getValue()));
181 }
182 }