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

git-svn-id: svn+ssh://svn.marklogic.com/project/engsvn/client-api/java/branches/b2_0@162185 62cac252-8da6-4816-9e9d-6dc37b19578c

Author: ehennum

src/main/java/com/marklogic/client/example/cookbook/RawCombinedSearch.java

@@ -26,7 +26,6 @@
 import com.marklogic.client.io.Format;
 import com.marklogic.client.io.InputStreamHandle;
 import com.marklogic.client.io.SearchHandle;
-import com.marklogic.client.io.StringHandle;
 import com.marklogic.client.query.MatchDocumentSummary;
 import com.marklogic.client.query.MatchLocation;
 import com.marklogic.client.query.MatchSnippet;
@@ -54,50 +53,6 @@ public static void run(ExampleProperties props) throws IOException {
 
 		setUpExample(client);
 
-		// use either shortcut or strong typed IO
-		runShortcut(client);
-		runStrongTyped(client);
-
-		tearDownExample(client);
-
-		// release the client
-		client.release();
-	}
-	public static void runShortcut(DatabaseClient client) throws IOException {
-		// create a manager for searching
-		QueryManager queryMgr = client.newQueryManager();
-
-		// specify the query and options for the search criteria
-		// in raw XML (raw JSON is also supported)
-		String rawSearch = new StringBuilder()
-    	    .append("<search:search ")
-    	    .append(    "xmlns:search='http://marklogic.com/appservices/search'>")
-    	    .append("<search:query>")
-  	        .append(    "<search:term-query>")
-   	        .append(        "<search:text>neighborhoods</search:text>")
-   	        .append(    "</search:term-query>")
-   	        .append(    "<search:value-constraint-query>")
-   	        .append(        "<search:constraint-name>industry</search:constraint-name>")
-   	        .append(        "<search:text>Real Estate</search:text>")
-   	        .append(    "</search:value-constraint-query>")
-	        .append("</search:query>")
-    	    .append("<search:options>")
-            .append(    "<search:constraint name='industry'>")
-    	    .append(        "<search:value>")
-    		.append(            "<search:element name='industry' ns=''/>")
-    	    .append(        "</search:value>")
-            .append(    "</search:constraint>")
-            .append("</search:options>")
-            .append("</search:search>")
-            .toString();
-
-		// run the search
-		String results = queryMgr.searchAs(Format.XML, rawSearch, String.class);
-
-		System.out.println("(Shortcut) Matched:\n"+results+"\n");
-	}
-	public static void runStrongTyped(DatabaseClient client)
-	throws IOException {
 		// create a manager for searching
 		QueryManager queryMgr = client.newQueryManager();
 
@@ -125,12 +80,9 @@ public static void runStrongTyped(DatabaseClient client)
             .append("</search:search>")
             .toString();
 
-		// create a handle for the search criteria
-		StringHandle rawHandle = new StringHandle(rawSearch);
-
-        // create a search definition based on the handle
+        // create a search definition for the search criteria
         RawCombinedQueryDefinition querydef
-                = queryMgr.newRawCombinedQueryDefinition(rawHandle);
+                = queryMgr.newRawCombinedQueryDefinitionAs(Format.XML, rawSearch);
 
         // create a handle for the search results
 		SearchHandle resultsHandle = new SearchHandle();

src/main/java/com/marklogic/client/impl/QueryManagerImpl.java

@@ -47,7 +47,6 @@
 import com.marklogic.client.query.QueryManager;
 import com.marklogic.client.query.RawCombinedQueryDefinition;
 import com.marklogic.client.query.RawQueryByExampleDefinition;
-import com.marklogic.client.query.RawQueryDefinition;
 import com.marklogic.client.query.RawStructuredQueryDefinition;
 import com.marklogic.client.query.StringQueryDefinition;
 import com.marklogic.client.query.StructuredQueryBuilder;
@@ -158,64 +157,6 @@ public ValuesListDefinition newValuesListDefinition(String optionsName) {
         return new ValuesListDefinitionImpl(optionsName);
     }
 
-	// shortcut search
-    @Override
-    public <T> T searchAs(Format format, Object query, Class<T> as) {
-    	return searchAs(format, query, as, 1);
-    }
-    @Override
-    public <T> T searchAs(Format format, Object query, Class<T> as, long start) {
-		if (as == null) {
-			throw new IllegalArgumentException("no type to search as");
-		}
-
-		QueryDefinition querydef = null;
-		if (query == null) {
-			querydef = new StringQueryDefinitionImpl(null).withCriteria("");
-		} else if (RawQueryDefinition.class.isAssignableFrom(query.getClass())) {
-			RawQueryDefinition rawQuery = (RawQueryDefinition) query;
-			Utilities.setHandleStructuredFormat(rawQuery.getHandle(), format);
-    		querydef = rawQuery;
-		} else if (QueryDefinition.class.isAssignableFrom(query.getClass())) {
-    		querydef = (QueryDefinition) query;
-    	} else if (StructureWriteHandle.class.isAssignableFrom(query.getClass())) {
-    		StructureWriteHandle queryHandle = (StructureWriteHandle) query;
-			Utilities.setHandleStructuredFormat(queryHandle, format);
-    		querydef = new RawQueryDefinitionImpl.Combined(queryHandle);
-    	} else {
-    		Class<?> queryAs = query.getClass();
-			ContentHandle<?> queryHandle = getHandleRegistry().makeHandle(queryAs);
-			if (!StructureWriteHandle.class.isAssignableFrom(queryHandle.getClass())) {
-				throw new IllegalArgumentException(
-						"Handle "+queryHandle.getClass().getName()+
-						" cannot be used to search with "+queryAs.getName()
-						);
-			}
-			Utilities.setHandleContent(queryHandle, query);
-			Utilities.setHandleStructuredFormat(queryHandle, format);
-			querydef = new RawQueryDefinitionImpl.Combined((StructureWriteHandle) queryHandle);
-    	}
-
-    	if (as.isAssignableFrom(SearchHandle.class)) {
-    		SearchHandle searchHandle = new SearchHandle();
-    		search(querydef, searchHandle, start);
-    		return as.cast(searchHandle);
-    	} else {
-        	ContentHandle<T> resultHandle = getHandleRegistry().makeHandle(as);
-    		if (!SearchReadHandle.class.isAssignableFrom(resultHandle.getClass())) {
-    			throw new IllegalArgumentException(
-    					"Handle "+resultHandle.getClass().getName()+
-    					" cannot be used to search for "+as.getName()
-    					);
-    		}
-			Utilities.setHandleStructuredFormat(resultHandle, format);
-
-    		search(querydef, (SearchReadHandle) resultHandle, start);
-    		return resultHandle.get();
-    	}
-    }
-
-	// strongly typed search
     @Override
     public <T extends SearchReadHandle> T search(QueryDefinition querydef, T searchHandle) {
         return search(querydef, searchHandle, 1, null);
@@ -543,12 +484,12 @@ public SuggestDefinition newSuggestDefinition(String suggestString,
 	}
 
 	@Override
-	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Object rawQuery) {
-		return newRawCombinedQueryDefinitionAs(rawQuery, null);
+	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Format format, Object rawQuery) {
+		return newRawCombinedQueryDefinitionAs(format, rawQuery, null);
 	}
 	@Override
-	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Object rawQuery, String optionsName) {
-		return newRawCombinedQueryDefinition(structuredWrite(rawQuery), optionsName);
+	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Format format, Object rawQuery, String optionsName) {
+		return newRawCombinedQueryDefinition(structuredWrite(format, rawQuery), optionsName);
 	}
 	@Override
 	public RawCombinedQueryDefinition newRawCombinedQueryDefinition(StructureWriteHandle handle) {
@@ -560,12 +501,12 @@ public RawCombinedQueryDefinition newRawCombinedQueryDefinition(StructureWriteHa
 	}
 
 	@Override
-	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Object query) {
-		return newRawStructuredQueryDefinitionAs(query, null);
+	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Format format, Object query) {
+		return newRawStructuredQueryDefinitionAs(format, query, null);
 	}
 	@Override
-	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Object query, String optionsName) {
-		return newRawStructuredQueryDefinition(structuredWrite(query), optionsName);
+	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Format format, Object query, String optionsName) {
+		return newRawStructuredQueryDefinition(structuredWrite(format, query), optionsName);
 	}
 	@Override
 	public RawStructuredQueryDefinition newRawStructuredQueryDefinition(StructureWriteHandle handle) {
@@ -577,12 +518,12 @@ public RawStructuredQueryDefinition newRawStructuredQueryDefinition(StructureWri
 	}
 
 	@Override
-	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Object query) {
-		return newRawQueryByExampleDefinitionAs(query, null);
+	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Format format, Object query) {
+		return newRawQueryByExampleDefinitionAs(format, query, null);
 	}
 	@Override
-	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Object query, String optionsName) {
-		return newRawQueryByExampleDefinition(structuredWrite(query), optionsName);
+	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Format format, Object query, String optionsName) {
+		return newRawQueryByExampleDefinition(structuredWrite(format, query), optionsName);
 	}
 	@Override
 	public RawQueryByExampleDefinition newRawQueryByExampleDefinition(StructureWriteHandle handle) {
@@ -593,16 +534,19 @@ public RawQueryByExampleDefinition newRawQueryByExampleDefinition(StructureWrite
 		return new RawQueryDefinitionImpl.ByExample(handle, optionsName);
 	}
 
-	private StructureWriteHandle structuredWrite(Object content) {
-		Class<?> as = content.getClass();
-    	ContentHandle<?> handle = getHandleRegistry().makeHandle(as);
-		if (!StructureWriteHandle.class.isAssignableFrom(handle.getClass())) {
+	private StructureWriteHandle structuredWrite(Format format, Object query) {
+		Class<?> as = query.getClass();
+    	ContentHandle<?> queryHandle = getHandleRegistry().makeHandle(as);
+		if (!StructureWriteHandle.class.isAssignableFrom(queryHandle.getClass())) {
 			throw new IllegalArgumentException(
-					"Handle "+handle.getClass().getName()+
+					"Handle "+queryHandle.getClass().getName()+
 					" does not provide structure write handle for "+as.getName()
 					);
 		}
 
-		return (StructureWriteHandle) handle;
+		Utilities.setHandleContent(queryHandle, query);
+		Utilities.setHandleStructuredFormat(queryHandle, format);
+
+		return (StructureWriteHandle) queryHandle;
 	}
 }

src/main/java/com/marklogic/client/query/QueryManager.java

@@ -231,36 +231,6 @@ public enum QueryView {
      */
     public KeyLocator newKeyLocator(String key);
 
-	/**
-     * Searches documents based on query criteria and, potentially, previously
-     * saved query options with a query or a search response or both in the JSON or
-     * XML representation provided as an object of an 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 format	whether the format of the representation is JSON or XML
-	 * @param query	an IO representation of the JSON or XML query or a query definition (including one built by StructuredQueryBuilder)
-     * @param as	the IO class for reading the search response or SearchHandle.class
-	 * @return	an object of the IO class with the content of the search response or a new SearchHandle
-	 */
-	public <T> T searchAs(Format format, Object query, Class<T> as);
-	/**
-     * Searches documents based on query criteria and, potentially, previously
-     * saved query options with a query or a search response or both in the JSON or
-     * XML representation provided as an object of an 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 format	whether the format of the representation is JSON or XML
-	 * @param query	an IO representation of the JSON or XML query or a query definition (including one built by StructuredQueryBuilder)
-     * @param as	the IO class for reading the search response or SearchHandle.class
-	 * @param start	the offset of the first document in the page (where 1 is the first result)
-	 * @return	an object of the IO class with the content of the search response or a new SearchHandle
-	 */
-    public <T> T searchAs(Format format, Object query, Class<T> as, long start);
-
     /**
      * Searches documents based on query criteria and, potentially, previously
      * saved query options.
@@ -506,21 +476,23 @@ public enum QueryView {
      * The IO class must have been registered before creating the database client.
      * By default, standard Java IO classes for document content are registered.
      * 
+     * @param format	whether the format of the representation is JSON or XML
 	 * @param rawQuery	an IO representation of the JSON or XML combined query
      * @return a QueryDefinition for use of the combined query
 	 */
-	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Object rawQuery);
+	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Format format, Object rawQuery);
 	/**
      * Defines a combined query from a JSON or XML representation provided as an object of an 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 format	whether the format of the representation is JSON or XML
 	 * @param rawQuery	an IO representation of the JSON or XML combined query
      * @param optionsName the name of a persisted query options configuration
      * @return a QueryDefinition for use of the combined query
 	 */
-	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Object rawQuery, String optionsName);
+	public RawCombinedQueryDefinition newRawCombinedQueryDefinitionAs(Format format, Object rawQuery, String optionsName);
 
     /**
      * Defines a combined query from a JSON or XML representation.
@@ -542,21 +514,23 @@ public enum QueryView {
      * The IO class must have been registered before creating the database client.
      * By default, standard Java IO classes for document content are registered.
      * 
+     * @param format	whether the format of the representation is JSON or XML
 	 * @param rawQuery	an IO representation of the JSON or XML structured query
      * @return a QueryDefinition for use of the structured query.
 	 */
-	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Object rawQuery);
+	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Format format, Object rawQuery);
 	/**
      * Defines a structured query from a JSON or XML representation provided as an object of an 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 format	whether the format of the representation is JSON or XML
 	 * @param rawQuery	an IO representation of the JSON or XML structured query
      * @param optionsName the name of a persisted query options configuration
      * @return a QueryDefinition for use of the structured query.
 	 */
-	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Object rawQuery, String optionsName);
+	public RawStructuredQueryDefinition newRawStructuredQueryDefinitionAs(Format format, Object rawQuery, String optionsName);
 
 	/**
      * Defines a structured query from a JSON or XML representation.
@@ -578,21 +552,23 @@ public enum QueryView {
      * The IO class must have been registered before creating the database client.
      * By default, standard Java IO classes for document content are registered.
      * 
+     * @param format	whether the format of the representation is JSON or XML
 	 * @param rawQuery	an IO representation of the query by example
      * @return a QueryDefinition for use of the query by example
 	 */
-	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Object rawQuery);
+	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Format format, Object rawQuery);
 	/**
      * Defines a simple query by example from a JSON or XML representation provided as an object of an 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 format	whether the format of the representation is JSON or XML
 	 * @param rawQuery	an IO representation of the query by example
      * @param optionsName the name of a persisted query options configuration
      * @return a QueryDefinition for use of the query by example
 	 */
-	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Object rawQuery, String optionsName);
+	public RawQueryByExampleDefinition newRawQueryByExampleDefinitionAs(Format format, Object rawQuery, String optionsName);
 
     /**
      * Defines a simple query by example from a JSON or XML representation.