Validating structured XML attributes containing JSON with Schematron
Rick Jelliffe <[email protected]> Fri, 5 Apr 2024 11:32:49 +1100
| Newsgroups | gmane.text.xml.devel |
|---|---|
| Message-ID | <CADUdYQWnfwS=pMLyEsLjUh6BQT3rXyQMHFWQksFU3jdzHSpruA@mail.gmail.com> |
--000000000000135b6306154e9962
Content-Type: text/plain; charset="UTF-8"
Probably this is obvious, but you can use Schematron to validate so-called
"structured attributes", which is where an XML attribute value contains
arbitrary structured data to any nesting depth.
(Structured attributes take the pressure off having to use element syntax
for complex metadata, so that e.g. the elements' data content only contains
"text" while the attributes only contains "metadata". )
Lets use JSON as the notation for the structured attributes. Here is a
sample document:
````
<doc>
<metadata structured-attribute= '
{
"a": "dog",
"b": 5
}
'/>
<a>dog</a>
<b>4</b>
</doc>
````
The XPath3.1 function json-to-xml() will read this @structured-attribute
into an XDM XML document:
````
<map xmlns="http://www.w3.org/2005/xpath-functions">
<string key='a'>dog</string>
<number key='b'>4</string>
</map>
````
And here is a Schematron schema with some simple validation involving both
the element values and the structured-attribute values.
````
<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron"
queryBinding="xslt3" >
<sch:ns prefix="json" uri="http://www.w3.org/2005/xpath-functions" />
<sch:pattern id="example">
<sch:let name="metadata"
value="json:json-to-xml(/doc/metadata/@structured-attribute)" />
<sch:rule context="a">
<sch:assert test=". eq
$metadata/json:map/*[@key='a']/text()">The value of element a should match
the value in the corresponding structured attribute.
Expecting(<sch:value-of select="."/>) found (<sch:value-of
select="$metadata/json:map/*[@key='a']/text()"/>).
</sch:assert>
</sch:rule>
<sch:rule context="b">
<sch:assert test="number(.)">Element b should be a
number.</sch:assert>
<sch:assert test="number(.) =
number($metadata/json:map/*[@key='b']/text())">The value of element b
should match the value in the corresponding structured attribute.
Expecting(<sch:value-of select="."/>) found (<sch:value-of
select="$metadata/json:map/*[@key='b']/text()"/>).
</sch:assert>
</sch:rule>
</sch:pattern>
</sch:schema>
````
And the result will be
````
The value of element b should match the value in the corresponding
structured attribute. Expecting(4) found (5).
````
Regards
Rick
--000000000000135b6306154e9962
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
<div dir=3D"ltr"><div>Probably this is obvious, but you can use Schematron =
to validate so-called "structured attributes", which is where an =
XML attribute value contains arbitrary structured data to any nesting depth=
. <br></div><div><br></div><div>(Structured attributes take the pressure of=
f having to use element syntax for complex metadata, so that e.g. the eleme=
nts' data content only contains "text" while the attributes o=
nly contains "metadata". )</div><div><br></div><div>Lets use JSON=
as the notation for the structured attributes. Here is a sample document:<=
/div><div><br></div><div>````</div><div><doc><br>=C2=A0 =C2=A0 <me=
tadata structured-attribute=3D '<br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 {<br>=
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 "a": "dog",<b=
r>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 "b": 5<br>=C2=A0 =C2=
=A0 =C2=A0 =C2=A0 }<br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 '/><br>=C2=A0 =C2=
=A0 <a>dog</a><br>=C2=A0 =C2=A0 <b>4</b> <br></d=
oc></div><div>````</div><div>The XPath3.1 function json-to-xml() will re=
ad this=C2=A0<a class=3D"gmail_plusreply" id=3D"plusReplyChip-0">@structure=
d-attribute</a> into an XDM XML document:</div><div>````<br>=C2=A0 =C2=A0 =
=C2=A0 =C2=A0 =C2=A0 <map xmlns=3D"<a href=3D"http://www.w3.org/200=
5/xpath-functions">http://www.w3.org/2005/xpath-functions</a>"><br>=
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 <string key=3D'a'>d=
og</string><br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 <number k=
ey=3D'b'>4</string><br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0&=
lt;/map> <br></div><div>````<br></div><div><br></div><div>And here is a =
Schematron schema with some simple validation involving both the element va=
lues and the structured-attribute values. <br></div><div>````</div><div><=
;sch:schema xmlns:sch=3D"<a href=3D"http://purl.oclc.org/dsdl/schematr=
on">http://purl.oclc.org/dsdl/schematron</a>" queryBinding=3D"xsl=
t3" ><br>=C2=A0 =C2=A0 <sch:ns prefix=3D"json" =C2=A0u=
ri=3D"<a href=3D"http://www.w3.org/2005/xpath-functions">http://www.w3=
.org/2005/xpath-functions</a>" /> <br>=C2=A0 =C2=A0 <br>=C2=A0 =C2=
=A0 <sch:pattern id=3D"example"> <br>=C2=A0 =C2=A0 =C2=A0 =
=C2=A0 <sch:let name=3D"metadata" value=3D"json:json-to-x=
ml(/doc/metadata/@structured-attribute)" =C2=A0/><br>=C2=A0 =C2=A0 =
=C2=A0 =C2=A0 <br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 <sch:rule context=3D"=
a"> =C2=A0 =C2=A0<br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 <=
sch:assert test=3D". eq =C2=A0$metadata/json:map/*[@key=3D'a']=
/text()">The value of element a should match the value in the corre=
sponding structured attribute.<br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0=
=C2=A0 =C2=A0 Expecting(<sch:value-of select=3D"."/>) foun=
d (<sch:value-of select=3D"$metadata/json:map/*[@key=3D'a']=
/text()"/>). <br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 </sch=
:assert><br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 </sch:rule> <br>=C2=A0 =C2=
=A0 =C2=A0 =C2=A0 <br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 <sch:rule context=3D&q=
uot;b"> =C2=A0<br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 <sch=
:assert test=3D"number(.)">Element b should be a number.</s=
ch:assert> <br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 <sch:assert =
test=3D"number(.) =3D =C2=A0number($metadata/json:map/*[@key=3D'b&=
#39;]/text())">The value of element b should match the value in the=
corresponding structured attribute. <br></div><div>=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Expecting(<sch:value=
-of select=3D"."/>) found (<sch:value-of select=3D"$me=
tadata/json:map/*[@key=3D'b']/text()"/>). =C2=A0 =C2=A0 =C2=
=A0 =C2=A0 <br></div><div>=C2=A0 =C2=A0=C2=A0 =C2=A0 =C2=A0 =C2=A0 </sch=
:assert><br>=C2=A0 =C2=A0 =C2=A0 =C2=A0 </sch:rule><br>=C2=A0 =C2=
=A0 =C2=A0 =C2=A0 <br>=C2=A0 =C2=A0 </sch:pattern><br></sch:schema=
></div><div>````</div><div><br></div><div>And the result will be</div><d=
iv>````</div><div>The value of element b should match the value in the corr=
esponding structured attribute. Expecting(4) found (5).</div><div>````<br><=
/div><br><div>Regards</div><div>Rick<br></div><br></div>
--000000000000135b6306154e9962--