Validation Module
This XQuery Module contains functions to perform validations against DTDs, XML Schema and RelaxNG. For Schematron validation, check out Vincent Lizzi’s Schematron XQuery Module for BaseX.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/validate
namespace, which is statically bound to the validate
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
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 | BXVA0001 : the validation fails.BXVA0002 : the validation process cannot be started.BXVA0003 : no DTD validator is available.
|
Examples |
try { let $doc := <invalid/> let $schema := '<!ELEMENT root (#PCDATA)>' return validate:dtd($doc, $schema) } catch bxerr:BXVA0001 { '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 | BXVA0002 : the validation process cannot be started.BXVA0003 : 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 | BXVA0002 : the validation process cannot be started.BXVA0003 : 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
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 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).
- If Xerces2 exists in the classpath, it will be used instead. If you want to manually add Xerces2, you should download the Xerces2 Java ..... (XML Schema 1.1) (Beta) archive and copy at least four libraries (
cupv10k-runtime.jar
,org.eclipse.wst.xml.xpath2.processor_1.1.0.jar
,xercesImpl.jar
,xml-apis.jar
) to thelib
directory of the full distribution of BaseX. - The Saxon Enterprise Edition (
saxon9ee.jar
) is detected as well.
The XML Schema version can be specified as well (the supplied string must be 1.0
or 1.1
). Please note that Version 1.1 is only available if Saxon EE or Xerces2 is added 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()?, $version as xs:string) as empty-sequence()
|
Summary | Validates the XML $input document against a $schema , using the specified $version of XML Schema.
|
Errors | BXVA0001 : the validation fails.BXVA0002 : the validation process cannot be started.BXVA0003 : no XML Schema validator is available.BXVA0004 : no validator is found for the specified version.
|
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) |
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()?, $version as xs:string) as xs:string*
|
Summary | Validates the XML $input document against a $schema , using the specified $version of XML Schema, and returns warnings, errors and fatal errors in a string sequence.
|
Errors | BXVA0002 : the validation process cannot be started.BXVA0003 : no XML Schema validator is available.BXVA0004 : no validator is found for the specified version.
|
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?, $version as xs:string) as element(report)
|
Summary | Validates the XML $input document against a $schema , using the specified $version of XML Schema, and returns warnings, errors and fatal errors as XML.
|
Errors | BXVA0002 : the validation process cannot be started.BXVA0003 : no XML Schema validator is available.BXVA0004 : no validator is found for the specified version.
|
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 | BXVA0001 : the validation fails.BXVA0002 : the validation process cannot be started.BXVA0003 : 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 | BXVA0002 : the validation process cannot be started.BXVA0003 : 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 | BXVA0002 : the validation process cannot be started.BXVA0003 : The RelaxNG validator is not available.
|
Errors
Code | Description |
---|---|
BXVA0001
|
The document cannot be validated against the specified DTD or XML Schema. |
BXVA0002
|
The validation cannot be started. |
BXVA0003
|
No validator is available. |
BXVA0004
|
No validator is found for the specified version. |
Changelog
- 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.