Changes

This [[Module Library|XQuery Module]] contains functions to perform validations against DTDs, XML Schema and (since {{Version|8.3}}) RelaxNG. For The documentation further describes how to use Schematron validation, check out Vincent Lizzi’s [https://github.com/vincentml/schematron-basex Schematron XQuery Module]with BaseX.

All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/validate</nowiki></code> namespace, which is statically bound to the {{Code|validate}} prefix.<br/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.

* an {{Code|xs:string}}, containing representing a URI (relative URIs will always be resolved against the path to static base URI of the resourcequery),* an {{Code|xs:string}}, containing representing the resource in its string representation, or* a {{Code|node()}}, containing representing the resource itself.

|{{Error|BXVA0001error|#Errors}} the validation fails.<br/>{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no DTD validator is available.

<pre classsyntaxhighlight lang="brush:xquery">

} catch bxerrvalidate:BXVA0001 error {

</presyntaxhighlight>

|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no DTD validator is available.

|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no DTD validator is available.

<pre classsyntaxhighlight lang="brush:xml">

</presyntaxhighlight>

If no schema is given, the input is expected to contain an {{Code|xsi:(noNamespace)schemaLocation}} attribute, as defined in [httphttps://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema].

Different XML Schema implementations can be applied for validationprocessors are supported:

* By default, the '''Java includes a default implementation ''' of XML Schema 1.0 is used (which it is based on an older old version of Apache Xerces).* If [https://xercesThe latest version of '''Xerces2''' provides implementations of XML Schema 1.0 and 1.apache1.org/xerces2-j Xerces2] exists in the classpath, it The processor will be used instead. If you want to manually add Xerces2, applied if you should download one of the [httphttps://xerces.apache.org/mirrors.cgi#binary Xerces2 Java ..... (XML Schema 1.1) (Beta)binary distributions] archive and copy at least four the following libraries (to the {{Code|cupv10k-runtime.jarlib/custom}}, directory of the full distribution of BaseX:** {{Code|org.eclipse.wst.xml.xpath2.processor_1.12.0.jar}}, ** {{Code|xercesImplcupv10k-runtime.jar}}, ** {{Code|xml-apisxercesImpl.jar}}) to the ** {{Code|libxml-apis.jar}} directory of the full distribution of BaseX.* The '''Saxon Enterprise Edition''' will be used if you download the [httphttps://www.saxonica.com/ Saxondownload/java.xml ZIP release] Enterprise Edition (saxon9ee.jar) is detected as well. The XML Schema version can be specified as well. The supplied string must be and if you copy {{Code|1saxon9ee.0jar}} or {{Code|1.1}}. Please note that version 1.1 is only available if Saxon EE or Xerces2 is added and a valid license key to the classpath.

|{{Func|validate:xsd|$input as item()|empty-sequence()}}<br />{{Func|validate:xsd|$input as item(), $schema as item()?|empty-sequence()}}<br />{{Func|validate:xsd|$input as item(), $schema as item()?, $version features as xs:stringmap(*)|empty-sequence()}}

|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the processor-specific {{Code|$features}}.

|{{Error|BXVA0001error|#Errors}} the validation fails.<br/>{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no XML Schema validator is available.

* {{Code|validate:xsd('doc.xml', 'doc.xsd')}} validates the Pass on document {{Code|doc.xml}} against the specified and schema {{Code|doc.xsd}}.* The following example demonstrates how a document can be validated against a schema without resorting to local or remote URIsas nodes:<pre classsyntaxhighlight lang="brush:xquery">

</presyntaxhighlight>* Validate all documents of a database against the specified schema, using the supplied feature:<syntaxhighlight lang="xquery">for $city in db:open('cities')return validate:xsd($city, 'city.xsd', map { 'http://javax.xml.XMLConstants/feature/secure-processing': true() })</syntaxhighlight>

|{{Func|validate:xsd-info|$input as item()|xs:string*}}<br />{{Func|validate:xsd-info|$input as item(), $schema as item()?|xs:string*}}<br />{{Func|validate:xsd-info|$input as item(), $schema as item()?, $features as map(*)|xs:string*}}

|Validates the XML {{Code|$input}} document against a document {{Code|$schema}}, using the processor-specific {{Code|$features}}, and returns warnings, errors and fatal errors in a string sequence. See [[#validate:xsd|validate:xsd]] for more details on the function arguments.

|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no XML Schema validator is available.

{| width='100%'|-| width='120' | '''Signatures'''|{{Func|validate:xsd-report|$input as item()|element(report)}}<br />{{Func|validate:xsd-report|$input as item(), $schema as xs:string?|element(report)}}<br />{{Func|validate:xsd-report|$input as item(), $schema as xs:string?, $features as map(*)|element(report)}}|-| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the processor-specific {{Code|$features}}, and returns warnings, errors and fatal errors as XML.|-| '''Errors'''|{{MarkError|init|Introduced with Version 8#Errors}} the validation process cannot be started.3<br/>{{Error|not-found|#Errors}}no XML Schema validator is available.|} ==validate:xsd-processor==

|{{Func|validate:xsd-reportprocessor|$input as item()|element(report)}}<br />{{Func|validate:xsd-report|$input as item(), $schema as xs:string?|element(report)}}

|Validates a document and returns warnings, errors and fatal errors as XMLReturns the name of the applied XSD processor. See [[#|} ==validate:xsd-version== {|validate:xsd]] for more details on the function arguments.width='100%'

| width='120'| 'Errors''Signatures'''|{{ErrorFunc|BXVA0002validate:xsd-version|#Errors|xs:string}} the validation process cannot be started.<br/>{{Error|-|BXVA0003'''Summary'''|#Errors}} no XML Returns the supported version of XSD Schema validator is available.

Checks whether an XML document validates against a RelaxNG schema. The input document and the schema an can be specified as:

RelaxNG validation will be available if [httphttps://wwwrelaxng.thaiopensource.comorg/relaxngjclark/jing.html Jing] exists in the classpath. The latest version, {{Code|jing-20091111.jar}}, is included in the full distributions of BaseX. As Jing additionally supports [http://www.nvdl.org/ NVDL] validation, you can also use the functions to validate the input against NVDL schemas.

|{{Error|BXVA0001error|#Errors}} the validation fails.<br/>{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} the RelaxNG validator is not available.<br/>{{Error|BXVA0004|#Errors}} no validator is found for the specified version.

|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} the RelaxNG validator is not available.<br/>{{Error|BXVA0004|#Errors}} no validator is found for the specified version.

|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} The RelaxNG validator is not available.<br/>{{Error|BXVA0004|#Errors}} no validator is found for the specified version.

|{{Code|BXVA0001error}}|The document cannot be validated against the specified DTD or XML Schemaschema.

|{{Code|BXVA0002init}}

|{{Code|BXVA0003not-found}}