Changes

This [[Module Library|XQuery Module]] contains functions to perform validations against [http://www.w3.org/DTDs, XML/Schema XML Schema] and [http://en.wikipediaRelaxNG.org/wiki/Document_Type_Declaration Document Type Declarations]The documentation further describes how to use Schematron validation with BaseX.

All functions and errors in this module are assigned to the {{Code|<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|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.

=FunctionsDTD 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 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 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> returns:<br/><code>2:11: Element type "invalid" must be declared.</code>.|} ==validate:dtd-report== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:dtd-report( $input as item(), $schema as xs:string? := ()) as element(report)</pre>|- 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> returns:<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'''|{{Func|<pre>validate:xsd|( $input as item()|empty-sequence, $schema as item()}}<br />{{Func|validate? :xsd|$input as item= (), $schema options as itemmap(*)? := map { })|as empty-sequence()}}</pre>|-valign="top"

|Validates the document specified by XML {{Code|$input}}.<br />Both document against a {{Code|$inputschema}} and . The supported {{Code|$schemaoptions}} may be are:* an {{Code|xs:stringcache}}, containing the path to the resource,* an {{Code|xs:string}}, containing the resource in its string representation, orGenerated schemas are cached and reused.* a {{Code|node()}}, containing the resource itself.{{Code|$schema}} can be used All other options are handled as features and passed on to specify the schema for validation. If no schema is given, {{Code|$input}} is required to contain an {{Code|xsi:(noNamespace)schemaLocation}} as defined in [http://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema]validator.<br />|-valign="top"

|{{Error|BXVA0001error|XQuery #Errors}} the validation fails.<br/>{{Error|init|#Functions Errors}} the addressed document validation process cannot be validated against the given schemastarted.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available.|-valign="top"

* {{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 classlang="brush:'xquery"'>

==validate:dtdxsd-report== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:xsd-report( $input as item(), $schema as xs:string? := (), $options as map(*) := map { }) as element(report)</pre>|- valign="top"| '''Summary'''|Validates the 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 {{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-processor== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:xsd-processor() as xs:string</pre>|- valign="top"| '''Summary'''|Returns the name of the applied XSD processor.|} ==validate:xsd-version== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:xsd-version() as xs:string</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:rng== 

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>validate:dtd|rng( $input as item()|empty-sequence()}}<br />{{Func|validate:dtd|, $input schema as item(), $dtd compact as xs:string|boolean? := map { }) as empty-sequence()}}</pre>|-valign="top"

|Validates the document specified by XML {{Code|$input}}.<br />document against a {{Code|$input}} may be * an {{Code|xs:stringschema}}, containing the path to using the resource,* an {{Code|xs:string}}, containing the resource in its string representation, XML or* a {{Code|node()}}, containing the resource itself.{{Code|$schemacompact}} can be used to specify the DTD for validation. If no DTD is given, {{Code|$input}} is required to contain a DTD doctype declarationnotation.<br />|-valign="top"

|{{Error|BXVA0001error|XQuery #Errors}} the validation fails.<br/>{{Error|init|#Functions Errors}} the addressed document validation process cannot be validated against started.<br/>{{Error|not-found|#Errors}} the given DTDRelaxNG validator is not available.|-valign="top"

* {{Code|validate:xsdrng('doc.xml', 'doc.dtdrng')}} validates the document {{Code|doc.xml}} against the specified DTD file schema {{Code|doc.dtdrng}}.|} ==validate:rng-info== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:rng-info( $input as item(), $schema as item(), $compact as xs:boolean? := map { }) as xs:string* The following example validates an invalid </pre>|- valign="top"| '''Summary'''|Validates the XML {{Code|$input}} document against a DTD{{Code|$schema}}, which 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/>{{Error|not-found|#Errors}} the RelaxNG validator is specified not available.|} ==validate:rng-report== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>validate:rng-report( $input as item(), $schema as xs:string, $compact as xs:boolean? := map { }) as element(report)</pre class>|- 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="brush:xquerytop"| '''Errors'''|{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} The RelaxNG validator is not available.|} =Schematron Validation=try { let $doc If you want to use Schematron for validating documents, install Vincent Lizzi’s excellent [https://github.com/Schematron/schematron-basex Schematron XQuery Module for BaseX]: <pre lang= 'xquery'>repo:install('https://github.com/Schematron/schematron-basex/raw/master/dist/schematron-basex-1.2.xar')<invalid/pre> The following query illustrates how documents are validated. It is directly taken from the GitHub project: <pre lang='xquery'> import module namespace schematron = "http://github.com/Schematron/schematron-basex"; let $dtd sch := schematron:compile(doc('<!ELEMENT root rules.sch'))let $svrl := schematron:validate(doc(#PCDATA'document.xml'), $sch)>'return ( return validateschematron:dtdis-valid($docsvrl), for $message in schematron:messages($dtdsvrl)} catch BXVA0001 { return concat(schematron:message-level($message), 'DTD Validation failed.: ', schematron:message-description($message))})

! width="5%110"|Code! width="95%"|Description|-valign="top"|{{Code|BXVA0001error}}|A The document cannot be validated against the specified DTD or XML Schemaschema.|- valign="top"|{{Code|init}}|The validation cannot be started.|- valign="top"|{{Code|not-found}}|No validator is available.

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 8.5 * Updated: Relative URIs will always be resolved against the static base URI of the query ;Version 78.3 * 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