Added URI pattern selector and QueryBatcherBuilder

Author: rjrudin

build.gradle

@@ -7,8 +7,8 @@ plugins {
 	id "com.github.jk1.dependency-license-report" version "0.3.11"
 }
 
-sourceCompatibility = "1.7"
-targetCompatibility = "1.7"
+sourceCompatibility = "1.8"
+targetCompatibility = "1.8"
 
 repositories {
   jcenter()

src/main/java/com/marklogic/client/ext/datamovement/CollectionsQueryBatcherBuilder.java

@@ -0,0 +1,24 @@
+package com.marklogic.client.ext.datamovement;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.datamovement.DataMovementManager;
+import com.marklogic.client.datamovement.QueryBatcher;
+import com.marklogic.client.query.StructuredQueryDefinition;
+
+/**
+ * Builds a QueryBatcher based on an array of collection URIs.
+ */
+public class CollectionsQueryBatcherBuilder implements QueryBatcherBuilder {
+
+	private String[] collectionUris;
+
+	public CollectionsQueryBatcherBuilder(String... collectionUris) {
+		this.collectionUris = collectionUris;
+	}
+
+	@Override
+	public QueryBatcher buildQueryBatcher(DatabaseClient databaseClient, DataMovementManager dataMovementManager) {
+		StructuredQueryDefinition query = databaseClient.newQueryManager().newStructuredQueryBuilder().collection(collectionUris);
+		return dataMovementManager.newQueryBatcher(query);
+	}
+}

src/main/java/com/marklogic/client/ext/datamovement/QueryBatcherBuilder.java

@@ -0,0 +1,13 @@
+package com.marklogic.client.ext.datamovement;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.datamovement.DataMovementManager;
+import com.marklogic.client.datamovement.QueryBatcher;
+
+/**
+ * Abstracts away how a QueryBatcher is constructed.
+ */
+public interface QueryBatcherBuilder {
+
+	QueryBatcher buildQueryBatcher(DatabaseClient databaseClient, DataMovementManager dataMovementManager);
+}

src/main/java/com/marklogic/client/ext/datamovement/QueryBatcherTemplate.java

@@ -40,7 +40,7 @@ public QueryBatcherTemplate(DatabaseClient databaseClient) {
 	 * @return
 	 */
 	public QueryBatcherJobTicket applyOnCollections(QueryBatchListener listener, String... collectionUris) {
-		return applyOnStructuredQuery(listener, databaseClient.newQueryManager().newStructuredQueryBuilder().collection(collectionUris));
+		return apply(listener, new CollectionsQueryBatcherBuilder(collectionUris));
 	}
 
 	/**
@@ -51,7 +51,18 @@ public QueryBatcherJobTicket applyOnCollections(QueryBatchListener listener, Str
 	 * @return
 	 */
 	public QueryBatcherJobTicket applyOnDocuments(QueryBatchListener listener, String... documentUris) {
-		return applyOnStructuredQuery(listener, databaseClient.newQueryManager().newStructuredQueryBuilder().document(documentUris));
+		return apply(listener, new UrisQueryBatcherBuilder(documentUris));
+	}
+
+	/**
+	 * Apply the given listener on batches of documents with URIs matching the given URI pattern.
+	 *
+	 * @param listener
+	 * @param uriPattern
+	 * @return
+	 */
+	public QueryBatcherJobTicket applyOnUriPattern(QueryBatchListener listener, String uriPattern) {
+		return apply(listener, new UriPatternQueryBatcherBuilder(uriPattern));
 	}
 
 	/**
@@ -109,6 +120,18 @@ public QueryBatcherJobTicket applyOnIterator(QueryBatchListener listener, Iterat
 		return apply(listener, dataMovementManager.newQueryBatcher(uriIterator));
 	}
 
+	/**
+	 * Apply the given listener on batches of documents returning by the QueryBatcher that's constructed by the
+	 * given QueryBatcherBuilder.
+	 *
+	 * @param listener
+	 * @param queryBatcherBuilder
+	 * @return
+	 */
+	public QueryBatcherJobTicket apply(QueryBatchListener listener, QueryBatcherBuilder queryBatcherBuilder) {
+		return apply(listener, queryBatcherBuilder.buildQueryBatcher(databaseClient, dataMovementManager));
+	}
+
 	/**
 	 * Apply the given listener with the given QueryBatcher. The QueryBatcher should have been constructed via the
 	 * DatabaseClient that was used to instantiate this class.

src/main/java/com/marklogic/client/ext/datamovement/UriPatternQueryBatcherBuilder.java

@@ -0,0 +1,37 @@
+package com.marklogic.client.ext.datamovement;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.datamovement.DataMovementManager;
+import com.marklogic.client.datamovement.QueryBatcher;
+import com.marklogic.client.eval.EvalResult;
+
+import java.util.Iterator;
+
+/**
+ * Builds a QueryBatcher based on a URI pattern that is fed into cts:uri-match via an eval call.
+ */
+public class UriPatternQueryBatcherBuilder implements QueryBatcherBuilder {
+
+	private String uriPattern;
+
+	public UriPatternQueryBatcherBuilder(String uriPattern) {
+		this.uriPattern = uriPattern;
+	}
+
+	@Override
+	public QueryBatcher buildQueryBatcher(DatabaseClient databaseClient, DataMovementManager dataMovementManager) {
+		final Iterator<EvalResult> evalResults = databaseClient.newServerEval().xquery(String.format("cts:uri-match('%s')", uriPattern)).eval().iterator();
+		Iterator<String> stringIterator = new Iterator<String>() {
+			@Override
+			public boolean hasNext() {
+				return evalResults.hasNext();
+			}
+
+			@Override
+			public String next() {
+				return evalResults.next().getString();
+			}
+		};
+		return dataMovementManager.newQueryBatcher(stringIterator);
+	}
+}

src/main/java/com/marklogic/client/ext/datamovement/UrisQueryBatcherBuilder.java

@@ -0,0 +1,24 @@
+package com.marklogic.client.ext.datamovement;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.datamovement.DataMovementManager;
+import com.marklogic.client.datamovement.QueryBatcher;
+import com.marklogic.client.query.StructuredQueryDefinition;
+
+/**
+ * Builds a QueryBatcher based on an array of document URIs.
+ */
+public class UrisQueryBatcherBuilder implements QueryBatcherBuilder {
+
+	private String[] documentUris;
+
+	public UrisQueryBatcherBuilder(String... documentUris) {
+		this.documentUris = documentUris;
+	}
+
+	@Override
+	public QueryBatcher buildQueryBatcher(DatabaseClient databaseClient, DataMovementManager dataMovementManager) {
+		StructuredQueryDefinition query = databaseClient.newQueryManager().newStructuredQueryBuilder().document(documentUris);
+		return dataMovementManager.newQueryBatcher(query);
+	}
+}

src/test/java/com/marklogic/client/ext/datamovement/listener/ManageCollectionsTest.java

@@ -17,33 +17,45 @@ public class ManageCollectionsTest extends AbstractIntegrationTest {
 
 	@Test
 	public void setThenAddThenRemove() {
+		String firstUri = "dmsdk-test-1.xml";
+		String secondUri = "dmsdk-test-2.xml";
+
 		QueryBatcherTemplate qbt = new QueryBatcherTemplate(newClient("Documents"));
 
 		// Clear out the test documents
-		qbt.applyOnDocuments(new DeleteListener(), "1.xml", "2.xml");
+		qbt.applyOnDocuments(new DeleteListener(), firstUri, secondUri);
 
 		// Insert documents
 		RestBatchWriter writer = new RestBatchWriter(client, false);
 		writer.write(Arrays.asList(
-			new SimpleDocumentWriteOperation("1.xml", "<one/>", COLLECTION),
-			new SimpleDocumentWriteOperation("2.xml", "<two/>", COLLECTION)
+			new SimpleDocumentWriteOperation(firstUri, "<one/>", COLLECTION),
+			new SimpleDocumentWriteOperation(secondUri, "<two/>", COLLECTION)
 		));
 		writer.waitForCompletion();
 
 		// Set collections
 		qbt.applyOnCollections(new SetCollectionsListener(COLLECTION, "red"), COLLECTION);
-		assertUriInCollections("1.xml", COLLECTION, "red");
-		assertUriInCollections("2.xml", COLLECTION, "red");
+		assertUriInCollections(firstUri, COLLECTION, "red");
+		assertUriInCollections(secondUri, COLLECTION, "red");
 
 		// Add collections
 		qbt.applyOnCollections(new AddCollectionsListener("blue", "green"), COLLECTION);
-		assertUriInCollections("1.xml", COLLECTION, "red", "blue", "green");
-		assertUriInCollections("2.xml", COLLECTION, "red", "blue", "green");
+		assertUriInCollections(firstUri, COLLECTION, "red", "blue", "green");
+		assertUriInCollections(secondUri, COLLECTION, "red", "blue", "green");
 
 		// Remove collections
 		qbt.applyOnCollections(new RemoveCollectionsListener("red", "blue", "green"), COLLECTION);
-		assertUriInCollections("1.xml", COLLECTION);
-		assertUriInCollections("2.xml", COLLECTION);
+		assertUriInCollections(firstUri, COLLECTION);
+		assertUriInCollections(secondUri, COLLECTION);
+
+		// Set via URI pattern!
+		qbt.applyOnUriPattern(new SetCollectionsListener(COLLECTION, "red"), "dmsdk-test-*.xml");
+		assertUriInCollections(firstUri, COLLECTION, "red");
+		assertUriInCollections(secondUri, COLLECTION, "red");
+
+		qbt.applyOnUriPattern(new RemoveCollectionsListener("red"), "dmsdk-test-2*");
+		assertUriInCollections(firstUri, COLLECTION, "red");
+		assertUriNotInCollections(secondUri, "red");
 	}
 
 	private void assertUriInCollections(String uri, String... collections) {
@@ -54,4 +66,12 @@ private void assertUriInCollections(String uri, String... collections) {
 		}
 		assertEquals(collections.length, list.size());
 	}
+
+	private void assertUriNotInCollections(String uri, String... collections) {
+		ClientHelper clientHelper = new ClientHelper(client);
+		List<String> list = clientHelper.getCollections(uri);
+		for (String coll : collections) {
+			assertFalse(list.contains(coll));
+		}
+	}
 }