Bug:25862 shortcut for raw IO object or class when handle is registered

ehennum · ehennum · commit 973ea40b5a07 · 2014-03-01T02:45:29.000Z
git-svn-id: svn+ssh://svn.marklogic.com/project/engsvn/client-api/java/branches/b2_0@162606 62cac252-8da6-4816-9e9d-6dc37b19578c
diff --git a/src/main/java/com/marklogic/client/impl/QueryManagerImpl.java b/src/main/java/com/marklogic/client/impl/QueryManagerImpl.java
@@ -176,7 +176,9 @@ public <T extends SearchReadHandle> T search(QueryDefinition querydef, T searchH
 		HandleImplementation searchBase = HandleAccessor.checkHandle(searchHandle, "search");
 
         if (searchHandle instanceof SearchHandle) {
-            ((SearchHandle) searchHandle).setQueryCriteria(querydef);
+        	SearchHandle responseHandle = (SearchHandle) searchHandle;
+        	responseHandle.setHandleRegistry(getHandleRegistry());
+        	responseHandle.setQueryCriteria(querydef);
         }
 
         Format searchFormat = searchBase.getFormat();
diff --git a/src/main/java/com/marklogic/client/io/SearchHandle.java b/src/main/java/com/marklogic/client/io/SearchHandle.java
@@ -19,6 +19,7 @@
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -40,8 +41,10 @@
 import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;
 
+import com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry;
 import com.marklogic.client.MarkLogicIOException;
 import com.marklogic.client.impl.Utilities;
+import com.marklogic.client.io.marker.ContentHandle;
 import com.marklogic.client.io.marker.OperationNotSupported;
 import com.marklogic.client.io.marker.SearchReadHandle;
 import com.marklogic.client.io.marker.XMLReadHandle;
@@ -76,7 +79,8 @@ public class SearchHandle
     static private String SEARCH_NS = "http://marklogic.com/appservices/search";
     static private String QUERY_NS  = "http://marklogic.com/cts/query";
 
-    private QueryDefinition querydef;
+    private QueryDefinition       querydef;
+    private HandleFactoryRegistry registry;
 
     private MatchDocumentSummary[] summary;
     private SearchMetrics          metrics;
@@ -204,7 +208,6 @@ public void setQueryCriteria(QueryDefinition querydef) {
         qtext        = null;
         queryEvents  = null;
     }
-
     /**
      * Returns the query definition used for the search represented by this handle.
      * @return The query definition.
@@ -214,6 +217,18 @@ public QueryDefinition getQueryCriteria() {
         return querydef;
     }
 
+    /**
+     * Makes the handle registry for this database client available
+     * to this SearchHandle during processing of the search response.
+     * @param registry	the registry of IO representation classes for this database client
+     */
+    final public void setHandleRegistry(HandleFactoryRegistry registry) {
+    	this.registry = registry;
+    }
+    private HandleFactoryRegistry getHandleRegistry() {
+    	return this.registry;
+    }
+
     /**
      * Returns the total number of results in this search.
      * @return The number of results.
@@ -534,8 +549,17 @@ public String getPath() {
         }
 
         @Override
-        public Document[] getSnippets() {
-        	return getEventDocuments(events, snippetEvents);
+        public <T> T getFirstSnippetAs(Class<T> as) {
+			ContentHandle<T> handle = getHandleRegistry().makeHandle(as);
+			if (!XMLReadHandle.class.isAssignableFrom(handle.getClass())) {
+				throw new IllegalArgumentException("cannot read snippet from XML with "+handle.getClass());
+			}
+
+			if (null == getFirstSnippet((XMLReadHandle) handle)) {
+				return null;
+			}
+
+			return handle.get();
         }
         @Override
         public <T extends XMLReadHandle> T getFirstSnippet(T handle) {
@@ -557,6 +581,11 @@ public String getFirstSnippetText() {
         			getSlice(events, snippetEvents.get(0))
         			);
         }
+
+        @Override
+        public Document[] getSnippets() {
+        	return getEventDocuments(events, snippetEvents);
+        }
         @Override
         public <T extends XMLReadHandle> Iterator<T> getSnippetIterator(T handle) {
         	if (snippetEvents == null || snippetEvents.size() < 1) {
@@ -581,6 +610,18 @@ public Document getMetadata() {
         	return (handle == null) ? null : handle.get();
         }
         @Override
+        public <T> T getMetadataAs(Class<T> as) {
+			ContentHandle<T> handle = getHandleRegistry().makeHandle(as);
+
+			if (!XMLReadHandle.class.isAssignableFrom(handle.getClass())) {
+				throw new IllegalArgumentException("cannot read metadata from XML with "+handle.getClass());
+			}
+
+			getMetadata((XMLReadHandle) handle);
+
+			return handle.get();
+        }
+        @Override
         public <T extends XMLReadHandle> T getMetadata(T handle) {
             return Utilities.exportToHandle(
             		getSlice(events, metadataEvents), handle
@@ -893,6 +934,7 @@ public T next() {
 			if (!hasNext()) {
 				return null;
 			}
+
 			EventRange eventRange = rangeList.get(nextEvent++);
 			return Utilities.exportToHandle(
 					getSlice(eventList, eventRange), handle
diff --git a/src/main/java/com/marklogic/client/query/MatchDocumentSummary.java b/src/main/java/com/marklogic/client/query/MatchDocumentSummary.java
@@ -88,8 +88,22 @@ public interface MatchDocumentSummary {
 	public <T extends XMLReadHandle> Iterator<T> getSnippetIterator(T handle);
 
 	/**
-	 * Returns the content of the first snippet as a convenience, 
-	 * especially for a raw snippet that contains the entire document.
+     * Reads the content of the first snippet for the matched result document
+     * in the representation specified by the IO class.  This method provides
+     * particular convenience for a raw snippet that contains the entire
+     * result document.
+     * 
+     * The IO class must have been registered before creating the database client.
+     * By default, standard Java IO classes for document content are registered.
+     * 
+     * @param as	the IO class for reading the first snippet for the result
+     * @return	an object of the IO class with the content of the document in the first snippet
+	 */
+	public <T> T getFirstSnippetAs(Class<T> as);
+	/**
+	 * Returns the content of the first snippet for the matched result document
+	 * as a convenience, especially for a raw snippet that contains the entire
+	 * result document.
      * @param handle	An XML handle for reading the first snippet.
 	 * @return	The handle populated with the first snippet.
 	 */
@@ -109,9 +123,20 @@ public interface MatchDocumentSummary {
      * @return the metadata
      */
     public Document getMetadata();
-    
+
+    /**
+     * Reads the metadata extracted from the matched result document
+     * in the representation specified by the IO class.
+     * 
+     * The IO class must have been registered before creating the database client.
+     * By default, standard Java IO classes for document content are registered.
+     * 
+     * @param as	the IO class for reading the metadata for the result
+     * @return	an object of the IO class with the extracted result document metadata
+     */
+	public <T> T getMetadataAs(Class<T> as);
 	/**
-     * Returns the metadata for the result.
+     * Returns the metadata extracted from the result document.
      * @param handle	An XML handle for reading the metadata.
      * @return	The handle on the metadata.
 	 */
diff --git a/src/test/java/com/marklogic/client/test/HandleAsTest.java b/src/test/java/com/marklogic/client/test/HandleAsTest.java
@@ -28,8 +28,11 @@
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.io.StringReader;
+import java.util.HashSet;
 import java.util.Set;
 
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
@@ -56,17 +59,24 @@
 
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.DatabaseClientFactory;
+import com.marklogic.client.DatabaseClientFactory.Authentication;
+import com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry;
 import com.marklogic.client.FailedRequestException;
 import com.marklogic.client.ForbiddenUserException;
 import com.marklogic.client.ResourceNotFoundException;
-import com.marklogic.client.DatabaseClientFactory.Authentication;
-import com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry;
 import com.marklogic.client.document.BinaryDocumentManager;
 import com.marklogic.client.document.TextDocumentManager;
 import com.marklogic.client.document.XMLDocumentManager;
 import com.marklogic.client.io.BaseHandle;
+import com.marklogic.client.io.Format;
+import com.marklogic.client.io.JAXBHandle;
+import com.marklogic.client.io.SearchHandle;
 import com.marklogic.client.io.marker.ContentHandle;
 import com.marklogic.client.io.marker.ContentHandleFactory;
+import com.marklogic.client.query.DeleteQueryDefinition;
+import com.marklogic.client.query.MatchDocumentSummary;
+import com.marklogic.client.query.QueryDefinition;
+import com.marklogic.client.query.QueryManager;
 
 public class HandleAsTest {
 	@BeforeClass
@@ -198,19 +208,112 @@ public void testBuiltinReadWrite()
 		assertEquals("StreamReader difference in document read/write as", beforeText, afterText);
 	}
 
+	@Test
+	public void testSearch() throws JAXBException {
+		DatabaseClientFactory.Bean clientFactoryBean = makeClientFactory();
+
+		clientFactoryBean.getHandleRegistry().register(
+				JAXBHandle.newFactory(Product.class)
+				);
+
+		DatabaseClient client = clientFactoryBean.newClient();
+
+		XMLDocumentManager docMgr = client.newXMLDocumentManager();
+
+		QueryManager queryMgr = client.newQueryManager();
+
+		String basedir = "/tmp/jaxb/test/";
+
+		Product product1 = new Product();
+		product1.setName("Widgetry");
+		product1.setIndustry("IT");
+		product1.setDescription("More widgets than you can shake a stick at");
+
+		Product product2 = new Product();
+		product2.setName("AppExcess");
+		product2.setIndustry("IT");
+		product2.setDescription("There's an app for that.");
+
+		Product[] products = {product1, product2};
+
+		// setup
+		Set<String> prodNames = new HashSet<String>(products.length);
+		for (Product product: products) {
+			String prodName = product.getName();
+			prodNames.add(prodName);
+			String docId = basedir+prodName+".xml";
+			docMgr.writeAs(docId, product);			
+		}
+
+		// test
+		String rawQuery = new StringBuilder()
+			.append("<search:search xmlns:search=\"http://marklogic.com/appservices/search\">")
+			.append("<search:qtext>IT</search:qtext>")
+			.append("<search:options>")
+			.append("<search:transform-results apply=\"raw\"/> ")
+			.append("</search:options>")
+			.append("</search:search>")
+			.toString();
+
+		QueryDefinition queryDef =
+			queryMgr.newRawCombinedQueryDefinitionAs(Format.XML, rawQuery);
+		queryDef.setDirectory(basedir);
+
+		SearchHandle handle = queryMgr.search(queryDef, new SearchHandle());
+
+		MatchDocumentSummary[] summaries = handle.getMatchResults();
+		assertEquals("raw query should retrieve all products", products.length, summaries.length);
+		for (MatchDocumentSummary summary: summaries) {
+			Product product = summary.getFirstSnippetAs(Product.class);
+			assertTrue("raw product should exist", product != null);
+			assertTrue("raw product name should be preserved", prodNames.contains(product.getName()));
+		}
+
+		rawQuery = new StringBuilder()
+			.append("<search:search xmlns:search=\"http://marklogic.com/appservices/search\">")
+			.append("<search:qtext>IT</search:qtext>")
+			.append("<search:options>")
+			.append("<search:extract-metadata>")
+			.append("<search:qname elem-ns=\"\" elem-name=\"name\"/>")
+			.append("<search:qname elem-ns=\"\" elem-name=\"industry\"/>")
+			.append("</search:extract-metadata>")
+			.append("</search:options>")
+			.append("</search:search>")
+			.toString();
+
+		queryDef =
+			queryMgr.newRawCombinedQueryDefinitionAs(Format.XML, rawQuery);
+		queryDef.setDirectory(basedir);
+
+		handle = queryMgr.search(queryDef, new SearchHandle());
+
+		summaries = handle.getMatchResults();
+		assertEquals("metadata query should retrieve all products", products.length, summaries.length);
+		for (MatchDocumentSummary summary: summaries) {
+			Document productDoc = summary.getMetadataAs(Document.class);
+
+			Element name     = (Element) productDoc.getElementsByTagName("name").item(0);
+			assertTrue("metadata product name should exist", name != null);
+			assertTrue("metadata product name should be preserved", prodNames.contains(name.getTextContent()));
+
+			Element industry = (Element) productDoc.getElementsByTagName("industry").item(0);
+			assertTrue("metadata product industry should exist", industry != null);
+		}
+
+		// cleanup
+		DeleteQueryDefinition deleteDef = queryMgr.newDeleteDefinition();
+		deleteDef.setDirectory(basedir);
+
+		queryMgr.delete(deleteDef);
+
+		client.release();
+	}
+
 	@Test
 	public void testHandleRegistry() {
 		int[] iterations = {1,2};
 		for (int i: iterations) {
-			DatabaseClientFactory.Bean clientFactoryBean = null;
-			if (i == 2) {
-				clientFactoryBean = new DatabaseClientFactory.Bean();
-				clientFactoryBean.setHost(Common.HOST);
-				clientFactoryBean.setPort(Common.PORT);
-				clientFactoryBean.setUser(Common.USERNAME);
-				clientFactoryBean.setPassword(Common.PASSWORD);
-				clientFactoryBean.setAuthentication(Authentication.DIGEST);
-			}
+			DatabaseClientFactory.Bean clientFactoryBean = (i == 1) ? null : makeClientFactory();
 
 			HandleFactoryRegistry registry =
 				(i == 1) ? DatabaseClientFactory.getHandleRegistry()
@@ -268,6 +371,16 @@ public void testHandleRegistry() {
 		}
 	}
 
+	private DatabaseClientFactory.Bean makeClientFactory() {
+		DatabaseClientFactory.Bean clientFactoryBean = new DatabaseClientFactory.Bean();
+		clientFactoryBean.setHost(Common.HOST);
+		clientFactoryBean.setPort(Common.PORT);
+		clientFactoryBean.setUser(Common.USERNAME);
+		clientFactoryBean.setPassword(Common.PASSWORD);
+		clientFactoryBean.setAuthentication(Authentication.DIGEST);
+		return clientFactoryBean;
+	}
+
 	static public class BufferHandle
 	extends BaseHandle<String, String>
 	implements ContentHandle<StringBuilder> {
@@ -317,4 +430,32 @@ public <C> ContentHandle<C> newHandle(Class<C> type) {
 			return handle;
 		}
 	}
+
+	@XmlRootElement
+	static public class Product {
+		private String name;
+		private String industry;
+		private String description;
+		public Product() {
+			super();
+		}
+		public String getName() {
+			return name;
+		}
+		public void setName(String name) {
+			this.name = name;
+		}
+		public String getIndustry() {
+			return industry;
+		}
+		public void setIndustry(String industry) {
+			this.industry = industry;
+		}
+		public String getDescription() {
+			return description;
+		}
+		public void setDescription(String description) {
+			this.description = description;
+		}
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,9 @@ public <T extends SearchReadHandle> T search(QueryDefinition querydef, T searchH`
`176`	`176`	`HandleImplementation searchBase = HandleAccessor.checkHandle(searchHandle, "search");`
`177`	`177`
`178`	`178`	`if (searchHandle instanceof SearchHandle) {`
`179`		`- ((SearchHandle) searchHandle).setQueryCriteria(querydef);`
	`179`	`+ SearchHandle responseHandle = (SearchHandle) searchHandle;`
	`180`	`+ responseHandle.setHandleRegistry(getHandleRegistry());`
	`181`	`+ responseHandle.setQueryCriteria(querydef);`
`180`	`182`	`}`
`181`	`183`
`182`	`184`	`Format searchFormat = searchBase.getFormat();`