Difference between revisions of "Validation Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 10: Line 10:
 
|-
 
|-
 
| valign='top' width='90' | '''Signatures'''
 
| valign='top' width='90' | '''Signatures'''
|<code><b>validate:xsd</b>($input as item()) as empty-sequence()</code><br /><code><b>validate:xsd</b>($input as item(), $schema as xs:string) as empty-sequence()</code>
+
|<code><b>validate:xsd</b>($input as item()) as empty-sequence()</code><br /><code><b>validate:xsd</b>($input as item(), $schema as item()) as empty-sequence()</code>
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
 
|Validates the document specified by <code>$input</code>.<br />
 
|Validates the document specified by <code>$input</code>.<br />
<code>$input</code> may be  
+
Both <code>$input</code> and <code>$schema</code> may be  
* <code>xs:string</code>, containing the path to the document,
+
* <code>xs:string</code>, containing the path to the resource,
* <code>xs:string</code>, containing the document in its string representation, or
+
* <code>xs:string</code>, containing the resource in its string representation, or
* <code>node()</code>, containing the actual document.
+
* <code>node()</code>, containing the resource itself.
<code>$input</code> is required to contain an <code>xsi:(noNamespace)schemaLocation</code> as defined in [http://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema], if no <code>$schema</code> is given.<br />
+
<code>$schema</code> can be used to specify the schema for validation. If no schema is given, <code>$input</code> is required to contain an <code>xsi:(noNamespace)schemaLocation</code> as defined in [http://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation W3C XML Schema].<br />
<code>$schema</code> can be used to optionally specify the location of the XSD file for validation.
 
 
|-
 
|-
 
| valign='top' | '''Exceptions'''
 
| valign='top' | '''Exceptions'''

Revision as of 15:15, 23 May 2012

This XQuery Module contains functions to perform validations against XML Schema and Document Type Declarations. This module has been introduced with Version 7.2.2.

All functions are preceded by the validate: prefix, which is linked to the statically declared http://basex.org/modules/validate namespace.

Functions

validate:xsd

Signatures validate:xsd($input as item()) as empty-sequence()
validate:xsd($input as item(), $schema as item()) as empty-sequence()
Summary Validates the document specified by $input.

Both $input and $schema may be

  • xs:string, containing the path to the resource,
  • xs:string, containing the resource in its string representation, or
  • node(), containing the resource itself.

$schema can be used to specify the schema for validation. If no schema is given, $input is required to contain an xsi:(noNamespace)schemaLocation as defined in W3C XML Schema.

Exceptions Todo

validate:dtd

Signatures validate:dtd($input as item()) as empty-sequence()
validate:dtd($input as item(), $dtd as xs:string) as empty-sequence()

Examples

Example 1: Basic validation against a document containing a schema definition

Query:

validate:xsd($doc)

Changelog

The module was introduced with Version 7.2.2.