Merge pull request #37 from evolvedbinary/6.x.x/hotfix/xmldb-serialize-array-map

[6.x.x] Allow XDM Array and Map types to be serialized over the XML:DB API

Author: adamretter

exist-core/pom.xml

@@ -904,6 +904,7 @@
                                 <include>src/main/java/org/exist/xmldb/LocalXMLResource.java</include>
                                 <include>src/main/java/org/exist/xmldb/RemoteRestoreService.java</include>
                                 <include>src/test/java/org/exist/xmldb/ResourceTest.java</include>
+                                <include>src/test/java/org/exist/xmldb/SerializationTest.java</include>
                                 <include>src/test/java/org/exist/xmldb/TestEXistXMLSerialize.java</include>
                                 <include>src/test/java/org/exist/xmldb/TreeLevelOrderTest.java</include>
                                 <include>src/test/java/org/exist/xmldb/concurrent/XMLGenerator.java</include>
@@ -1240,6 +1241,7 @@
                                 <exclude>src/main/java/org/exist/xmldb/LocalXMLResource.java</exclude>
                                 <exclude>src/main/java/org/exist/xmldb/RemoteRestoreService.java</exclude>
                                 <exclude>src/test/java/org/exist/xmldb/ResourceTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xmldb/SerializationTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xmldb/TestEXistXMLSerialize.java</exclude>
                                 <exclude>src/test/java/org/exist/xmldb/TreeLevelOrderTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xmldb/concurrent/XMLGenerator.java</exclude>

exist-core/src/main/java/org/exist/xmldb/LocalXMLResource.java

@@ -155,7 +155,11 @@ else if (root != null && !(root instanceof NodeValue)) {
         } else if (value != null) {
             try {
                 if (Type.subTypeOf(value.getType(),Type.STRING)) {
-                    return ((StringValue)value).getStringValue(true);
+                    return ((StringValue) value).getStringValue(true);
+
+                } else if (Type.subTypeOf(value.getType(), Type.MAP) || Type.subTypeOf(value.getType(), Type.ARRAY)) {
+                    return value.toString();
+
                 } else {
                     return value.getStringValue();
                 }

exist-core/src/main/java/org/exist/xmlrpc/RpcConnection.java

@@ -1846,6 +1846,10 @@ private Map<String, Object> queryResultToRpcResponse(final long startTime, final
                             entry.add(String.valueOf(((NodeImpl) next).getNodeNumber()));
                         }
                         result.add(entry);
+
+                    } else if (Type.subTypeOf(next.getType(), Type.MAP) || Type.subTypeOf(next.getType(), Type.ARRAY)) {
+                        result.add(next.toString());
+
                     } else {
                         result.add(next.getStringValue());
                     }
@@ -2011,7 +2015,14 @@ private Map<String, String> atomicMap(final Item item) throws XPathException {
 
         final int type = item.getType();
         result.put("type", Type.getTypeName(type));
-        result.put("value", item.getStringValue());
+
+        final String value;
+        if (Type.subTypeOf(item.getType(), Type.MAP) || Type.subTypeOf(item.getType(), Type.ARRAY)) {
+            value = item.toString();
+        } else {
+            value = item.getStringValue();
+        }
+        result.put("value", value);
 
         return result;
     }

exist-core/src/main/java/org/exist/xquery/functions/array/ArrayType.java

@@ -485,11 +485,37 @@ public String toString() {
             builder.append(' ');
         }
         for (int i = 0; i < vector.length(); i++) {
-            final Sequence value = vector.nth(i);
-            builder.append(value.toString());
-            if (i < vector.length() - 1) {
+
+            if (i > 0) {
                 builder.append(", ");
             }
+
+            final Sequence sequence = vector.nth(i);
+
+            if (!sequence.hasOne()) {
+                builder.append('(');
+            }
+
+            for (int j = 0; j < sequence.getItemCount(); j++) {
+                if (j > 0) {
+                    builder.append(", ");
+                }
+
+                final Item item = sequence.itemAt(j);
+                if (Type.subTypeOf(item.getType(), Type.STRING)) {
+                    builder.append('"');
+                }
+
+                builder.append(item.toString());
+
+                if (Type.subTypeOf(item.getType(), Type.STRING)) {
+                    builder.append('"');
+                }
+            }
+
+            if (!sequence.hasOne()) {
+                builder.append(')');
+            }
         }
         if (vector.length() > 0) {
             builder.append(' ');

exist-core/src/test/java/org/exist/xmldb/SerializationTest.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -202,6 +226,30 @@ public void getDocTypeYes() throws XMLDBException {
 		}
 	}
 
+	@Test
+	public void testArray() throws XMLDBException {
+		final String query = "array { \"value 1\", \"value 2\" }";
+
+		final XQueryService service = (XQueryService) testCollection.getService("XQueryService", "1.0");
+		final ResourceSet result = service.query(query);
+		assertEquals(1, result.getSize());
+
+		final Resource resource = result.getResource(0);
+		assertEquals("[ \"value 1\", \"value 2\" ]", resource.getContent());
+	}
+
+	@Test
+	public void testMap() throws XMLDBException {
+		final String query = "map { \"prop1\" : \"value 1\", \"prop2\" : \"value 2\" }";
+
+		final XQueryService service = (XQueryService) testCollection.getService("XQueryService", "1.0");
+		final ResourceSet result = service.query(query);
+		assertEquals(1, result.getSize());
+
+		final Resource resource = result.getResource(0);
+		assertEquals("map {\"prop2\": \"value 2\", \"prop1\": \"value 1\"}", resource.getContent());
+	}
+
 	private static void assertXMLEquals(final String expected, final Resource actual) throws XMLDBException {
 		final Source srcExpected = Input.fromString(expected).build();
 		final Source srcActual = Input.fromString(actual.getContent().toString()).build();