Changes

This [[Module Library|XQuery Module]] contains functions to perform validations against [http://www.w3.org/XML/Schema DTDs, XML Schema] and [http://en.wikipedia.org/wiki/Document_Type_Declaration Document Type Declarations]RelaxNG.This module has been introduced The documentation further describes how to use Schematron validation with {{Version|7.2.2}}BaseX.

=Conventions= All functions and errors in this module are preceded by assigned to the <code><nowiki>http://basex.org/modules/validate:</nowiki></code> namespace, which is statically bound to the {{Code|validate}} prefix.<br/> =DTD Validation= Checks whether an XML document validates against a DTD. The input document can be specified as: * {{Code|xs:string}}, representing a URI (relative URIs will always be resolved against the static base URI of the query),* {{Code|xs:string}}, representing the resource in its string representation, or* {{Code|node()}}, representing the resource itself. If no DTD is supplied in a function, the XML document is expected to contain an embedded DTD doctype declaration. ==validate:dtd== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:dtd( $input as item(), $schema as xs:string? := ()) as empty-sequence()</pre>|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}} and returns an empty sequence or an error.|- valign="top"| '''Errors'''|{{Error|error|#Errors}} the validation fails.<br/>{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no DTD validator is available.|- valign="top"| '''Examples'''|* {{Code|validate:dtd('doc.xml', 'doc.dtd')}} validates the document {{Code|doc.xml}} against the specified DTD file {{Code|doc.dtd}}.* The following example validates an invalid document against a DTD, which is linked to specified as string:<pre lang='xquery'>try { let $doc := <invalid/> let $schema := '<!ELEMENT root (#PCDATA)>' return validate:dtd($doc, $schema)} catch validate:error { 'DTD Validation failed.'}</pre>|} ==validate:dtd-info== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:dtd-info( $input as item(), $schema as xs:string? := ()) as xs:string*</pre>|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}} and returns warnings, errors and fatal errors in a string sequence.|- valign="top"| '''Errors'''|{{Error|init|#Errors}} the statically declared validation process cannot be started.<br/>{{Error|not-found|#Errors}} no DTD validator is available.|- valign="top"| '''Examples'''|* <code>validate:dtd-info(<invalid/>, '<!ELEMENT root (#PCDATA)>')</code>httpreturns:<br/><code>2:11: Element type "invalid" must be declared.</basexcode>.org|} ==validate:dtd-report== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:dtd-report( $input as item(), $schema as xs:string? := ()) as element(report)</modulespre>|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}} and returns warnings, errors and fatal errors as XML.|- valign="top"| '''Errors'''|{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no DTD validator is available.|- valign="top"| '''Examples'''|* <code>validate:dtd-report(<invalid/>, '<!ELEMENT root (#PCDATA)>')</code> namespacereturns:<pre lang="xml"><report> <status>invalid</status> <message level="Error" line="2" column="11">Element type "invalid" must be declared.</message></report></pre>|} =XML Schema Validation= Checks whether an XML document validates against an XML Schema. The input document and the schema can be specified as: * {{Code|xs:string}}, containing the path to the resource,* {{Code|xs:string}}, containing the resource in its string representation, or* {{Code|node()}}, containing the resource itself. If no schema is given, the input is expected to contain an {{Code|xsi:(noNamespace)schemaLocation}} attribute, as defined in [https://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema]. Different XML Schema processors are supported: * By default, the '''Java implementation''' of XML Schema 1.0 is used (it is based on an old version of Apache Xerces).* The latest version of '''Xerces2''' provides implementations of XML Schema 1.0 and 1.1. The processor will be applied if you download one of the [https://xerces.apache.org/mirrors.cgi#binary binary distributions] and copy the following libraries to the {{Code|lib/custom}} directory of the full distribution of BaseX:** {{Code|org.eclipse.wst.xml.xpath2.processor_1.2.0.jar}}** {{Code|cupv10k-runtime.jar}}** {{Code|xercesImpl.jar}}** {{Code|xml-apis.jar}}* '''Saxon Enterprise Edition''' will be used if you download the [https://www.saxonica.com/download/java.xml ZIP release] and if you copy {{Code|saxon9ee.jar}} and a valid license key to the classpath.

 {{Announce|Updated with Version 11:}} caching feature added. {|-width='100%'| - valign='"top' "| width='90120' | '''SignaturesSignature'''|<code><bpre>validate:xsd</b>( $input as item()) , $schema as empty-sequenceitem()</code><br /><code><b>validate? :xsd</b>= (), $input options as itemmap(*), $schema as xs? :string= map { }) as empty-sequence()</codepre>|-| valign='"top' "| '''Summary'''|Validates the XML {{Code|$input}} document specified by <code>against a {{Code|$schema}}. The supported {{Code|$inputoptions}} are:* {{Code|cache}}: Generated schemas are cached and reused.* All other options are handled as features and passed on to the validator.|- valign="top"| '''Errors'''|{{Error|error|#Errors}} the validation fails.<br/code>{{Error|init|#Errors}} the validation process cannot be started.<br />{{Error|not-found|#Errors}} no XML Schema validator is available.|- valign="top"| '''Examples'''|* Pass on document and schema as nodes:<codepre lang='xquery'>let $inputdoc := <simple:root xmlns:simple='http://basex.org/simple'/code> may be * let $schema := <code>xs:string<schema xmlns:xs='http://www.w3.org/2001/XMLSchema' targetNamespace='http://basex.org/codesimple'>, containing the path to the document,* <code>xs:string<element name='root'/code>, containing the document in its string representation, or* <code/xs:schema>nodereturn validate:xsd($doc, $schema)</codepre>* Validate all documents of a database against the specified schema, containing using the actual document.supplied feature:<codepre lang='xquery'>for $input</code> is required to contain an <code>xsicity in db:get(noNamespace'cities')schemaLocation</code> as defined in [return validate:xsd($city, 'city.xsd', map { 'http://wwwjavax.w3xml.orgXMLConstants/TRfeature/xmlschemasecure-1processing': true() })</#xsi_schemaLocation W3C XML Schema], if no pre>|} ==validate:xsd-info== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<codepre>validate:xsd-info( $input as item(), $schema as item()? := (), $options as map(*)? := map { }) as xs:string*</codepre> is given|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}} and returns warnings, errors and fatal errors in a string sequence. See {{Function||validate:xsd}} for more information of the {{Code|$options}} parameter.|- valign="top"| '''Errors'''|{{Error|init|#Errors}} the validation process cannot be started.<br />{{Error|not-found|#Errors}} no XML Schema validator is available.|} ==validate:xsd-report== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<codepre>validate:xsd-report( $input as item(), $schema as xs:string? := (), $options as map(*) := map { }) as element(report)</codepre> can be used to optionally specify |- valign="top"| '''Summary'''|Validates the location XML {{Code|$input}} document against a {{Code|$schema}} and returns warnings, errors and fatal errors as XML. See {{Function||validate:xsd}} for more information of the XSD file for {{Code|$options}} parameter.|- valign="top"| '''Errors'''|{{Error|init|#Errors}} the validationprocess cannot be started.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available.|} ==validate:xsd-processor== {| width='100%'| - valign="top"| width='120' | '''Signature'''|<pre>validate:xsd-processor() as xs:string</pre>|- valign="top' "| '''ExceptionsSummary'''| TodoReturns the name of the applied XSD processor.

==validate:dtdxsd-version== {|width='100%'|-| valign='"top' "| width='90120' | '''SignaturesSignature'''|<codepre>validate:xsd-version() as xs:string<b/pre>|- valign="top"| '''Summary'''|Returns the supported version of XSD Schema.|} =RelaxNG Validation= Checks whether an XML document validates against a RelaxNG schema. The input document and the schema can be specified as: * {{Code|xs:string}}, containing the path to the resource,* {{Code|xs:string}}, containing the resource in its string representation, or* {{Code|node()}}, containing the resource itself. RelaxNG validation will be available if [https://relaxng.org/jclark/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. ==validate:dtdrng== {| width='100%'|- valign="top"| width='120' | '''Signature'''|</bpre>validate:rng( $input as item(), $schema as item(), $compact as xs:boolean? := map { }) as empty-sequence()</codepre>|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the XML or {{Code|$compact}} notation.|- valign="top"| '''Errors'''|{{Error|error|#Errors}} the validation fails.<br />{{Error|init|#Errors}} the validation process cannot be started.<codebr/>{{Error|not-found|#Errors}} the RelaxNG validator is not available.|- valign="top"| '''Examples'''|* {{Code|validate:rng('doc.xml', 'doc.rng')}} validates the document {{Code|doc.xml}} against the specified schema {{Code|doc.rng}}.|} ==validate:rng-info== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<bpre>validate:dtdrng-info( $input as item(), $schema as item(), $compact as xs:boolean? := map { }) as xs:string*</pre>|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the XML or {{Code|$compact}} notation, and returns warnings, errors and fatal errors in a string sequence.|- valign="top"| '''Errors'''|{{Error|init|#Errors}} the validation process cannot be started.<br/b>{{Error|not-found|#Errors}} the RelaxNG validator is not available.|} ==validate:rng-report== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:rng-report( $input as item(), $dtd schema as xs:string, $compact as xs:boolean? := map { }) as empty-sequenceelement(report)</codepre>|-valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the XML or {{Code|$compact}} notation, and returns warnings, errors and fatal errors as XML.|- valign="top"| '''Errors'''|{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} The RelaxNG validator is not available.

==Examples=Schematron Validation=

'''Example 1If you want to use Schematron for validating documents, install Vincent Lizzi’s excellent [https://github.com/Schematron/schematron-basex Schematron XQuery Module for BaseX]: Basic validation against a document containing a schema definition'''

'''Query:'''<pre classlang="brush:'xquery"'>validaterepo:xsdinstall($doc'https://github.com/Schematron/schematron-basex/raw/master/dist/schematron-basex-1.2.xar')

The ;Version 11.0 * Updated: {{Function||validate:xsd}}, {{Function||validate:xsd-info}}, {{Function||validate:xsd-report}}: caching feature added ;Version 9.2 * Added: {{Function||validate:xsd-processor}}, {{Function||validate:xsd-version}}* Updated: {{Function||validate:xsd}}, {{Function||validate:xsd-info}}, {{Function||validate:xsd-report}}: version argument was dropped (the latest version will always be used) ;Version 9.0 * Updated: error codes updated; errors now use the module was introduced with namespace ;Version 78.25 * Updated: Relative URIs will always be resolved against the static base URI of the query ;Version 8.23 * Added: {{Function||validate:rng}}, {{Function||validate:rng-info}}* Added: {{Function||validate:dtd-report|dtd-report}}, {{Function||validate:xsd-report}}, {{Function||validate:rng-report}} ;Version 7.6