HBASE-16729 Define the behavior of (default) empty FilterList(ChiaPing

Tsai)

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FilterList.java

@@ -52,7 +52,7 @@ import org.apache.hadoop.hbase.shaded.com.google.protobuf.InvalidProtocolBufferE
  */
 @InterfaceAudience.Public
 @InterfaceStability.Stable
-final public class FilterList extends Filter {
+final public class FilterList extends FilterBase {
   /** set operator */
   @InterfaceAudience.Public
   @InterfaceStability.Stable
@@ -65,7 +65,7 @@ final public class FilterList extends Filter {
 
   private static final int MAX_LOG_FILTERS = 5;
   private Operator operator = Operator.MUST_PASS_ALL;
-  private List<Filter> filters = new ArrayList<Filter>();
+  private final List<Filter> filters;
   private Filter seekHintFilter = null;
 
   /** Reference Cell used by {@link #transformCell(Cell)} for validation purpose. */
@@ -83,15 +83,12 @@ final public class FilterList extends Filter {
   /**
    * Constructor that takes a set of {@link Filter}s. The default operator
    * MUST_PASS_ALL is assumed.
-   *
+   * All filters are cloned to internal list.
    * @param rowFilters list of filters
    */
   public FilterList(final List<Filter> rowFilters) {
-    if (rowFilters instanceof ArrayList) {
+    reversed = getReversed(rowFilters, reversed);
-      this.filters = rowFilters;
+    this.filters = new ArrayList<>(rowFilters);
-    } else {
-      this.filters = new ArrayList<Filter>(rowFilters);
-    }
   }
 
   /**
@@ -100,7 +97,7 @@ final public class FilterList extends Filter {
    * @param rowFilters
    */
   public FilterList(final Filter... rowFilters) {
-    this.filters = new ArrayList<Filter>(Arrays.asList(rowFilters));
+    this(Arrays.asList(rowFilters));
   }
 
   /**
@@ -110,6 +107,7 @@ final public class FilterList extends Filter {
    */
   public FilterList(final Operator operator) {
     this.operator = operator;
+    this.filters = new ArrayList<>();
   }
 
   /**
@@ -119,7 +117,7 @@ final public class FilterList extends Filter {
    * @param rowFilters Set of row filters.
    */
   public FilterList(final Operator operator, final List<Filter> rowFilters) {
-    this.filters = new ArrayList<Filter>(rowFilters);
+    this(rowFilters);
     this.operator = operator;
   }
 
@@ -130,7 +128,7 @@ final public class FilterList extends Filter {
    * @param rowFilters Filters to use
    */
   public FilterList(final Operator operator, final Filter... rowFilters) {
-    this.filters = new ArrayList<Filter>(Arrays.asList(rowFilters));
+    this(rowFilters);
     this.operator = operator;
   }
 
@@ -152,18 +150,51 @@ final public class FilterList extends Filter {
     return filters;
   }
 
+  private int size() {
+    return filters.size();
+  }
+
+  private boolean isEmpty() {
+    return filters.isEmpty();
+  }
+
+  private static boolean getReversed(List<Filter> rowFilters, boolean defaultValue) {
+    boolean rval = defaultValue;
+    boolean isFirst = true;
+    for (Filter f : rowFilters) {
+      if (isFirst) {
+        rval = f.isReversed();
+        isFirst = false;
+        continue;
+      }
+      if (rval != f.isReversed()) {
+        throw new IllegalArgumentException("Filters in the list must have the same reversed flag");
+      }
+    }
+    return rval;
+  }
+  private static void checkReversed(List<Filter> rowFilters, boolean expected) {
+    for (Filter filter : rowFilters) {
+      if (expected != filter.isReversed()) {
+        throw new IllegalArgumentException(
+            "Filters in the list must have the same reversed flag, expected="
+                + expected);
+      }
+    }
+  }
+
+  public void addFilter(List<Filter> filters) {
+    checkReversed(filters, isReversed());
+    this.filters.addAll(filters);
+  }
+
   /**
    * Add a filter.
    *
    * @param filter another filter
    */
   public void addFilter(Filter filter) {
-    if (this.isReversed() != filter.isReversed()) {
+    addFilter(Arrays.asList(filter));
-      throw new IllegalArgumentException(
-          "Filters in the list must have the same reversed flag, this.reversed="
-              + this.isReversed());
-    }
-    this.filters.add(filter);
   }
 
   @Override
@@ -177,7 +208,10 @@ final public class FilterList extends Filter {
 
   @Override
   public boolean filterRowKey(byte[] rowKey, int offset, int length) throws IOException {
-    boolean flag = (this.operator == Operator.MUST_PASS_ONE) ? true : false;
+    if (isEmpty()) {
+      return super.filterRowKey(rowKey, offset, length);
+    }
+    boolean flag = this.operator == Operator.MUST_PASS_ONE;
     int listize = filters.size();
     for (int i = 0; i < listize; i++) {
       Filter filter = filters.get(i);
@@ -198,7 +232,10 @@ final public class FilterList extends Filter {
 
   @Override
   public boolean filterRowKey(Cell firstRowCell) throws IOException {
-    boolean flag = (this.operator == Operator.MUST_PASS_ONE) ? true : false;
+    if (isEmpty()) {
+      return super.filterRowKey(firstRowCell);
+    }
+    boolean flag = this.operator == Operator.MUST_PASS_ONE;
     int listize = filters.size();
     for (int i = 0; i < listize; i++) {
       Filter filter = filters.get(i);
@@ -217,6 +254,9 @@ final public class FilterList extends Filter {
 
   @Override
   public boolean filterAllRemaining() throws IOException {
+    if (isEmpty()) {
+      return super.filterAllRemaining();
+    }
     int listize = filters.size();
     for (int i = 0; i < listize; i++) {
       if (filters.get(i).filterAllRemaining()) {
@@ -234,6 +274,9 @@ final public class FilterList extends Filter {
 
   @Override
   public Cell transformCell(Cell c) throws IOException {
+    if (isEmpty()) {
+      return super.transformCell(c);
+    }
     if (!CellUtil.equals(c, referenceCell)) {
       throw new IllegalStateException("Reference Cell: " + this.referenceCell + " does not match: "
           + c);
@@ -245,6 +288,9 @@ final public class FilterList extends Filter {
   @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="SF_SWITCH_FALLTHROUGH",
     justification="Intentional")
   public ReturnCode filterKeyValue(Cell c) throws IOException {
+    if (isEmpty()) {
+      return ReturnCode.INCLUDE;
+    }
     this.referenceCell = c;
 
     // Accumulates successive transformation of every filter that includes the Cell:
@@ -358,6 +404,9 @@ final public class FilterList extends Filter {
 
   @Override
   public boolean filterRow() throws IOException {
+    if (isEmpty()) {
+      return super.filterRow();
+    }
     int listize = filters.size();
     for (int i = 0; i < listize; i++) {
       Filter filter = filters.get(i);
@@ -433,6 +482,9 @@ final public class FilterList extends Filter {
 
   @Override
   public Cell getNextCellHint(Cell currentCell) throws IOException {
+    if (isEmpty()) {
+      return super.getNextCellHint(currentCell);
+    }
     Cell keyHint = null;
     if (operator == Operator.MUST_PASS_ALL) {
       keyHint = seekHintFilter.getNextCellHint(currentCell);
@@ -450,15 +502,13 @@ final public class FilterList extends Filter {
         // If we ever don't have a hint and this is must-pass-one, then no hint
         return null;
       }
-      if (curKeyHint != null) {
+      // If this is the first hint we find, set it
-        // If this is the first hint we find, set it
+      if (keyHint == null) {
-        if (keyHint == null) {
+        keyHint = curKeyHint;
-          keyHint = curKeyHint;
+        continue;
-          continue;
+      }
-        }
+      if (CellComparator.COMPARATOR.compare(keyHint, curKeyHint) > 0) {
-        if (CellComparator.COMPARATOR.compare(keyHint, curKeyHint) > 0) {
+        keyHint = curKeyHint;
-          keyHint = curKeyHint;
-        }
       }
     }
     return keyHint;
@@ -466,6 +516,9 @@ final public class FilterList extends Filter {
 
   @Override
   public boolean isFamilyEssential(byte[] name) throws IOException {
+    if (isEmpty()) {
+      return super.isFamilyEssential(name);
+    }
     int listize = filters.size();
     for (int i = 0; i < listize; i++) {
       if (filters.get(i).isFamilyEssential(name)) {

hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestFromClientSide.java

@@ -5437,25 +5437,19 @@ public class TestFromClientSide {
         scanResults.add(r);
       }
     }
-    
+    assertEquals(1, scanResults.size());
     Get g = new Get(Bytes.toBytes("row"));
     g.setFilter(new FilterList());
     Result getResult = table.get(g);
-    if (scanResults.isEmpty()) {
+    Result scanResult = scanResults.get(0);
-      assertTrue(getResult.isEmpty());
+    assertEquals(scanResult.rawCells().length, getResult.rawCells().length);
-    } else if(scanResults.size() == 1) {
+    for (int i = 0; i != scanResult.rawCells().length; ++i) {
-      Result scanResult = scanResults.get(0);
+      Cell scanCell = scanResult.rawCells()[i];
-      assertEquals(scanResult.rawCells().length, getResult.rawCells().length);
+      Cell getCell = getResult.rawCells()[i];
-      for (int i = 0; i != scanResult.rawCells().length; ++i) {
+      assertEquals(0, Bytes.compareTo(CellUtil.cloneRow(scanCell), CellUtil.cloneRow(getCell)));
-        Cell scanCell = scanResult.rawCells()[i];
+      assertEquals(0, Bytes.compareTo(CellUtil.cloneFamily(scanCell), CellUtil.cloneFamily(getCell)));
-        Cell getCell = getResult.rawCells()[i];
+      assertEquals(0, Bytes.compareTo(CellUtil.cloneQualifier(scanCell), CellUtil.cloneQualifier(getCell)));
-        assertEquals(0, Bytes.compareTo(CellUtil.cloneRow(scanCell), CellUtil.cloneRow(getCell)));
+      assertEquals(0, Bytes.compareTo(CellUtil.cloneValue(scanCell), CellUtil.cloneValue(getCell)));
-        assertEquals(0, Bytes.compareTo(CellUtil.cloneFamily(scanCell), CellUtil.cloneFamily(getCell)));
-        assertEquals(0, Bytes.compareTo(CellUtil.cloneQualifier(scanCell), CellUtil.cloneQualifier(getCell)));
-        assertEquals(0, Bytes.compareTo(CellUtil.cloneValue(scanCell), CellUtil.cloneValue(getCell)));
-      }
-    } else {
-      fail("The result retrieved from SCAN and Get should be same");
     }
   }
 

hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterList.java

@@ -18,16 +18,11 @@
  */
 package org.apache.hadoop.hbase.filter;
 
-import static org.junit.Assert.assertEquals;
+import com.google.common.collect.Lists;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertTrue;
-
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
-
 import org.apache.hadoop.hbase.Cell;
 import org.apache.hadoop.hbase.CellComparator;
 import org.apache.hadoop.hbase.KeyValue;
@@ -40,11 +35,14 @@ import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;
 import org.apache.hadoop.hbase.testclassification.FilterTests;
 import org.apache.hadoop.hbase.testclassification.SmallTests;
 import org.apache.hadoop.hbase.util.Bytes;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
-import com.google.common.collect.Lists;
-
 /**
  * Tests filter sets
  *
@@ -75,9 +73,48 @@ public class TestFilterList {
     filterList = new FilterList(Operator.MUST_PASS_ALL, Arrays.asList(filter1, filter2));
     filterList.addFilter(new FirstKeyOnlyFilter());
 
+    filterList.setReversed(false);
+    FirstKeyOnlyFilter f = new FirstKeyOnlyFilter();
+    f.setReversed(true);
+    try {
+      filterList.addFilter(f);
+      fail("The IllegalArgumentException should be thrown because the added filter is reversed");
+    } catch (IllegalArgumentException e) {
+    }
+
   }
 
+  @Test
+  public void testConstruction() {
+    FirstKeyOnlyFilter f1 = new FirstKeyOnlyFilter();
+    FirstKeyOnlyFilter f2 = new FirstKeyOnlyFilter();
+    f1.setReversed(true);
+    f2.setReversed(false);
 
+    try {
+      FilterList ff = new FilterList(f1, f2);
+      fail("The IllegalArgumentException should be thrown");
+    } catch (IllegalArgumentException e) {
+    }
+
+    try {
+      FilterList ff = new FilterList(Arrays.asList(f1, f2));
+      fail("The IllegalArgumentException should be thrown because the added filter is reversed");
+    } catch (IllegalArgumentException e) {
+    }
+
+    try {
+      FilterList ff = new FilterList(FilterList.Operator.MUST_PASS_ALL, Arrays.asList(f1, f2));
+      fail("The IllegalArgumentException should be thrown because the added filter is reversed");
+    } catch (IllegalArgumentException e) {
+    }
+
+    try {
+      FilterList ff = new FilterList(FilterList.Operator.MUST_PASS_ALL, f1, f2);
+      fail("The IllegalArgumentException should be thrown because the added filter is reversed");
+    } catch (IllegalArgumentException e) {
+    }
+  }
   /**
    * Test "must pass one"
    * @throws Exception