Various updates for things renamed in the v2 API.

Author: brynh

CHANGES.md

@@ -32,7 +32,7 @@
   `doc/crud.md`) has been migrated to a
   [java source file](https://github.com/cloudant/sync-android/blob/2.0.0/doc/CrudSamples.java).
 
-- [NEW] `databaseWithAdvancedAPIs()` getter on `DocumentStore` for specialist advanced use cases.
+- [NEW] `advanced()` getter on `DocumentStore` for specialist advanced use cases.
   Adds support for creating specific document revisions with history.
 
 - [FIXED] Issue with double encoding of restricted URL characters in credentials when using

cloudant-sync-datastore-core/src/main/java/com/cloudant/sync/internal/query/QueryImpl.java

@@ -94,7 +94,7 @@ public class QueryImpl implements Query {
     private final SQLDatabaseQueue dbQueue;
 
     /**
-     *  Constructs a new IndexManager which indexes documents in 'datastore'
+     *  Constructs a new {@link Query} which indexes documents in 'datastore'
      *  @param database The {@link Database} to index
      */
     public QueryImpl(Database database, File extensionsLocation, KeyProvider keyProvider) throws IOException, SQLException {

cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/documentstore/DatabaseNotificationsMoreTest.java

@@ -117,8 +117,8 @@ public void notification_databaseOpenCloseAndThenOpenedAgain_databaseCreatedEven
         Assert.assertThat(documentStoreClosed.get(0).dbName, endsWith("test123"));
 
         // After database is closed, when it is opened, the
-        // DatabaseOpened event should be fired, but the
-        // DatabaseCreated event should NOT be fired.
+        // DocumentStoreOpened event should be fired, but the
+        // DocumentStoreCreated event should NOT be fired.
         this.clearAllEventList();
         DocumentStore ds1 = DocumentStore.getInstance(new File(datastoreManagerDir, "test123"));
         try {

cloudant-sync-datastore-core/src/test/java/com/cloudant/sync/internal/query/IndexUpdaterTest.java

@@ -1076,7 +1076,7 @@ public void indexUpdatesPersistFromCreation() throws Exception {
             im.close();
         }
 
-        // Get a new IndexManager instance and extract its queue
+        // Get a new Query instance and extract its queue
         im = new QueryImpl(ds, new File(ds.getPath(), "extensions"), new NullKeyProvider());
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
 
@@ -1117,7 +1117,7 @@ public void indexUpdatesPersistExistingIndex() throws Exception {
             im.close();
         }
 
-        // Get a new IndexManager instance and extract its queue
+        // Get a new Query instance and extract its queue
         im = new QueryImpl(ds, new File(ds.getPath(), "extensions"),  new NullKeyProvider());
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
 
@@ -1140,7 +1140,7 @@ public void indexUpdatesPersistExistingIndex() throws Exception {
             im.close();
         }
 
-        // Get a new IndexManager instance and extract its queue
+        // Get a new Query instance and extract its queue
         im = new QueryImpl(ds, new File(ds.getPath(), "extensions"),  new NullKeyProvider());
         indexManagerDatabaseQueue = TestUtils.getDBQueue(im);
         // Check that the updates are still there

doc/conflicts.md

@@ -10,7 +10,7 @@ MVCC data-model is used to do this. This page describes how it works.
 
 ## Replication
 
-The Sync datastore participates in master-less replication with
+The Sync DocumentStore participates in master-less replication with
 [Cloudant][cloudant]
 or [Apache CouchDB][couch]. What this means is that there is no canonical
 copy of the documents in each database. One of the main results of this
@@ -56,17 +56,17 @@ in the tree.
 ### What are conflicts?
 
 When a document has been replicated to more than one place, it's possible to
-edit it concurrently in two places. When the datastores storing the document
+edit it concurrently in two places. When the DocumentStores containing the document
 then replicate with each other again, they each add their changes to the
 document's tree. This causes an extra branch to be added to the tree for
 each concurrent set of changes. When this happens, the document is said to be
 _conflicted_. This creates multiple current revisions of the document, one for
 each of the concurrent changes.
 
 Say we last replicated the document above at the `2-x` revision. We make
-two changes locally (`3-x` and `4-x`) and the remote datastore has a single
+two changes locally (`3-x` and `4-x`) and the remote DocumentStore has a single
 change made to it (`3-y`). On replicating back from the remote, the local
-datastore ends up with a document like this:
+DocumentStore ends up with a document like this:
 
 ```
   replicated from remote
@@ -83,7 +83,7 @@ We now have two non-deleted leaf nodes: the document is conflicted.
 
 ### The "winning" revision
 
-To make things easier, calling `Datastore#getDocument(...)` returns one of
+To make things easier, calling `Database#read(...)` returns one of
 the leaf nodes of the branches of the conflicted document. It selects the
 node to return in an arbitrary but deterministic way, which means that all
 replicas of the database will return the same revision for the document. The
@@ -109,16 +109,16 @@ a helper method to streamline the process of resolving conflicts.
 
 ### Finding conflicted documents
 
-There's a method on the `Datastore` interface:
+There's a method on the `Database` interface:
 
 ```java
-Iterator<String> getConflictedDocumentIds();
+Iterator<String> getConflictedIds();
 ```
 
 This method returns an iterator over the document IDs:
 
 ```java
-for (String docId : datastore.getConflictedDocumentIds()) {
+for (String docId : database.getConflictedIds()) {
     System.out.println(docId);
 }
 ```
@@ -127,8 +127,8 @@ for (String docId : datastore.getConflictedDocumentIds()) {
 
 Once you've found the list of documents, you need to resolve them. This is
 done one-by-one, passing a class able to resolve conflicts and a document
-ID to the `resolveConflictsForDocument(String, ConflictResolver)` method
-of the `Datastore` interface.
+ID to the `resolveConflicts(String, ConflictResolver)` method
+of the `Database` interface.
 
 The `ConflictResolver` interface has one method:
 
@@ -166,7 +166,7 @@ class MergeResolver implements ConflictResolver {
 }
 ```
 
-Conceptually, the `resolveConflictsForDocument` method does the following:
+Conceptually, the `resolveConflicts` method does the following:
 
 1. Get all the non-deleted leaf node revisions for the document.
 
@@ -199,7 +199,7 @@ is no longer conflicted.
 
 All this happens inside a transaction, ensuring consistency.
 
-This resolution can be replicated to the remote document store, bringing
+This resolution can be replicated to the remote DocumentStore, bringing
 the two databases into a consistent state.
 
 ### Simple example
@@ -208,10 +208,10 @@ You could imagine an application running the following method
 via a timer to periodically fix up any conflicts:
 
 ```java
-public void resolveConflicts(Datastore datastore) {
+public void resolveConflicts(DocumentStore ds) {
     ConflictResolver pickFirst = new PickFirstResolver();
-    for (String docId : datastore.getConflictedDocumentIds()) {
-        datastore.resolveConflictsForDocument(docId, pickFirst);
+    for (String docId : ds.database().getConflictedIds()) {
+        ds.database().resolveConflicts(docId, pickFirst);
     }
 }
 ```

doc/query.md

@@ -345,7 +345,7 @@ query.put("$or", Arrays.<Object>asList(petClause, andClause));
 
 ### Executing queries
 
-To find documents matching a query, use the `IndexManager` object's `find(Map<String, Object> query)` method. This returns an object that can be used in `for ( : )` loops to enumerate over the results.
+To find documents matching a query, use the `Query` object's `find(Map<String, Object> query)` method. This returns an object that can be used in `for ( : )` loops to enumerate over the results.
 
 ```java
 QueryResult result = q.find(query);

doc/replication-policies.md

@@ -330,7 +330,7 @@ private boolean mIsBound;
 
 Now we add a [`ServiceConnection`](http://developer.android.com/reference/android/content/ServiceConnection.html)
 to our [`Activity`](http://developer.android.com/reference/android/app/Activity.html)
-to allow us to handle binding and unbinding from our `MyReplicationService`. This enables us to get a reference to the service when we bind to it and add a listener for `replicationComplete` to the [`Service`](http://developer.android.com/reference/android/app/Service.html):
+to allow us to handle binding and unbinding from our `MyReplicationService`. This enables us to get a reference to the service when we bind to it and add a listener for `replicationCompleted` to the [`Service`](http://developer.android.com/reference/android/app/Service.html):
 
 ```java
 private ServiceConnection mConnection = new ServiceConnection() {
@@ -339,7 +339,7 @@ private ServiceConnection mConnection = new ServiceConnection() {
         mReplicationService = ((ReplicationService.LocalBinder) service).getService();
         mReplicationService.addListener(new ReplicationPolicyManager.SimpleReplicationsCompletedListener() {
             @Override
-            public void replicationComplete(int id) {
+            public void replicationCompleted(int id) {
                 // Check if this is the pull replication
                 if (id == MyReplicationService.PULL_REPLICATION_ID) {
                     mHandler.post(new Runnable() {

doc/replication.md

@@ -215,9 +215,9 @@ if (pullReplicator.getState() != Replicator.State.COMPLETE) {
 }
 ```
 
-### Using IndexManager with replication
+### Using `Query` with replication
 
-When using IndexManager for querying data, we recommend you update after
+When using `Query` for querying data, we recommend you update after
 replication completes to avoid a wait for indexing to catch up when the new data
 is first queried:
 
@@ -232,7 +232,7 @@ DocumentStore ds = DocumentStore.getInstance(new File("my_datastore"));
 Replicator replicator = ReplicatorBuilder.pull().from(uri).to(ds).build();
 
 // Create a sample index on type field
-ds.query().ensureIndexed(Arrays.asList(new FieldSort("fieldName")), "indexName");
+ds.query().createJsonIndex(Arrays.asList(new FieldSort("fieldName")), "indexName");
 
 // Use a CountDownLatch to provide a lightweight way to wait for completion
 CountDownLatch latch = new CountDownLatch(1);
@@ -247,7 +247,7 @@ if (replicator.getState() != Replicator.State.COMPLETE) {
 }
 
 // Ensure all indexes are updated after replication
-ds.query().updateAllIndexes();
+ds.query().refreshAllIndexes();
 
 ```