Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
{{Mark|Introduced with Version 8.3}}:
{{Mark|Updated with Version 8.3}}:
* By default, the Java implementation of Different XML Schema 1.0 is used (it is based on an old version of Apache Xerces).* If [httpsprocessors are supported://xerces.apache.org/xerces2-j Xerces2] exists in the classpath, it will be used instead. If you want to manually add Xerces2, you should download the [http://xerces.apache.org/mirrors.cgi#binary Xerces2 Java ..... (XML Schema 1.1) (Beta)] archive and copy at least four libraries ({{Code|cupv10k-runtime.jar}}, {{Code|org.eclipse.wst.xml.xpath2.processor_1.1.0.jar}}, {{Code|xercesImpl.jar}}, {{Code|xml-apis.jar}}) to the {{Code|lib}} directory of the full distribution of BaseX.* The [http://www.saxonica.com/ Saxon] Enterprise Edition ({{Code|saxon9ee.jar}}) is detected as well.
{{Mark|Introduced with Version 8.3}}:
{{Mark|Introduced with Version 8.3}}:
{{Mark|Introduced with Version 8.3}}:
|-
|{{Code|BXVA0004}}
|No validator is found for the specified version.
[[Category:XQuery]]
→XML Schema Validation
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.
=Conventions=
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.
=DTD Validation=
Checks whether an XML document validates against a DTD. The input document can be specified as:
* 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.
If no DTD is supplied in a function, the XML document is expected to contain an embedded DTD doctype declaration.
|-
| '''Errors'''
|{{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.
|-
| '''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 classsyntaxhighlight lang="brush:xquery">
try {
let $doc := <invalid/>
let $schema := '<!ELEMENT root (#PCDATA)>'
return validate:dtd($doc, $schema)
} catch bxerrvalidate:BXVA0001 error {
'DTD Validation failed.'
}
</presyntaxhighlight>
|}
|-
| '''Errors'''
|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no DTD validator is available.
|-
| '''Examples'''
==validate:dtd-report==
{| width='100%'
| width='100%'
|-
| width='120' | '''Signatures'''
|-
| '''Errors'''
|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} no DTD validator is available.
|-
| '''Examples'''
|
* <code>validate:dtd-report(<invalid/>, '<!ELEMENT root (#PCDATA)>')</code> returns:
<pre classsyntaxhighlight lang="brush:xml">
<report>
<status>invalid</status>
<message level="Error" line="2" column="11">Element type "invalid" must be declared.</message>
</report>
</presyntaxhighlight>
|}
=XML Schema Validation=
Checks whether an XML document validates against an XML Schema. The input document and the schema can be specified as:
* {{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 [httphttps://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema]. Different XML Schema implementations can be applied for validation:
* 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 version can 1.0 and 1.1. The processor will be specified as well (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 supplied string must be full distribution of BaseX:** {{Code|1org.eclipse.wst.xml.xpath2.processor_1.2.0.jar}}** {{Code|cupv10k-runtime.jar}}** {{Code|xercesImpl.jar}} or ** {{Code|1xml-apis.1jar}})* '''Saxon Enterprise Edition''' will be used if you download the [https://www.saxonica. Please note that Version 1com/download/java.1 is only available xml ZIP release] and if Saxon EE or Xerces2 is added you copy {{Code|saxon9ee.jar}} and a valid license key to the classpath.
==validate:xsd==
|-
| width='120' | '''Signatures'''
|{{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()}}
|-
| '''Summary'''
|Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the processor-specific {{Code|$features}}.
|-
| '''Errors'''
|{{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.
|-
| '''Examples'''
|
* {{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">
let $doc := <simple:root xmlns:simple='http://basex.org/simple'/>
let $schema :=
</xs:schema>
return validate:xsd($doc, $schema)
</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>
|}
|-
| width='120' | '''Signatures'''
|{{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*}}
|-
| '''Summary'''
|Validates the XML {{Code|$input}} document against a {{Code|$schema}} , using the processor-specific {{Code|$features}}, and returns warnings, errors and fatal errors in a string sequence.
|-
| '''Errors'''
|{{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.
|}
==validate:xsd-report==
{| 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==
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|validate:xsd-reportprocessor|$input as item()|element(report)}}<br />{{Func|validate:xsd-report|$input as item(), $schema as xs:string?|element(report)}}
|-
| '''Summary'''
|Validates Returns the XML name of the applied XSD processor.|} ==validate:xsd-version== {{Code|$input}} document against a width='100%'|-| width='120' | '''Signatures'''|{{CodeFunc|$schemavalidate:xsd-version||xs:string}} and returns warnings, errors and fatal errors as XML.
|-
| '''ErrorsSummary'''|{{Error|BXVA0002|#Errors}} Returns the validation process cannot be started.<br/>{{Error|BXVA0003|#Errors}} no XML supported version of XSD Schema validator is available.<br/>{{Error|BXVA0004|#Errors}} no validator is found for the specified version.
|}
* {{Code|node()}}, containing the resource itself.
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.
==validate:rng==
{| width='100%'
|-
| '''Errors'''
|{{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.
|-
| '''Examples'''
==validate:rng-info==
{| width='100%'
|-
| '''Errors'''
|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} the RelaxNG validator is not available.
|}
==validate:rng-report==
{| width='100%'
|-
| '''Errors'''
|{{Error|BXVA0002init|#Errors}} the validation process cannot be started.<br/>{{Error|BXVA0003not-found|#Errors}} The RelaxNG validator is not available.
|}
=Schematron Validation=
If you want to use Schematron for validating documents, simply install Vincent Lizzi’s excellent [https://github.com/Schematron/schematron-basex Schematron XQuery Module for BaseX]:
<syntaxhighlight lang="xquery">
repo:install('https://github.com/Schematron/schematron-basex/raw/master/dist/schematron-basex-1.2.xar')
</syntaxhighlight>
The following query illustrates how documents are validated. It is directly taken from the GitHub project:
<syntaxhighlight lang="xquery">
import module namespace schematron = "http://github.com/Schematron/schematron-basex";
let $sch := schematron:compile(doc('rules.sch'))
let $svrl := schematron:validate(doc('document.xml'), $sch)
return (
schematron:is-valid($svrl),
for $message in schematron:messages($svrl)
return concat(schematron:message-level($message), ': ', schematron:message-description($message))
)
</syntaxhighlight>
=Errors=
|Description
|-
|{{Code|BXVA0001error}}|The document cannot be validated against the specified DTD or XML Schemaschema.
|-
|{{Code|BXVA0002init}}
|The validation cannot be started.
|-
|{{Code|BXVA0003not-found}}
|No validator is available.
|}
=Changelog=
;Version 9.2
* Added: [[#validate:xsd-processor|validate:xsd-processor]], [[#validate:xsd-version|validate:xsd-version]]
* Updated: [[#validate:xsd|validate:xsd]], [[#validate:xsd-info|validate:xsd-info]], [[#validate:xsd-report|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 namespace
;Version 8.5
* Updated: Relative URIs will always be resolved against the static base URI of the query
;Version 8.3
* Added: [[#validate:rng|validate:rng]], [[#validate:rng-info|validate:rng-info]]
* Added: [[#validate:dtd-report|dtd-report]], [[#validate:xsd-report|xsd-report]], [[#validate:rng-report|validate:rng-report]]
;Version 7.6
* Added: [[#validate:xsd-info|validate:xsd-info]], [[#validate:dtd-info|validate:dtd-info]]
The module was introduced with Version 7.3.
