Merge pull request #520 from cloudant/289-move-query-constants

tomblench · web-flow · commit 1ce652194755 · 2017-04-07T15:35:15.000+01:00
Move constants to QueryConstants
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/QueryConstants.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/QueryConstants.java
@@ -16,7 +16,7 @@
 
 package com.cloudant.sync.internal.query;
 
-final class QueryConstants {
+public final class QueryConstants {
 
     public static final String AND = "$and";
 
@@ -54,9 +54,19 @@ private QueryConstants() {
         throw new AssertionError();
     }
 
+    public static final String DB_FILE_NAME = "indexes.sqlite";
+
+    public static final String INDEX_TABLE_PREFIX = "_t_cloudant_sync_query_index_";
+
+    public static final String INDEX_METADATA_TABLE_NAME = "_t_cloudant_sync_query_metadata";
+
+    public static final String EXTENSION_NAME = "com.cloudant.sync.query";
+
+    public static final String INDEX_FIELD_NAME_PATTERN = "^[a-zA-Z][a-zA-Z0-9_]*$";
+
     public static String[] getSchemaVersion1() {
         return new String[] {
-                "CREATE TABLE " + QueryImpl.INDEX_METADATA_TABLE_NAME + " ( " +
+                "CREATE TABLE " + INDEX_METADATA_TABLE_NAME + " ( " +
                 "        index_name TEXT NOT NULL, " +
                 "        index_type TEXT NOT NULL, " +
                 "        field_name TEXT NOT NULL, " +
@@ -66,7 +76,7 @@ public static String[] getSchemaVersion1() {
 
     public static String[] getSchemaVersion2() {
         return new String[] {
-                "ALTER TABLE " + QueryImpl.INDEX_METADATA_TABLE_NAME +
+                "ALTER TABLE " + INDEX_METADATA_TABLE_NAME +
                 "        ADD COLUMN index_settings TEXT NULL;"
         };
     }
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/QueryImpl.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/QueryImpl.java
@@ -78,14 +78,6 @@
  */
 public class QueryImpl implements Query {
 
-    private static final String DB_FILE_NAME = "indexes.sqlite";
-
-    private static final String INDEX_TABLE_PREFIX = "_t_cloudant_sync_query_index_";
-    public static final String INDEX_METADATA_TABLE_NAME = "_t_cloudant_sync_query_metadata";
-
-    private static final String EXTENSION_NAME = "com.cloudant.sync.query";
-    private static final String INDEX_FIELD_NAME_PATTERN = "^[a-zA-Z][a-zA-Z0-9_]*$";
-
     private static final Logger logger = Logger.getLogger(QueryImpl.class.getName());
 
     private final Database database;
@@ -99,10 +91,10 @@ public class QueryImpl implements Query {
      */
     public QueryImpl(Database database, File extensionsLocation, KeyProvider keyProvider) throws IOException, SQLException {
         this.database = database;
-        validFieldName = Pattern.compile(INDEX_FIELD_NAME_PATTERN);
+        validFieldName = Pattern.compile(QueryConstants.INDEX_FIELD_NAME_PATTERN);
 
-        File indexesLocation = new File(extensionsLocation, EXTENSION_NAME);
-        File indexesDatabaseFile = new File(indexesLocation, DB_FILE_NAME);
+        File indexesLocation = new File(extensionsLocation, QueryConstants.EXTENSION_NAME);
+        File indexesDatabaseFile = new File(indexesLocation, QueryConstants.DB_FILE_NAME);
 
         dbQueue = new SQLDatabaseQueue(indexesDatabaseFile, keyProvider);
         dbQueue.updateSchema(new SchemaOnlyMigration(QueryConstants.getSchemaVersion1()), 1);
@@ -237,7 +229,7 @@ public QueryResult find(Map<String, Object> query,
     }
 
     public static String tableNameForIndex(String indexName) {
-        return INDEX_TABLE_PREFIX.concat(indexName);
+        return QueryConstants.INDEX_TABLE_PREFIX.concat(indexName);
     }
 
     protected Database getDatabase() {
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/CreateIndexCallable.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/CreateIndexCallable.java
@@ -16,6 +16,7 @@
 package com.cloudant.sync.internal.query.callables;
 
 import com.cloudant.sync.internal.android.ContentValues;
+import com.cloudant.sync.internal.query.QueryConstants;
 import com.cloudant.sync.internal.query.QueryImpl;
 import com.cloudant.sync.internal.query.TokenizerHelper;
 import com.cloudant.sync.internal.sqlite.SQLCallable;
@@ -55,7 +56,7 @@ public Void call(SQLDatabase database) throws QueryException {
             parameters.put("index_settings", TokenizerHelper.tokenizerToJson(index.tokenizer));
             parameters.put("field_name", fieldName.field);
             parameters.put("last_sequence", 0);
-            long rowId = database.insert(QueryImpl.INDEX_METADATA_TABLE_NAME,
+            long rowId = database.insert(QueryConstants.INDEX_METADATA_TABLE_NAME,
                     parameters);
             if (rowId < 0) {
                 throw new QueryException("Error inserting index metadata");
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/DeleteIndexCallable.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/DeleteIndexCallable.java
@@ -15,6 +15,7 @@
 
 package com.cloudant.sync.internal.query.callables;
 
+import com.cloudant.sync.internal.query.QueryConstants;
 import com.cloudant.sync.internal.query.QueryImpl;
 import com.cloudant.sync.internal.sqlite.SQLCallable;
 import com.cloudant.sync.internal.sqlite.SQLDatabase;
@@ -42,7 +43,7 @@ public Void call(SQLDatabase database) throws QueryException {
 
             // Delete the metadata entries
             String where = " index_name = ? ";
-            database.delete(QueryImpl.INDEX_METADATA_TABLE_NAME, where, new String[]{indexName});
+            database.delete(QueryConstants.INDEX_METADATA_TABLE_NAME, where, new String[]{indexName});
         } catch (SQLException e) {
             String msg = String.format("Failed to delete index: %s", indexName);
             throw new QueryException(msg, e);
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/ListIndexesCallable.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/ListIndexesCallable.java
@@ -15,6 +15,7 @@
 
 package com.cloudant.sync.internal.query.callables;
 
+import com.cloudant.sync.internal.query.QueryConstants;
 import com.cloudant.sync.internal.query.QueryImpl;
 import com.cloudant.sync.internal.query.TokenizerHelper;
 import com.cloudant.sync.internal.sqlite.Cursor;
@@ -38,7 +39,7 @@ public class ListIndexesCallable implements SQLCallable<List<Index>> {
     @Override
     public List<Index> call(SQLDatabase db) throws Exception {
         // Accumulate indexes and definitions into a map
-        String sqlIndexNames = String.format("SELECT DISTINCT index_name FROM %s", QueryImpl
+        String sqlIndexNames = String.format("SELECT DISTINCT index_name FROM %s", QueryConstants
                 .INDEX_METADATA_TABLE_NAME);
         Cursor cursorIndexNames = null;
         ArrayList<Index> indexes = new ArrayList<Index>();
@@ -47,7 +48,7 @@ public List<Index> call(SQLDatabase db) throws Exception {
             while (cursorIndexNames.moveToNext()) {
                 String indexName = cursorIndexNames.getString(0);
                 String sqlIndexes = String.format("SELECT index_type, field_name, index_settings " +
-                        "FROM %s WHERE index_name = ?", QueryImpl.INDEX_METADATA_TABLE_NAME);
+                        "FROM %s WHERE index_name = ?", QueryConstants.INDEX_METADATA_TABLE_NAME);
                 Cursor cursorIndexes = null;
                 try {
                     cursorIndexes = db.rawQuery(sqlIndexes, new String[]{indexName});
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/SequenceNumberForIndexCallable.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/SequenceNumberForIndexCallable.java
@@ -15,6 +15,7 @@
 
 package com.cloudant.sync.internal.query.callables;
 
+import com.cloudant.sync.internal.query.QueryConstants;
 import com.cloudant.sync.internal.query.QueryImpl;
 import com.cloudant.sync.internal.sqlite.Cursor;
 import com.cloudant.sync.internal.sqlite.SQLCallable;
@@ -40,7 +41,7 @@ public SequenceNumberForIndexCallable(String indexName) {
     public Long call(SQLDatabase database) {
         long result = 0;
         String sql = String.format("SELECT last_sequence FROM %s WHERE index_name = ?",
-                QueryImpl.INDEX_METADATA_TABLE_NAME);
+                QueryConstants.INDEX_METADATA_TABLE_NAME);
         Cursor cursor = null;
         try {
             cursor = database.rawQuery(sql, new String[]{indexName});
diff --git a/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/UpdateMetadataForIndexCallable.java b/cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/callables/UpdateMetadataForIndexCallable.java
@@ -16,6 +16,7 @@
 package com.cloudant.sync.internal.query.callables;
 
 import com.cloudant.sync.internal.android.ContentValues;
+import com.cloudant.sync.internal.query.QueryConstants;
 import com.cloudant.sync.internal.query.QueryImpl;
 import com.cloudant.sync.internal.sqlite.SQLCallable;
 import com.cloudant.sync.internal.sqlite.SQLDatabase;
@@ -37,7 +38,7 @@ public UpdateMetadataForIndexCallable(long lastSequence, String indexName) {
     public Void call(SQLDatabase database) throws QueryException {
         ContentValues v = new ContentValues();
         v.put("last_sequence", lastSequence);
-        int row = database.update(QueryImpl.INDEX_METADATA_TABLE_NAME,
+        int row = database.update(QueryConstants.INDEX_METADATA_TABLE_NAME,
                                   v,
                                   " index_name = ? ",
                                   new String[]{indexName});
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/AbstractIndexTestBase.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/AbstractIndexTestBase.java
@@ -49,7 +49,7 @@ public void setUp() throws Exception {
         assertThat(im, is(notNullValue()));
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(indexManagerDatabaseQueue, is(notNullValue()));
-        String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };
+        String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };
         SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue,
                                                metadataTableList);
     }
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/IndexUpdaterTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/IndexUpdaterTest.java
@@ -1162,7 +1162,7 @@ public void indexUpdatesPersistExistingIndex() throws Exception {
     private long getIndexSequenceNumber(String indexName) throws Exception {
         String where = String.format("index_name = \"%s\" group by last_sequence", indexName);
         final String sql = String.format("SELECT last_sequence FROM %s where %s",
-                                   QueryImpl.INDEX_METADATA_TABLE_NAME,
+                                   QueryConstants.INDEX_METADATA_TABLE_NAME,
                                    where);
 
        return indexManagerDatabaseQueue.submit(new SQLCallable<Long>() {
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryCoveringIndexesTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryCoveringIndexesTest.java
@@ -97,7 +97,7 @@ public void setUp() throws Exception{
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(im, is(notNullValue()));
         assertThat(indexManagerDatabaseQueue, is(notNullValue()));
-        String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };
+        String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };
         SQLDatabaseTestUtils.assertTablesExist(TestUtils.getDBQueue(im), metadataTableList);
     }
 
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryFilterFieldsTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryFilterFieldsTest.java
@@ -50,7 +50,7 @@ public void setUp() throws Exception {
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(im, is(notNullValue()));
         assertThat(indexManagerDatabaseQueue, is(notNullValue()));
-        String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };
+        String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };
         SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue, metadataTableList);
 
         setUpBasicQueryData();
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryResultTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryResultTest.java
@@ -50,7 +50,7 @@ public void setUp() throws Exception {
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(im, is(notNullValue()));
         assertThat(indexManagerDatabaseQueue, is(notNullValue()));
-        String[] metadataTableList = new String[]{QueryImpl.INDEX_METADATA_TABLE_NAME};
+        String[] metadataTableList = new String[]{QueryConstants.INDEX_METADATA_TABLE_NAME};
         SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue, metadataTableList);
 
         queue = new SQLDatabaseQueue(new File(factoryPath, "/db.sync"), new NullKeyProvider());
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QuerySortTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QuerySortTest.java
@@ -53,7 +53,7 @@ public void setUp() throws Exception {
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(im, is(notNullValue()));
         assertThat(TestUtils.getDBQueue(im), is(notNullValue()));
-        String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };
+        String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };
         SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue, metadataTableList);
 
         Index indexA = new Index(Arrays.<FieldSort>asList(new FieldSort("name"), new FieldSort("age"), new FieldSort("pet")), "a", IndexType.JSON, null);
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryTextSearchTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryTextSearchTest.java
@@ -50,7 +50,7 @@ public void setUp() throws Exception {
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(im, is(notNullValue()));
         assertThat(indexManagerDatabaseQueue, is(notNullValue()));
-        String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };
+        String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };
         SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue, metadataTableList);
 
         DocumentRevision rev = new DocumentRevision("mike12");
diff --git a/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryWithoutCoveringIndexesTest.java b/cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/QueryWithoutCoveringIndexesTest.java
@@ -94,7 +94,7 @@ public void setUp() throws Exception {
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         assertThat(im, is(notNullValue()));
         assertThat(indexManagerDatabaseQueue, is(notNullValue()));
-        String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };
+        String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };
         SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue, metadataTableList);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public void setUp() throws Exception {`
`49`	`49`	`assertThat(im, is(notNullValue()));`
`50`	`50`	`indexManagerDatabaseQueue = TestUtils.getDBQueue(im);`
`51`	`51`	`assertThat(indexManagerDatabaseQueue, is(notNullValue()));`
`52`		`- String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };`
	`52`	`+ String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };`
`53`	`53`	`SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue,`
`54`	`54`	`metadataTableList);`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public void setUp() throws Exception{`
`97`	`97`	`indexManagerDatabaseQueue = TestUtils.getDBQueue(im);`
`98`	`98`	`assertThat(im, is(notNullValue()));`
`99`	`99`	`assertThat(indexManagerDatabaseQueue, is(notNullValue()));`
`100`		`- String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };`
	`100`	`+ String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };`
`101`	`101`	`SQLDatabaseTestUtils.assertTablesExist(TestUtils.getDBQueue(im), metadataTableList);`
`102`	`102`	`}`
`103`	`103`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ public void setUp() throws Exception {`
`94`	`94`	`indexManagerDatabaseQueue = TestUtils.getDBQueue(im);`
`95`	`95`	`assertThat(im, is(notNullValue()));`
`96`	`96`	`assertThat(indexManagerDatabaseQueue, is(notNullValue()));`
`97`		`- String[] metadataTableList = new String[] { QueryImpl.INDEX_METADATA_TABLE_NAME };`
	`97`	`+ String[] metadataTableList = new String[] { QueryConstants.INDEX_METADATA_TABLE_NAME };`
`98`	`98`	`SQLDatabaseTestUtils.assertTablesExist(indexManagerDatabaseQueue, metadataTableList);`
`99`	`99`	`}`
`100`	`100`