Difference between revisions of "Validation Module"
(16 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | This [[Module Library|XQuery Module]] contains functions to perform validations against DTDs, XML Schema and RelaxNG. | + | This [[Module Library|XQuery Module]] contains functions to perform validations against DTDs, XML Schema and RelaxNG. The documentation further describes how to use Schematron validation with BaseX. |
=Conventions= | =Conventions= | ||
− | All functions 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 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/> |
− | |||
=DTD Validation= | =DTD Validation= | ||
Line 10: | Line 9: | ||
Checks whether an XML document validates against a DTD. The input document can be specified as: | Checks whether an XML document validates against a DTD. The input document can be specified as: | ||
− | * {{Code|xs:string}}, representing a URI ( | + | * {{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|xs:string}}, representing the resource in its string representation, or | ||
* {{Code|node()}}, representing the resource itself. | * {{Code|node()}}, representing the resource itself. | ||
Line 27: | Line 26: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{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. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 38: | Line 37: | ||
let $schema := '<!ELEMENT root (#PCDATA)>' | let $schema := '<!ELEMENT root (#PCDATA)>' | ||
return validate:dtd($doc, $schema) | return validate:dtd($doc, $schema) | ||
− | } catch | + | } catch validate:error { |
'DTD Validation failed.' | 'DTD Validation failed.' | ||
} | } | ||
Line 55: | Line 54: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no DTD validator is available. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 74: | Line 73: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no DTD validator is available. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 88: | Line 87: | ||
=XML Schema Validation= | =XML Schema Validation= | ||
+ | |||
+ | {{Mark|Updated with Version 9.2:}} Version argument was dropped (the latest version will always be used). | ||
Checks whether an XML document validates against an XML Schema. The input document and the schema can be specified as: | Checks whether an XML document validates against an XML Schema. The input document and the schema can be specified as: | ||
Line 97: | Line 98: | ||
If no schema is given, the input is expected to contain an {{Code|xsi:(noNamespace)schemaLocation}} attribute, as defined in [http://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema]. | If no schema is given, the input is expected to contain an {{Code|xsi:(noNamespace)schemaLocation}} attribute, as defined in [http://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema]. | ||
− | Different 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). | + | * 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 [http://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 applied 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. | ||
==validate:xsd== | ==validate:xsd== | ||
Line 110: | Line 113: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | 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()?, $ | + | |{{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()?, $features as map(*)|empty-sequence()}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the | + | |Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the processor-specific {{Code|$features}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|error|#Errors}} the validation fails.<br/>{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * | + | * Pass on document and schema as nodes: |
− | |||
<pre class="brush:xquery"> | <pre class="brush:xquery"> | ||
let $doc := <simple:root xmlns:simple='http://basex.org/simple'/> | let $doc := <simple:root xmlns:simple='http://basex.org/simple'/> | ||
Line 129: | Line 131: | ||
</xs:schema> | </xs:schema> | ||
return validate:xsd($doc, $schema) | return validate:xsd($doc, $schema) | ||
+ | </pre> | ||
+ | * Validate all documents of a database against the specified schema, using the supplied feature: | ||
+ | <pre class="brush:xquery"> | ||
+ | for $city in db:open('cities') | ||
+ | return validate:xsd($city, 'city.xsd', | ||
+ | map { 'http://javax.xml.XMLConstants/feature/secure-processing': true() } | ||
+ | ) | ||
</pre> | </pre> | ||
|} | |} | ||
Line 137: | Line 146: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | 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()?, $ | + | |{{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''' | | '''Summary''' | ||
− | |Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the | + | |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''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available. |
|} | |} | ||
Line 151: | Line 160: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | 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?, $ | + | |{{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''' | | '''Summary''' | ||
− | |Validates the XML {{Code|$input}} document against a {{Code|$schema}}, using the | + | |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''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available. |
+ | |} | ||
+ | |||
+ | ==validate:xsd-processor== | ||
+ | |||
+ | {{Mark|Introduced with Version 9.2:}} | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|validate:xsd-processor||xs:string}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the name of the applied XSD processor. | ||
+ | |} | ||
+ | |||
+ | ==validate:xsd-version== | ||
+ | |||
+ | {{Mark|Introduced with Version 9.2:}} | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|validate:xsd-version||xs:string}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the supported version of XSD Schema. | ||
|} | |} | ||
Line 168: | Line 203: | ||
* {{Code|node()}}, containing the resource itself. | * {{Code|node()}}, containing the resource itself. | ||
− | 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 | + | 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 supports [http://www.nvdl.org/ NVDL] validation, you can also use the functions to validate the input against NVDL schemas. |
==validate:rng== | ==validate:rng== | ||
Line 181: | Line 216: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|error|#Errors}} the validation fails.<br/>{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} the RelaxNG validator is not available. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 199: | Line 234: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} the RelaxNG validator is not available. |
|} | |} | ||
Line 213: | Line 248: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-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]: | ||
+ | |||
+ | <pre class="brush:xquery"> | ||
+ | repo:install('https://github.com/Schematron/schematron-basex/raw/master/dist/schematron-basex-1.2.xar') | ||
+ | </pre> | ||
+ | |||
+ | The following query illustrates how documents are validated. It is directly taken from the GitHub project: | ||
+ | |||
+ | <pre class="brush: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)) | ||
+ | ) | ||
+ | </pre> | ||
=Errors= | =Errors= | ||
Line 222: | Line 279: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|error}} |
− | |The document cannot be validated against the specified | + | |The document cannot be validated against the specified schema. |
|- | |- | ||
− | |{{Code| | + | |{{Code|init}} |
|The validation cannot be started. | |The validation cannot be started. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|not-found}} |
|No validator is available. | |No validator is available. | ||
− | |||
− | |||
− | |||
|} | |} | ||
=Changelog= | =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 | ;Version 8.5 | ||
+ | |||
* Updated: Relative URIs will always be resolved against the static base URI of the query | * Updated: Relative URIs will always be resolved against the static base URI of the query | ||
;Version 8.3 | ;Version 8.3 | ||
+ | |||
* Added: [[#validate:rng|validate:rng]], [[#validate:rng-info|validate:rng-info]] | * 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]] | * Added: [[#validate:dtd-report|dtd-report]], [[#validate:xsd-report|xsd-report]], [[#validate:rng-report|validate:rng-report]] | ||
;Version 7.6 | ;Version 7.6 | ||
+ | |||
* Added: [[#validate:xsd-info|validate:xsd-info]], [[#validate:dtd-info|validate:dtd-info]] | * Added: [[#validate:xsd-info|validate:xsd-info]], [[#validate:dtd-info|validate:dtd-info]] | ||
The module was introduced with Version 7.3. | The module was introduced with Version 7.3. |
Revision as of 15:31, 14 February 2019
This XQuery Module contains functions to perform validations against DTDs, XML Schema and RelaxNG. The documentation further describes how to use Schematron validation with BaseX.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/validate
namespace, which is statically bound to the validate
prefix.
DTD Validation
Checks whether an XML document validates against a DTD. The input document can be specified as:
xs:string
, representing a URI (relative URIs will always be resolved against the static base URI of the query),xs:string
, representing the resource in its string representation, ornode()
, 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
Signatures | validate:dtd($input as item()) as empty-sequence() validate:dtd($input as item(), $schema as xs:string?) as empty-sequence()
|
Summary | Validates the XML $input document against a $schema and returns an empty sequence or an error.
|
Errors | error : the validation fails.init : the validation process cannot be started.not-found : no DTD validator is available.
|
Examples |
try { let $doc := <invalid/> let $schema := '<!ELEMENT root (#PCDATA)>' return validate:dtd($doc, $schema) } catch validate:error { 'DTD Validation failed.' } |
validate:dtd-info
Signatures | validate:dtd-info($input as item()) as xs:string* validate:dtd-info($input as item(), $schema as xs:string?) as xs:string*
|
Summary | Validates the XML $input document against a $schema and returns warnings, errors and fatal errors in a string sequence.
|
Errors | init : the validation process cannot be started.not-found : no DTD validator is available.
|
Examples |
|
validate:dtd-report
width='100%' | |
Signatures | validate:dtd-report($input as item()) as element(report) validate:dtd-report($input as item(), $schema as xs:string?) as element(report)
|
Summary | Validates the XML $input document against a $schema and returns warnings, errors and fatal errors as XML.
|
Errors | init : the validation process cannot be started.not-found : no DTD validator is available.
|
Examples |
<report> <status>invalid</status> <message level="Error" line="2" column="11">Element type "invalid" must be declared.</message> </report> |
XML Schema Validation
Template:Mark Version argument was dropped (the latest version will always be used).
Checks whether an XML document validates against an XML Schema. The input document and the schema can be specified as:
xs:string
, containing the path to the resource,xs:string
, containing the resource in its string representation, ornode()
, containing the resource itself.
If no schema is given, the input is expected to contain an xsi:(noNamespace)schemaLocation
attribute, as defined in 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 binary distributions and copy the following libraries to the
lib/custom
directory of the full distribution of BaseX:org.eclipse.wst.xml.xpath2.processor_1.2.0.jar
cupv10k-runtime.jar
xercesImpl.jar
xml-apis.jar
- Saxon Enterprise Edition will be applied if you download the ZIP release and if you copy
saxon9ee.jar
and a valid license key to the classpath.
validate:xsd
Signatures | validate:xsd($input as item()) as empty-sequence() validate:xsd($input as item(), $schema as item()?) as empty-sequence() validate:xsd($input as item(), $schema as item()?, $features as map(*)) as empty-sequence()
|
Summary | Validates the XML $input document against a $schema , using the processor-specific $features .
|
Errors | error : the validation fails.init : the validation process cannot be started.not-found : no XML Schema validator is available.
|
Examples |
let $doc := <simple:root xmlns:simple='http://basex.org/simple'/> let $schema := <xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' targetNamespace='http://basex.org/simple'> <xs:element name='root'/> </xs:schema> return validate:xsd($doc, $schema)
for $city in db:open('cities') return validate:xsd($city, 'city.xsd', map { 'http://javax.xml.XMLConstants/feature/secure-processing': true() } ) |
validate:xsd-info
Signatures | validate:xsd-info($input as item()) as xs:string* validate:xsd-info($input as item(), $schema as item()?) as xs:string* validate:xsd-info($input as item(), $schema as item()?, $features as map(*)) as xs:string*
|
Summary | Validates the XML $input document against a $schema , using the processor-specific $features , and returns warnings, errors and fatal errors in a string sequence.
|
Errors | init : the validation process cannot be started.not-found : no XML Schema validator is available.
|
validate:xsd-report
Signatures | validate:xsd-report($input as item()) as element(report) validate:xsd-report($input as item(), $schema as xs:string?) as element(report) validate:xsd-report($input as item(), $schema as xs:string?, $features as map(*)) as element(report)
|
Summary | Validates the XML $input document against a $schema , using the processor-specific $features , and returns warnings, errors and fatal errors as XML.
|
Errors | init : the validation process cannot be started.not-found : no XML Schema validator is available.
|
validate:xsd-processor
Signatures | validate:xsd-processor() as xs:string
|
Summary | Returns the name of the applied XSD processor. |
validate:xsd-version
Signatures | validate:xsd-version() as xs:string
|
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:
xs:string
, containing the path to the resource,xs:string
, containing the resource in its string representation, ornode()
, containing the resource itself.
RelaxNG validation will be available if Jing exists in the classpath. The latest version, jing-20091111.jar
, is included in the full distributions of BaseX. As Jing additionally supports NVDL validation, you can also use the functions to validate the input against NVDL schemas.
validate:rng
Signatures | validate:rng($input as item(), $schema as item()) as empty-sequence() validate:rng($input as item(), $schema as item(), $compact as xs:boolean) as empty-sequence()
|
Summary | Validates the XML $input document against a $schema , using the XML or $compact notation.
|
Errors | error : the validation fails.init : the validation process cannot be started.not-found : the RelaxNG validator is not available.
|
Examples |
|
validate:rng-info
Signatures | validate:rng-info($input as item(), $schema as item()) as xs:string* validate:rng-info($input as item(), $schema as item(), $compact as xs:boolean) as xs:string*
|
Summary | Validates the XML $input document against a $schema , using the XML or $compact notation, and returns warnings, errors and fatal errors in a string sequence.
|
Errors | init : the validation process cannot be started.not-found : the RelaxNG validator is not available.
|
validate:rng-report
Signatures | validate:rng-report($input as item(), $schema as xs:string) as element(report) validate:rng-report($input as item(), $schema as xs:string, $compact as xs:boolean) as element(report)
|
Summary | Validates the XML $input document against a $schema , using the XML or $compact notation, and returns warnings, errors and fatal errors as XML.
|
Errors | init : the validation process cannot be started.not-found : The RelaxNG validator is not available.
|
Schematron Validation
If you want to use Schematron for validating documents, simply install Vincent Lizzi’s excellent Schematron XQuery Module for BaseX:
repo:install('https://github.com/Schematron/schematron-basex/raw/master/dist/schematron-basex-1.2.xar')
The following query illustrates how documents are validated. It is directly taken from the GitHub project:
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)) )
Errors
Code | Description |
---|---|
error
|
The document cannot be validated against the specified schema. |
init
|
The validation cannot be started. |
not-found
|
No validator is available. |
Changelog
- Version 9.2
- Added: validate:xsd-processor, validate:xsd-version
- Updated: validate:xsd, validate:xsd-info, 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-info
- Added: dtd-report, xsd-report, validate:rng-report
- Version 7.6
- Added: validate:xsd-info, validate:dtd-info
The module was introduced with Version 7.3.