]> source.dussan.org Git - iciql.git/commitdiff
Added bitwise AND and XOR DSL for where clauses
authorJames Moger <james.moger@gitblit.com>
Mon, 30 Jan 2017 21:38:24 +0000 (16:38 -0500)
committerJames Moger <james.moger@gitblit.com>
Mon, 30 Jan 2017 21:46:03 +0000 (16:46 -0500)
13 files changed:
CHANGELOG.md
src/main/java/com/iciql/BitCondition.java [new file with mode: 0644]
src/main/java/com/iciql/Bitwise.java [new file with mode: 0644]
src/main/java/com/iciql/QueryCondition.java
src/main/java/com/iciql/SQLDialect.java
src/main/java/com/iciql/SQLDialectDefault.java
src/main/java/com/iciql/SQLDialectDerby.java
src/main/java/com/iciql/SQLDialectH2.java
src/main/java/com/iciql/SQLDialectHSQL.java
src/main/java/com/iciql/SQLDialectPostgreSQL.java
src/main/java/com/iciql/SQLDialectSQLite.java
src/test/java/com/iciql/test/BitwiseConditionTest.java [new file with mode: 0644]
src/test/java/com/iciql/test/IciqlSuite.java

index 6bb1219e3e5c3cef3719ef36ef45397e6773b9f8..144da0a37fcd152e46ceadc77b9e0973704985e9 100644 (file)
@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### [Unreleased][unreleased]
+#### Added
+- Added bitwise AND and XOR DSL for where clauses
+
 ### [2.1.1] - 2016-04-07
 #### Added
 - Add explicit `where(String)` method to help with non-Java language interop
diff --git a/src/main/java/com/iciql/BitCondition.java b/src/main/java/com/iciql/BitCondition.java
new file mode 100644 (file)
index 0000000..e76333f
--- /dev/null
@@ -0,0 +1,82 @@
+/*\r
+ * Copyright 2017 James Moger.\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ *     http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+\r
+package com.iciql;\r
+\r
+/**\r
+ * A bitwise condition contains two operands, a bit operation, and a comparison test.\r
+ *\r
+ * @param <A> the operand type\r
+ */\r
+\r
+class BitCondition<A, T> implements Token, Bitwise<A, T> {\r
+\r
+    enum Bitwise {\r
+        AND, XOR\r
+    }\r
+\r
+    Bitwise bitwiseType;\r
+    CompareType compareType;\r
+    A x, y, z;\r
+    Query<T> query;\r
+\r
+    BitCondition(A x, A y, Bitwise bitwiseType, Query<T> query) {\r
+        this.bitwiseType = bitwiseType;\r
+        this.x = x;\r
+        this.y = y;\r
+        this.query = query;\r
+    }\r
+\r
+    public QueryWhere<T> exceeds(A y) {\r
+        z = y;\r
+        compareType = CompareType.EXCEEDS;\r
+        return new QueryWhere<T>(query);\r
+    }\r
+\r
+    public QueryWhere<T> atLeast(A y) {\r
+        z = y;\r
+        compareType = CompareType.AT_LEAST;\r
+        return new QueryWhere<T>(query);\r
+    }\r
+\r
+    public QueryWhere<T> lessThan(A y) {\r
+        z = y;\r
+        compareType = CompareType.LESS_THAN;\r
+        return new QueryWhere<T>(query);\r
+    }\r
+\r
+    public QueryWhere<T> atMost(A y) {\r
+        z = y;\r
+        compareType = CompareType.AT_MOST;\r
+        return new QueryWhere<T>(query);\r
+    }\r
+\r
+    @SuppressWarnings("unchecked")\r
+    public <T> void appendSQL(SQLStatement stat, Query<T> query) {\r
+        stat.appendSQL("(");\r
+        switch (bitwiseType) {\r
+            case AND:\r
+                query.getDb().getDialect().prepareBitwiseAnd(stat, query, x, y);\r
+                break;\r
+            case XOR:\r
+                query.getDb().getDialect().prepareBitwiseXor(stat, query, x, y);\r
+                break;\r
+        }\r
+        stat.appendSQL(")");\r
+        stat.appendSQL(compareType.getString());\r
+        stat.appendSQL("" + z);\r
+    }\r
+}\r
diff --git a/src/main/java/com/iciql/Bitwise.java b/src/main/java/com/iciql/Bitwise.java
new file mode 100644 (file)
index 0000000..a2d1da5
--- /dev/null
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2017 James Moger.
+ *
+ * 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 com.iciql;
+
+/**
+ * @author James Moger
+ */
+public interface Bitwise<A, T> {
+
+    QueryWhere<T> exceeds(A y);
+
+    QueryWhere<T> atLeast(A y);
+
+    QueryWhere<T> lessThan(A y);
+
+    QueryWhere<T> atMost(A y);
+}
index 56de97694d191bad66271b8b298185fc779d0807..b7cb0d4d2b0c30018cdf8bc384ec6ba1e24eb452 100644 (file)
@@ -147,4 +147,17 @@ public class QueryCondition<T, A> {
         query.addConditionToken(new RuntimeParameter<A>(x, CompareType.LIKE));
         return new QueryWhere<T>(query);
     }
+
+    public Bitwise<A, T> bitAnd(A y) {
+        BitCondition<A, T> bitCondition = new BitCondition<A, T>(x, y, BitCondition.Bitwise.AND, query);
+        query.addConditionToken(bitCondition);
+        return bitCondition;
+    }
+
+    public Bitwise<A, T> bitXor(A y) {
+        BitCondition<A, T> bitCondition = new BitCondition<A, T>(x, y, BitCondition.Bitwise.XOR, query);
+        query.addConditionToken(bitCondition);
+        return bitCondition;
+    }
+
 }
index 1cb4931d9781f93f1dbbefe73a0f921b617e3909..081b7e6cbe830509497508485a5eaab30f8fa98b 100644 (file)
@@ -202,4 +202,8 @@ public interface SQLDialect {
      */
     String extractColumnName(String name);
 
+    <T, A> void prepareBitwiseAnd(SQLStatement stat, Query<T> query, A x, A y);
+
+    <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y);
+
 }
index 4f635a9965df28a5a5617b9a70dbb8a9807b48ba..98f63c45580760fd1d811905ffa69162f3f69452 100644 (file)
@@ -529,4 +529,18 @@ public class SQLDialectDefault implements SQLDialect {
         return o.toString();
     }
 
+    @Override
+    public <T, A> void prepareBitwiseAnd(SQLStatement stat, Query<T> query, A x, A y) {
+        query.appendSQL(stat, null, x);
+        stat.appendSQL(" & ");
+        query.appendSQL(stat, x, y);
+    }
+
+    @Override
+    public <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y) {
+        query.appendSQL(stat, null, x);
+        stat.appendSQL(" ^ ");
+        query.appendSQL(stat, x, y);
+    }
+
 }
index 77fc73ee4591d2aa12aa839dfcd2e54a77e2df7a..fcaee1e1dd7aa73fbb3df6303d901d58c2fae7b7 100644 (file)
@@ -68,4 +68,15 @@ public class SQLDialectDerby extends SQLDialectDefault {
         stat.setSQL(buff.toString());\r
         return;\r
     }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseAnd(SQLStatement stat, Query<T> query, A x, A y) {\r
+        throw new IciqlException("{0} does not support bitwise operator AND", databaseName);\r
+    }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y) {\r
+        throw new IciqlException("{0} does not support bitwise operator XOR", databaseName);\r
+    }\r
+\r
 }
\ No newline at end of file
index 12cc161d10dc42e470e68f5beced14b067f62292..71c11a5e08b64248b4548e8d58d8cf0db67f0a47 100644 (file)
@@ -133,4 +133,23 @@ public class SQLDialectH2 extends SQLDialectDefault {
         buff.append(')');\r
         stat.setSQL(buff.toString());\r
     }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseAnd(SQLStatement stat, Query<T> query, A x, A y) {\r
+        stat.appendSQL("BITAND(");\r
+        query.appendSQL(stat, null, x);\r
+        stat.appendSQL(",");\r
+        query.appendSQL(stat, x, y);\r
+        stat.appendSQL(")");\r
+    }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y) {\r
+        stat.appendSQL("BITXOR(");\r
+        query.appendSQL(stat, null, x);\r
+        stat.appendSQL(",");\r
+        query.appendSQL(stat, x, y);\r
+        stat.appendSQL(")");\r
+    }\r
+\r
 }
\ No newline at end of file
index 74a3dcc3e73d873b8450ce6c523b05c36df5e694..43e6588e758d0f4533a8b8566160cbf1033eb3c6 100644 (file)
@@ -147,4 +147,23 @@ public class SQLDialectHSQL extends SQLDialectDefault {
         buff.append(')');\r
         stat.setSQL(buff.toString());\r
     }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseAnd(SQLStatement stat, Query<T> query, A x, A y) {\r
+        stat.appendSQL("BITAND(");\r
+        query.appendSQL(stat, null, x);\r
+        stat.appendSQL(",");\r
+        query.appendSQL(stat, x, y);\r
+        stat.appendSQL(")");\r
+    }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y) {\r
+        stat.appendSQL("BITXOR(");\r
+        query.appendSQL(stat, null, x);\r
+        stat.appendSQL(",");\r
+        query.appendSQL(stat, x, y);\r
+        stat.appendSQL(")");\r
+    }\r
+\r
 }
\ No newline at end of file
index 97b92f8bb7a86067907c5257678f688cc8747134..103c4807ecdc953a3bc23395df125c489b429a02 100644 (file)
@@ -158,4 +158,10 @@ public class SQLDialectPostgreSQL extends SQLDialectDefault {
         stat.setSQL(buff.toString());\r
     }\r
 \r
+    @Override\r
+    public <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y) {\r
+        query.appendSQL(stat, null, x);\r
+        stat.appendSQL(" # ");\r
+        query.appendSQL(stat, x, y);\r
+    }\r
 }
\ No newline at end of file
index b99bf96454fdda68ca41a4bce0c06a2ac7352779..35cd0f6e663afce7194820c307ad8da2d7f1165f 100644 (file)
@@ -177,4 +177,9 @@ public class SQLDialectSQLite extends SQLDialectDefault {
         }\r
         return super.prepareStringParameter(o);\r
     }\r
+\r
+    @Override\r
+    public <T, A> void prepareBitwiseXor(SQLStatement stat, Query<T> query, A x, A y) {\r
+        throw new IciqlException("{0} does not support bitwise operator XOR", databaseName);\r
+    }\r
 }\r
diff --git a/src/test/java/com/iciql/test/BitwiseConditionTest.java b/src/test/java/com/iciql/test/BitwiseConditionTest.java
new file mode 100644 (file)
index 0000000..17b4948
--- /dev/null
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2017 James Moger.
+ *
+ * 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 com.iciql.test;
+
+import com.iciql.Db;
+import com.iciql.test.models.Product;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.sql.SQLException;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * @author James Moger
+ */
+public class BitwiseConditionTest {
+
+    /**
+     * This object represents a database (actually a connection to the
+     * database).
+     */
+
+    private Db db;
+
+    @Before
+    public void setUp() {
+        db = IciqlSuite.openNewDb();
+        db.insertAll(Product.getList());
+    }
+
+    @After
+    public void tearDown() {
+        db.close();
+    }
+
+    @Test
+    public void testBitwiseAndWhereCondition() throws SQLException {
+        Product products = new Product();
+        List<Product> list = db.from(products).where(products.unitsInStock).bitAnd(1).exceeds(0).select();
+
+        assertTrue("Bitwise AND list is empty!", !list.isEmpty());
+        assertEquals("Unexpected results for bitwise AND test", 7, list.size());
+        Set<Integer> ids = new HashSet<Integer>();
+        for (Product p : list) {
+            ids.add(p.getId());
+        }
+        assertTrue("Unexpected id in Bitwise AND where condition test", ids.containsAll(Arrays.asList(1, 2, 3, 4, 7, 9, 10)));
+    }
+
+    @Test
+    public void testBitwiseXorWhereCondition() throws SQLException {
+        Product products = new Product();
+        List<Product> list = db.from(products).where(products.unitsInStock).bitXor(39).exceeds(0).select();
+
+        assertTrue("Bitwise XOR list is empty!", !list.isEmpty());
+        assertEquals("Unexpected results for bitwise XOR test", 9, list.size());
+        Set<Integer> ids = new HashSet<Integer>();
+        for (Product p : list) {
+            ids.add(p.getId());
+        }
+        assertTrue("Expected id in Bitwise XOR where condition test", ids.containsAll(Arrays.asList( 2, 3, 4, 5, 6, 7, 8, 9, 10)));
+    }
+
+}
index df5e4d668f767d4971595d486b426da13733df7c..a5470d9d2ad3f1248732f454d092c4a178434c16 100644 (file)
@@ -95,7 +95,7 @@ import java.util.Map;
         ConcurrencyTest.class, EnumsTest.class, ModelsTest.class, PrimitivesTest.class, OneOfTest.class,
         RuntimeQueryTest.class, SamplesTest.class, UpdateTest.class, UpgradesTest.class, JoinTest.class,
         UUIDTest.class, ViewsTest.class, ForeignKeyTest.class, TransactionTest.class, NestedConditionsTest.class,
-        DataTypeAdapterTest.class, ProductDaoTest.class})
+        DataTypeAdapterTest.class, ProductDaoTest.class, BitwiseConditionTest.class})
 public class IciqlSuite {
     private final static File baseFolder = new File(System.getProperty("user.dir"), "/testdbs");
     private static final TestDb[] TEST_DBS = {