Changes

This [[Module Library|XQuery Module]] contains functions to perform validations against DTDs, XML Schema and 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.

* {{Code|xs:string}}, representing a URI (since {{Version|8.5}}, relative URIs will always be resolved against the static base URI of the query),

|{{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.

} catch bxerrvalidate:BXVA0001 error {

|{{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.

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

* By default, the '''Java implementation ''' of XML Schema 1.0 is used (it is based on an 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 [http://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 applied if you download the [httphttps://www.saxonica.com/ Saxondownload/java.xml ZIP release] Enterprise Edition (and if you copy {{Code|saxon9ee.jar}}) is detected as well. The XML Schema version can be specified as well (the supplied string must be {{Code|1.0}} 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 specified processor-specific {{Code|$versionfeatures}} of XML Schema.

|{{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.<br/>{{Error|BXVA0004|#Errors}} no validator is found for the specified version.

* {{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:

|{{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()?, $version features as xs:stringmap(*)|xs:string*}}

|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the specified processor-specific {{Code|$versionfeatures}} of XML Schema, and returns warnings, errors and fatal errors in a string sequence.

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

|{{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?, $version features as xs:stringmap(*)|element(report)}}

|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the specified processor-specific {{Code|$versionfeatures}} of XML Schema, and returns warnings, errors and fatal errors as XML.

|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no XML Schema validator is available.<br/>|} ==validate:xsd-processor== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|validate:xsd-processor||xs:string}}|-| '''Summary'''|Returns the name of the applied XSD processor.|} ==validate:xsd-version== {| width='100%'|-| width='120' | '''Signatures'''|{{ErrorFunc|validate:xsd-version|BXVA0004|#Errorsxs:string}} no validator is found for |-| '''Summary'''|Returns the specified supported versionof XSD Schema.

RelaxNG validation will be available if [http://www.thaiopensource.com/relaxng/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 provides supports [NVDL](http://www.nvdl.org/) NVDL] validation, you can also use the functions to validate the input against NVDLschemas.

|{{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.

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

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

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

|{{Code|BXVA0002init}}

|{{Code|BXVA0003not-found}}