Testing serialize(XMLStreamWriter)

Author: rjrudin

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

@@ -1231,6 +1231,11 @@ public AbstractStructuredQuery withCriteria(String criteria) {
       return this;
     }
 
+	@Override
+	public void serialize(XMLStreamWriter serializer) throws XMLStreamException {
+		innerSerialize(serializer);
+	}
+
     @Override
     public String serialize() {
       return serializeQueries(this);

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

@@ -17,6 +17,9 @@
 
 import com.marklogic.client.pojo.PojoQueryDefinition;
 
+import javax.xml.stream.XMLStreamException;
+import javax.xml.stream.XMLStreamWriter;
+
 /**
  * A StructuredQueryDefinition represents a structured query.
  *
@@ -32,6 +35,8 @@ public interface StructuredQueryDefinition
    */
   String serialize();
 
+	void serialize(XMLStreamWriter serializer) throws XMLStreamException;
+
   /**
    * Returns the query criteria, that is the query string.
    * @return The query string.

marklogic-client-api/src/test/java/com/marklogic/client/SerializeQueryTest.java

@@ -0,0 +1,52 @@
+package com.marklogic.client;
+
+import com.marklogic.client.query.StructuredQueryBuilder;
+import com.marklogic.client.query.StructuredQueryDefinition;
+import com.marklogic.rest.util.Fragment;
+
+import javax.xml.stream.XMLOutputFactory;
+import javax.xml.stream.XMLStreamWriter;
+import java.io.StringWriter;
+
+public class SerializeQueryTest {
+
+	public static void main(String[] args) throws Exception {
+		DatabaseClient client = new DatabaseClientBuilder()
+									.withHost("localhost")
+									.withPort(8000)
+									.withDigestAuth("admin", "admin").build();
+
+		StructuredQueryBuilder qb = client.newQueryManager().newStructuredQueryBuilder();
+		StructuredQueryDefinition query = qb.and(qb.collection("hello"), qb.term("world"));
+
+		final String SEARCH_NS = "http://marklogic.com/appservices/search";
+
+		XMLOutputFactory factory = XMLOutputFactory.newFactory();
+		// Required in order for default namespace to be applied.
+		factory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
+
+		StringWriter writer = new StringWriter();
+		XMLStreamWriter serializer = factory.createXMLStreamWriter(writer);
+
+		// Must set this in order for the serialized query to be in the correct namespace.
+		serializer.setDefaultNamespace(SEARCH_NS);
+
+		serializer.writeStartElement("someOtherNamespace", "myDocument");
+		serializer.writeStartElement("someLocalElement");
+		serializer.writeEndElement();
+
+		// In order for query.serialize to work, it appears necessary to wrap the query in an element in the search
+		// namespace. And because that's the default namespace on the XMLStreamWriter, it will be applied to each of
+		// the child elements produced by query.serialize. 
+		serializer.writeStartElement(SEARCH_NS, "theMarkLogicQuery");
+		query.serialize(serializer);
+		serializer.writeEndElement();
+
+		serializer.writeEndElement();
+		serializer.flush();
+		serializer.close();
+
+		String output = writer.toString();
+		new Fragment(output).prettyPrint();
+	}
+}