Skip to content

Commit 147a602

Browse files
adamretteradamretter
committed
[bugfix] Allow XDM Array and Map types to be serialized over the XML:DB API
Closes eXist-db/exist#4919
1 parent 9118e60 commit 147a602

5 files changed

Lines changed: 148 additions & 5 deletions

File tree

‎exist-core/pom.xml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -863,8 +863,11 @@
863863
<include>src/test/java/org/exist/w3c/tests/TestCase.java</include>
864864
<include>src/main/java/org/exist/webstart/JnlpJarFiles.java</include>
865865
<include>src/test/java/org/exist/xmldb/CreateCollectionsTest.java</include>
866+
<include>src/main/java/org/exist/xmldb/LocalXMLResource.java</include>
866867
<include>src/main/java/org/exist/xmldb/RemoteRestoreService.java</include>
868+
<include>src/test/java/org/exist/xmldb/SerializationTest.java</include>
867869
<include>src/main/java/org/exist/xmlrpc/ExistRpcTypeFactory.java</include>
870+
<include>src/main/java/org/exist/xmlrpc/RpcConnection.java</include>
868871
<include>src/main/java/org/exist/xqj/Marshaller.java</include>
869872
<include>src/main/java/org/exist/xquery/DynamicTypeCheck.java</include>
870873
<include>src/main/java/org/exist/xquery/ErrorCodes.java</include>
@@ -1142,10 +1145,13 @@
11421145
<exclude>src/test/java/org/exist/w3c/tests/TestCase.java</exclude>
11431146
<exclude>src/main/java/org/exist/webstart/JnlpJarFiles.java</exclude>
11441147
<exclude>src/test/java/org/exist/xmldb/CreateCollectionsTest.java</exclude>
1148+
<exclude>src/main/java/org/exist/xmldb/LocalXMLResource.java</exclude>
11451149
<exclude>src/main/java/org/exist/xmldb/RemoteRestoreService.java</exclude>
1150+
<exclude>src/test/java/org/exist/xmldb/SerializationTest.java</exclude>
11461151
<exclude>src/main/java/org/exist/xmlrpc/ACEAiderParser.java</exclude>
11471152
<exclude>src/main/java/org/exist/xmlrpc/ACEAiderSerializer.java</exclude>
11481153
<exclude>src/main/java/org/exist/xmlrpc/ExistRpcTypeFactory.java</exclude>
1154+
<exclude>src/main/java/org/exist/xmlrpc/RpcConnection.java</exclude>
11491155
<exclude>src/main/java/org/exist/xqj/Marshaller.java</exclude>
11501156
<exclude>src/main/java/org/exist/xquery/Cardinality.java</exclude>
11511157
<exclude>src/main/java/org/exist/xquery/DynamicTypeCheck.java</exclude>

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

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -132,7 +156,11 @@ else if (root != null && !(root instanceof NodeValue)) {
132156
} else if (value != null) {
133157
try {
134158
if (Type.subTypeOf(value.getType(),Type.STRING)) {
135-
return ((StringValue)value).getStringValue(true);
159+
return ((StringValue) value).getStringValue(true);
160+
161+
} else if (Type.subTypeOf(value.getType(), Type.MAP) || Type.subTypeOf(value.getType(), Type.ARRAY)) {
162+
return value.toString();
163+
136164
} else {
137165
return value.getStringValue();
138166
}

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

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -1819,6 +1843,10 @@ private Map<String, Object> queryResultToRpcResponse(final long startTime, final
18191843
entry.add(String.valueOf(((NodeImpl) next).getNodeNumber()));
18201844
}
18211845
result.add(entry);
1846+
1847+
} else if (Type.subTypeOf(next.getType(), Type.MAP) || Type.subTypeOf(next.getType(), Type.ARRAY)) {
1848+
result.add(next.toString());
1849+
18221850
} else {
18231851
result.add(next.getStringValue());
18241852
}
@@ -1984,7 +2012,14 @@ private Map<String, String> atomicMap(final Item item) throws XPathException {
19842012

19852013
final int type = item.getType();
19862014
result.put("type", Type.getTypeName(type));
1987-
result.put("value", item.getStringValue());
2015+
2016+
final String value;
2017+
if (Type.subTypeOf(item.getType(), Type.MAP) || Type.subTypeOf(item.getType(), Type.ARRAY)) {
2018+
value = item.toString();
2019+
} else {
2020+
value = item.getStringValue();
2021+
}
2022+
result.put("value", value);
19882023

19892024
return result;
19902025
}

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

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -485,11 +485,37 @@ public String toString() {
485485
builder.append(' ');
486486
}
487487
for (int i = 0; i < vector.length(); i++) {
488-
final Sequence value = vector.nth(i);
489-
builder.append(value.toString());
490-
if (i < vector.length() - 1) {
488+
489+
if (i > 0) {
491490
builder.append(", ");
492491
}
492+
493+
final Sequence sequence = vector.nth(i);
494+
495+
if (!sequence.hasOne()) {
496+
builder.append('(');
497+
}
498+
499+
for (int j = 0; j < sequence.getItemCount(); j++) {
500+
if (j > 0) {
501+
builder.append(", ");
502+
}
503+
504+
final Item item = sequence.itemAt(j);
505+
if (Type.subTypeOf(item.getType(), Type.STRING)) {
506+
builder.append('"');
507+
}
508+
509+
builder.append(item.toString());
510+
511+
if (Type.subTypeOf(item.getType(), Type.STRING)) {
512+
builder.append('"');
513+
}
514+
}
515+
516+
if (!sequence.hasOne()) {
517+
builder.append(')');
518+
}
493519
}
494520
if (vector.length() > 0) {
495521
builder.append(' ');

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -202,6 +226,30 @@ public void getDocTypeYes() throws XMLDBException {
202226
}
203227
}
204228

229+
@Test
230+
public void testArray() throws XMLDBException {
231+
final String query = "array { \"value 1\", \"value 2\" }";
232+
233+
final XQueryService service = (XQueryService) testCollection.getService("XQueryService", "1.0");
234+
final ResourceSet result = service.query(query);
235+
assertEquals(1, result.getSize());
236+
237+
final Resource resource = result.getResource(0);
238+
assertEquals("[ \"value 1\", \"value 2\" ]", resource.getContent());
239+
}
240+
241+
@Test
242+
public void testMap() throws XMLDBException {
243+
final String query = "map { \"prop1\" : \"value 1\", \"prop2\" : \"value 2\" }";
244+
245+
final XQueryService service = (XQueryService) testCollection.getService("XQueryService", "1.0");
246+
final ResourceSet result = service.query(query);
247+
assertEquals(1, result.getSize());
248+
249+
final Resource resource = result.getResource(0);
250+
assertEquals("map {\"prop2\": \"value 2\", \"prop1\": \"value 1\"}", resource.getContent());
251+
}
252+
205253
private static void assertXMLEquals(final String expected, final Resource actual) throws XMLDBException {
206254
final Source srcExpected = Input.fromString(expected).build();
207255
final Source srcActual = Input.fromString(actual.getContent().toString()).build();

0 commit comments

Comments
 (0)