Clarify inclusive vs exclusive for isBetween API

benmccann · benmccann · commit 71db077f948c · 2017-11-12T11:18:16.000-08:00
diff --git a/core/src/main/java/tech/tablesaw/columns/ColumnReference.java b/core/src/main/java/tech/tablesaw/columns/ColumnReference.java
@@ -29,7 +29,8 @@
 import tech.tablesaw.filtering.FloatGreaterThanOrEqualTo;
 import tech.tablesaw.filtering.FloatLessThan;
 import tech.tablesaw.filtering.FloatLessThanOrEqualTo;
-import tech.tablesaw.filtering.IntBetween;
+import tech.tablesaw.filtering.IntBetweenExclusive;
+import tech.tablesaw.filtering.IntBetweenInclusive;
 import tech.tablesaw.filtering.IntEqualTo;
 import tech.tablesaw.filtering.IntGreaterThan;
 import tech.tablesaw.filtering.IntGreaterThanOrEqualTo;
@@ -38,7 +39,8 @@
 import tech.tablesaw.filtering.IntLessThanOrEqualTo;
 import tech.tablesaw.filtering.IsMissing;
 import tech.tablesaw.filtering.IsNotMissing;
-import tech.tablesaw.filtering.LocalDateBetween;
+import tech.tablesaw.filtering.LocalDateBetweenExclusive;
+import tech.tablesaw.filtering.LocalDateBetweenInclusive;
 import tech.tablesaw.filtering.StringEqualTo;
 import tech.tablesaw.filtering.StringNotEqualTo;
 import tech.tablesaw.filtering.TimeEqualTo;
@@ -136,12 +138,20 @@ public Filter isEqualTo(ColumnReference reference) {
         return new ColumnEqualTo(this, reference);
     }
 
-    public Filter isBetween(int low, int high) {
-        return new IntBetween(this, low, high);
+    public Filter isBetweenIncluding(int low, int high) {
+        return new IntBetweenInclusive(this, low, high);
     }
 
-    public Filter isBetween(LocalDate low, LocalDate high) {
-        return new LocalDateBetween(this, low, high);
+    public Filter isBetweenIncluding(LocalDate low, LocalDate high) {
+        return new LocalDateBetweenInclusive(this, low, high);
+    }
+
+    public Filter isBetweenExcluding(int low, int high) {
+        return new IntBetweenExclusive(this, low, high);
+    }
+
+    public Filter isBetweenExcluding(LocalDate low, LocalDate high) {
+        return new LocalDateBetweenExclusive(this, low, high);
     }
 
     public Filter isEqualTo(float value) {
diff --git a/core/src/main/java/tech/tablesaw/filtering/IntBetweenExclusive.java b/core/src/main/java/tech/tablesaw/filtering/IntBetweenExclusive.java
@@ -19,12 +19,12 @@
 import tech.tablesaw.columns.ColumnReference;
 import tech.tablesaw.util.Selection;
 
-public class IntBetween extends ColumnFilter {
+public class IntBetweenExclusive extends ColumnFilter {
 
     private final int low;
     private final int high;
 
-    public IntBetween(ColumnReference reference, int lowValue, int highValue) {
+    public IntBetweenExclusive(ColumnReference reference, int lowValue, int highValue) {
         super(reference);
         this.low = lowValue;
         this.high = highValue;
diff --git a/core/src/main/java/tech/tablesaw/filtering/IntBetweenInclusive.java b/core/src/main/java/tech/tablesaw/filtering/IntBetweenInclusive.java
@@ -0,0 +1,39 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package tech.tablesaw.filtering;
+
+import tech.tablesaw.api.IntColumn;
+import tech.tablesaw.api.Table;
+import tech.tablesaw.columns.ColumnReference;
+import tech.tablesaw.util.Selection;
+
+public class IntBetweenInclusive extends ColumnFilter {
+
+    private final int low;
+    private final int high;
+
+    public IntBetweenInclusive(ColumnReference reference, int lowValue, int highValue) {
+        super(reference);
+        this.low = lowValue;
+        this.high = highValue;
+    }
+
+    public Selection apply(Table relation) {
+        IntColumn intColumn = (IntColumn) relation.column(columnReference.getColumnName());
+        Selection matches = intColumn.isGreaterThanOrEqualTo(low);
+        matches.toBitmap().and(intColumn.isLessThanOrEqualTo(high).toBitmap());
+        return matches;
+    }
+}
diff --git a/core/src/main/java/tech/tablesaw/filtering/LocalDateBetweenExclusive.java b/core/src/main/java/tech/tablesaw/filtering/LocalDateBetweenExclusive.java
@@ -21,11 +21,11 @@
 import tech.tablesaw.columns.ColumnReference;
 import tech.tablesaw.util.Selection;
 
-public class LocalDateBetween extends ColumnFilter {
+public class LocalDateBetweenExclusive extends ColumnFilter {
     private final LocalDate low;
     private final LocalDate high;
 
-    public LocalDateBetween(ColumnReference reference, LocalDate lowValue, LocalDate highValue) {
+    public LocalDateBetweenExclusive(ColumnReference reference, LocalDate lowValue, LocalDate highValue) {
         super(reference);
         this.low = lowValue;
         this.high = highValue;
diff --git a/core/src/main/java/tech/tablesaw/filtering/LocalDateBetweenInclusive.java b/core/src/main/java/tech/tablesaw/filtering/LocalDateBetweenInclusive.java
@@ -0,0 +1,40 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package tech.tablesaw.filtering;
+
+import java.time.LocalDate;
+
+import tech.tablesaw.api.DateColumn;
+import tech.tablesaw.api.Table;
+import tech.tablesaw.columns.ColumnReference;
+import tech.tablesaw.util.Selection;
+
+public class LocalDateBetweenInclusive extends ColumnFilter {
+    private final LocalDate low;
+    private final LocalDate high;
+
+    public LocalDateBetweenInclusive(ColumnReference reference, LocalDate lowValue, LocalDate highValue) {
+        super(reference);
+        this.low = lowValue;
+        this.high = highValue;
+    }
+
+    public Selection apply(Table relation) {
+        DateColumn column = (DateColumn) relation.column(columnReference.getColumnName());
+        Selection matches = column.isOnOrAfter(low);
+        matches.and(column.isOnOrBefore(high));
+        return matches;
+    }
+}
diff --git a/core/src/test/java/tech/tablesaw/integration/ExamplesTest.java b/core/src/test/java/tech/tablesaw/integration/ExamplesTest.java
@@ -62,7 +62,7 @@ public static void main(String[] args) throws Exception {
 
         // Lets filtering out some of the rows. We're only interested in records with IDs between 524-624
 
-        Table filtered = table.selectWhere(QueryHelper.column("stop_id").isBetween(524, 624));
+        Table filtered = table.selectWhere(QueryHelper.column("stop_id").isBetweenIncluding(524, 624));
         out(filtered.first(5));
 
         // Write out the new CSV file
