default format for raw CTS query to XML #965

Author: ehennum

marklogic-client-api/src/main/java/com/marklogic/client/datamovement/impl/QueryBatcherImpl.java

@@ -27,6 +27,11 @@
 import com.marklogic.client.datamovement.QueryBatchException;
 import com.marklogic.client.datamovement.QueryEvent;
 import com.marklogic.client.datamovement.QueryBatcherListener;
+import com.marklogic.client.impl.HandleAccessor;
+import com.marklogic.client.impl.HandleImplementation;
+import com.marklogic.client.io.Format;
+import com.marklogic.client.io.marker.StructureWriteHandle;
+import com.marklogic.client.query.RawQueryDefinition;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -90,6 +95,26 @@ public QueryBatcherImpl(QueryDefinition query, DataMovementManager moveMgr, Fore
     this.query = query;
     withForestConfig(forestConfig);
     withBatchSize(1000);
+    if (query instanceof RawQueryDefinition) {
+      RawQueryDefinition rawQuery = (RawQueryDefinition) query;
+
+      StructureWriteHandle handle = rawQuery.getHandle();
+
+      @SuppressWarnings("rawtypes")
+      HandleImplementation baseHandle = HandleAccessor.checkHandle(handle, "queryBatcher");
+
+      Format inputFormat = baseHandle.getFormat();
+      switch(inputFormat) {
+        case UNKNOWN:
+          baseHandle.setFormat(Format.XML);
+          break;
+        case JSON:
+        case XML:
+          break;
+        default:
+          throw new UnsupportedOperationException("Only XML and JSON raw query definitions are possible.");
+      }
+    }
   }
 
   public QueryBatcherImpl(Iterator<String> iterator, DataMovementManager moveMgr, ForestConfiguration forestConfig) {

marklogic-client-api/src/main/java/com/marklogic/client/impl/OkHttpServices.java

@@ -3036,64 +3036,63 @@ public <R extends UrisReadHandle> R uris(RequestLogger reqlog, Transaction trans
     if (qdef.getOptionsName()!= null && qdef.getOptionsName().length() > 0) {
       params.add("options", qdef.getOptionsName());
     }
+
     if (qdef instanceof RawQueryByExampleDefinition) {
       throw new UnsupportedOperationException("Cannot search with RawQueryByExampleDefinition");
+    }
+
+    String text = null;
+    if (qdef instanceof StringQueryDefinition) {
+      text = ((StringQueryDefinition) qdef).getCriteria();
+    } else if (qdef instanceof StructuredQueryDefinition) {
+      text = ((StructuredQueryDefinition) qdef).getCriteria();
+    } else if (qdef instanceof RawStructuredQueryDefinition) {
+      text = ((RawStructuredQueryDefinition) qdef).getCriteria();
+    } else if (qdef instanceof RawCtsQueryDefinition) {
+      text = ((RawCtsQueryDefinition) qdef).getCriteria();
+    }
+
+    String qtextMessage = "";
+    if (text != null) {
+      params.add("q", text);
+      qtextMessage = " and string query \"" + text + "\"";
+    }
+
+    if (qdef instanceof RawCtsQueryDefinition) {
+      String structure = qdef instanceof RawQueryDefinitionImpl.CtsQuery ?
+              ((RawQueryDefinitionImpl.CtsQuery) qdef).serialize() : "";
+      logger.debug("Query uris with raw cts query {}{}", structure, qtextMessage);
+      CtsQueryWriteHandle input = ((RawCtsQueryDefinition) qdef).getHandle();
+      return postResource(reqlog, "internal/uris", transaction, params, input, output);
+    } else if (qdef instanceof StructuredQueryDefinition) {
+      String structure = ((StructuredQueryDefinition) qdef).serialize();
+      logger.debug("Query uris with structured query {}{}", structure, qtextMessage);
+      if (structure != null) {
+        params.add("structuredQuery", structure);
+      }
+    } else if (qdef instanceof RawStructuredQueryDefinition) {
+      String structure = ((RawStructuredQueryDefinition) qdef).serialize();
+      logger.debug("Query uris with raw structured query {}{}", structure, qtextMessage);
+      if (structure != null) {
+        params.add("structuredQuery", structure);
+      }
+    } else if (qdef instanceof CombinedQueryDefinition) {
+      String structure = ((CombinedQueryDefinition) qdef).serialize();
+      logger.debug("Query uris with combined query {}", structure);
+      if (structure != null) {
+        params.add("structuredQuery", structure);
+      }
+    } else if (qdef instanceof StringQueryDefinition) {
+      logger.debug("Query uris with string query \"{}\"", text);
     } else if (qdef instanceof RawQueryDefinition) {
       logger.debug("Raw uris query");
-
       StructureWriteHandle input = ((RawQueryDefinition) qdef).getHandle();
-
       return postResource(reqlog, "internal/uris", transaction, params, input, output);
     } else {
-      String text = null;
-      if (qdef instanceof StringQueryDefinition) {
-        text = ((StringQueryDefinition) qdef).getCriteria();
-      } else if (qdef instanceof StructuredQueryDefinition) {
-        text = ((StructuredQueryDefinition) qdef).getCriteria();
-      } else if (qdef instanceof RawStructuredQueryDefinition) {
-        text = ((RawStructuredQueryDefinition) qdef).getCriteria();
-      } else if (qdef instanceof RawCtsQueryDefinition) {
-        text = ((RawCtsQueryDefinition) qdef).getCriteria();
-      }
-      String qtextMessage = "";
-      if (text != null) {
-        params.add("q", text);
-        qtextMessage = " and string query \"" + text + "\"";
-      }
-      if (qdef instanceof RawCtsQueryDefinition) {
-          String structure = qdef instanceof RawQueryDefinitionImpl.CtsQuery ? ((RawQueryDefinitionImpl.CtsQuery) qdef).serialize() : "";
-          logger.debug("Query uris with raw cts query {}{}", structure, qtextMessage);
-           CtsQueryWriteHandle input = ((RawCtsQueryDefinition) qdef).getHandle();
-        return postResource(reqlog, "internal/uris", transaction, params, input, output);
-      } else if (qdef instanceof StructuredQueryDefinition) {
-          String structure = ((StructuredQueryDefinition) qdef).serialize();
-          
-          logger.debug("Query uris with structured query {}{}", structure, qtextMessage);
-          if (structure != null) {
-            params.add("structuredQuery", structure);
-          }
-        } else if (qdef instanceof RawStructuredQueryDefinition) {
-          String structure = ((RawStructuredQueryDefinition) qdef).serialize();
-          logger.debug("Query uris with raw structured query {}{}", structure, qtextMessage);
-          if (structure != null) {
-          params.add("structuredQuery", structure);
-        }
-      } else if (qdef instanceof CombinedQueryDefinition) {
-        String structure = ((CombinedQueryDefinition) qdef).serialize();
-        
-        logger.debug("Query uris with combined query {}", structure);
-        if (structure != null) {
-          params.add("structuredQuery", structure);
-        }
-      } else if (qdef instanceof StringQueryDefinition) {
-        logger.debug("Query uris with string query \"{}\"", text);
-      } else {
-        throw new UnsupportedOperationException("Cannot query uris with " +
-            qdef.getClass().getName());
-        }
-        return getResource(reqlog, "internal/uris", transaction, params, output);
-      }
+      throw new UnsupportedOperationException("Cannot query uris with " + qdef.getClass().getName());
     }
+    return getResource(reqlog, "internal/uris", transaction, params, output);
+  }
 
 
   @Override

marklogic-client-api/src/main/java/com/marklogic/client/impl/RawQueryDefinitionImpl.java

@@ -23,12 +23,12 @@
 import com.marklogic.client.query.RawQueryDefinition;
 import com.marklogic.client.query.RawStructuredQueryDefinition;
 
-abstract public class RawQueryDefinitionImpl
+abstract public class RawQueryDefinitionImpl<T extends StructureWriteHandle>
   extends AbstractQueryDefinition
   implements RawQueryDefinition
 {
   static public class Combined
-    extends RawQueryDefinitionImpl
+    extends RawQueryDefinitionImpl<StructureWriteHandle>
     implements RawCombinedQueryDefinition {
     Combined(StructureWriteHandle handle) {
       super(handle);
@@ -44,37 +44,42 @@ public RawCombinedQueryDefinition withHandle(StructureWriteHandle handle) {
     }
   }
 
-  static public class Structured
-    extends RawQueryDefinitionImpl
-    implements RawStructuredQueryDefinition {
+  static abstract class RawCriteriaQueryImpl<T extends StructureWriteHandle>
+    extends RawQueryDefinitionImpl<T>
+  {
     private String criteria = null;
 
-    public Structured(StructureWriteHandle handle) {
+    public RawCriteriaQueryImpl(T handle) {
       super(handle);
     }
-    public Structured(StructureWriteHandle handle, String optionsName) {
+    public RawCriteriaQueryImpl(T handle, String optionsName) {
       super(handle, optionsName);
     }
 
-    @Override
-    public RawStructuredQueryDefinition withHandle(StructureWriteHandle handle) {
-      setHandle(handle);
-      return this;
+    public String getCriteria() {
+      return criteria;
     }
 
-    public String serialize() {
-      if (getHandle() == null) return "";
-      return HandleAccessor.contentAsString(getHandle());
+    public void setCriteria(String criteria) {
+      this.criteria = criteria;
     }
+  }
 
-    @Override
-    public String getCriteria() {
-      return criteria;
+  static public class Structured
+    extends RawCriteriaQueryImpl<StructureWriteHandle>
+    implements RawStructuredQueryDefinition
+  {
+    public Structured(StructureWriteHandle handle) {
+      super(handle);
+    }
+    public Structured(StructureWriteHandle handle, String optionsName) {
+      super(handle, optionsName);
     }
 
     @Override
-    public void setCriteria(String criteria) {
-      this.criteria = criteria;
+    public RawStructuredQueryDefinition withHandle(StructureWriteHandle handle) {
+      setHandle(handle);
+      return this;
     }
 
     @Override
@@ -84,33 +89,15 @@ public RawStructuredQueryDefinition withCriteria(String criteria) {
     }
   }
 
-  static public class CtsQuery extends AbstractQueryDefinition implements RawCtsQueryDefinition {
-    private String criteria = null;
-    private CtsQueryWriteHandle handle;
-
+  static public class CtsQuery
+          extends RawCriteriaQueryImpl<CtsQueryWriteHandle>
+          implements RawCtsQueryDefinition
+  {
     public CtsQuery(CtsQueryWriteHandle handle) {
-      super();
-      setHandle(handle);
+      super(handle);
     }
     public CtsQuery(CtsQueryWriteHandle handle, String optionsName) {
-      super();
-      setHandle(handle);
-      setOptionsName(optionsName);
-    }
-
-    public String serialize() {
-      if (getHandle() == null) return "";
-      return HandleAccessor.contentAsString(getHandle());
-    }
-
-    @Override
-    public String getCriteria() {
-      return criteria;
-    }
-
-    @Override
-    public void setCriteria(String criteria) {
-      this.criteria = criteria;
+      super(handle, optionsName);
     }
 
     @Override
@@ -120,33 +107,27 @@ public RawCtsQueryDefinition withCriteria(String criteria) {
     }
 
     @Override
-    public CtsQueryWriteHandle getHandle() {
-      return handle;
-    }
-
-    @Override
-    public void setHandle(CtsQueryWriteHandle handle) {
-      this.handle = handle;
+    public void setHandle(StructureWriteHandle handle) {
+      if (handle != null && !(handle instanceof CtsQueryWriteHandle)) {
+        throw new IllegalArgumentException(
+                "handle must be an instance of CtsQueryWriteHandle instead of: "+
+                handle.getClass().getCanonicalName()
+        );
+      }
+      super.setHandle((CtsQueryWriteHandle) handle);
     }
 
     @Override
-    public RawCtsQueryDefinition withHandle(CtsQueryWriteHandle handle) {
+    public RawCtsQueryDefinition withHandle(StructureWriteHandle handle) {
       setHandle(handle);
       return this;
     }
-
-    @Override
-    public String toString() {
-      if (handle == null) {
-        return "";
-      }
-      return handle.toString();
-    }
   }
 
   static public class ByExample
-    extends RawQueryDefinitionImpl
-    implements RawQueryByExampleDefinition {
+    extends RawQueryDefinitionImpl<StructureWriteHandle>
+    implements RawQueryByExampleDefinition
+  {
     ByExample(StructureWriteHandle handle) {
       super(handle);
     }
@@ -161,25 +142,31 @@ public RawQueryByExampleDefinition withHandle(StructureWriteHandle handle) {
     }
   }
 
-  private StructureWriteHandle handle;
+  private T handle;
 
-  RawQueryDefinitionImpl(StructureWriteHandle handle) {
+  RawQueryDefinitionImpl(T handle) {
     super();
     setHandle(handle);
   }
-  RawQueryDefinitionImpl(StructureWriteHandle handle, String optionsName) {
+  RawQueryDefinitionImpl(T handle, String optionsName) {
     this(handle);
     setOptionsName(optionsName);
   }
 
+  public String serialize() {
+    if (handle == null) return "";
+    return HandleAccessor.contentAsString(handle);
+  }
+
   @Override
-  public StructureWriteHandle getHandle() {
+  public T getHandle() {
     return handle;
   }
 
+  // must override with instanceof test if T is not StructureWriteHandle
   @Override
   public void setHandle(StructureWriteHandle handle) {
-    this.handle = handle;
+    this.handle = (T) handle;
   }
 
   @Override
@@ -189,5 +176,4 @@ public String toString() {
     }
     return handle.toString();
   }
-
 }

marklogic-client-api/src/main/java/com/marklogic/client/io/marker/CtsQueryWriteHandle.java

@@ -18,5 +18,5 @@
 /**
  * A CtsQueryWriteHandle represents a serialized cts query.
  */
-public interface CtsQueryWriteHandle extends AbstractWriteHandle {
+public interface CtsQueryWriteHandle extends StructureWriteHandle {
 }

marklogic-client-api/src/main/java/com/marklogic/client/query/RawCtsQueryDefinition.java

@@ -16,12 +16,13 @@
 package com.marklogic.client.query;
 
 import com.marklogic.client.io.marker.CtsQueryWriteHandle;
+import com.marklogic.client.io.marker.StructureWriteHandle;
 
 /**
  * A RawCtsQueryDefinition allows you to create a query with a serialized cts
  * query in a JSON or XML representation.
  */
-public interface RawCtsQueryDefinition extends QueryDefinition, ValueQueryDefinition {
+public interface RawCtsQueryDefinition extends RawQueryDefinition, ValueQueryDefinition {
   /**
    * Returns the query criteria, that is the query string.
    * @return The query string.
@@ -48,17 +49,11 @@ public interface RawCtsQueryDefinition extends QueryDefinition, ValueQueryDefini
    */
   CtsQueryWriteHandle getHandle();
 
-  /**
-   * Specifies the handle for the JSON or XML representation of the query.
-   * @param handle	the JSON or XML handle.
-   */
-  void setHandle(CtsQueryWriteHandle handle);
-
   /**
    * Specifies the handle for the JSON or XML representation
    * of a combined query and returns the query definition.
    * @param handle	the JSON or XML handle.
    * @return	the query definition.
    */
-  RawCtsQueryDefinition withHandle(CtsQueryWriteHandle handle);
+  RawCtsQueryDefinition withHandle(StructureWriteHandle handle);
 }