Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
|-
|{{Code|version}}
|No validator is found for the specified version.
→XML Schema Validation
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=
* {{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/>
'DTD Validation failed.'
}
</presyntaxhighlight>
|}
|
* <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>
|}
* {{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 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 [httphttps://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 used 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.
==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 specified processor-specific {{Code|$versionfeatures}} of XML Schema.
|-
| '''Errors'''
|{{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.<br/>{{Error|version|#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()?, $version features as xs:stringmap(*)|xs:string*}}
|-
| '''Summary'''
|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.
|-
| '''Errors'''
|{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available.<br/>{{Error|version|#Errors}} no validator is found for the specified version.
|}
|-
| 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?, $version features as xs:stringmap(*)|element(report)}}
|-
| '''Summary'''
|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.
|-
| '''Errors'''
|{{Error|init|#Errors}} the validation process cannot be started.<br/>{{Error|not-found|#Errors}} no XML Schema validator is available.<br/>|} ==validate:xsd-processor== {| width='100%'|-| width='120' | '''Signatures'''|{{ErrorFunc|validate:xsd-processor||xs:string}}|-| '''Summary'''|Returns the name of the applied XSD processor.|} ==validate:xsd-version== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|validate:xsd-version|#Errors|xs:string}} no validator is found for |-| '''Summary'''|Returns the specified supported versionof XSD Schema.
|}
* {{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==
=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=
|{{Code|not-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
