saxonica.com

Extensions

The full library of Saxon and EXSLT functions described in Extensions is available, except for those (for example, some forms of saxon:serialize) that have an intrinsic dependency on an XSLT stylesheet.

declare option saxon:default

This extension is obsolescent, as the functionality is available from Saxon 9.2 onwards using the syntax appearing in the draft XQuery 1.1 specification.

An XQuery option declaration is defined allowing a default value to be specified for a query parameter (external variable). The syntax is illustrated below: 


declare namespace saxon="http://saxon.sf.net/";
declare option saxon:default "20";
declare variable $x external;

The default value is written as an XPath expression. The surrounding quotes are part of the "declare option" syntax, not part of the expression: therefore, if the default value is to be supplied as a string literal, two sets of quotes are needed. In the above example, the default value is the integer 20, not a string. Perhaps it would be clearer to show this by writing saxon:default "(+20)"

declare option saxon:output

Saxon provides an option declaration to set serialization parameters. This takes the form shown in the following example: 


declare namespace saxon="http://saxon.sf.net/";
declare option saxon:output "method=html";
declare option saxon:output "saxon:indent-spaces=1";

The standard serialization parameters described in The W3C Serialization specification are all available, namely:

In addition some Saxon-specific serialization parameters are available: see Additional serialization parameters.

declare option saxon:memo-function

Saxon provides an option declaration to treat the immediately following function as a memo-function. This takes the form shown in the following example: 


declare namespace saxon="http://saxon.sf.net/";
declare option saxon:memo-function "true";
declare function local:factorial($n as xs:integer) as xs:integer {
  local:factorial($n - 1) * n
};

A memo function remembers the results of previous calls, so if it is called twice with the same arguments, it will not repeat the computation, but return the previous result.

The allowed values of the option are "true" and "false" (the default is false), and any other value is ignored with a warning.

declare option saxon:allow-cycles

Saxon checks for the error XQST0093 which was introduced in the Proposed Recommendation. This error makes it illegal for a function or variable in module A to reference a function or variable in module B if there is a function or variable in module B that references one in A. Because this restriction is quite unnecessary and makes it very difficult to write modular applications, Saxon provides an option declare option saxon:allow-cycles "true" to disable this check. This option also disables error XQST0073, which otherwise occurs when two modules in different namespaces import each other

The allowed values of the option are "true" and "false" (the default is false), and any other value is ignored with a warning.

This option does not disable the check for cycles that would actually cause execution to fail, for example a global variable $V1 whose initializer uses $V2, when $V2 similarly depends on $V1.

Note that this option declaration must be written after the module imports, but before any variable or function declarations.

The saxon:validate-type pragma

This extension is largely obsolescent: Saxon 9.2 implements the XQuery 1.1 syntax for validation by type. The extension does serve one remaining purpose, which is to allow attributes to be validated. (The standard syntax requires an element or document node.).

Saxon-EE provides a pragma (a language extension) to allow constructed elements to be validated against a schema-defined global type definition. The standard validate expression allows validation only against a global element declaration, but some schemas (an example is FpML) provide very few global elements, and instead rely heavily on locally-declared elements having a global type. This makes it impossible to construct fragments of an FpML document in a way that takes advantage of static and dynamic type checking.

The extension takes the form:


(# saxon:validate-type my:personType #) { expr }

Conceptually, it makes a copy of the result of evaluating expr and validates it against the named schema type, causing the copied nodes to acquire type annotations based on the validation process. The effect is the same as that of the type attribute in XSLT instructions such as xsl:element and xsl:copy-of. The schema type (shown in the above example as myPersonType) may be a simple type or a complex type defined in an imported schema, or a built-in type; it is written as a QName, using the default namespace for elements and types if it is unprefixed.

Note that XQuery processors other than Saxon will typically ignore this pragma, and return the value of expr unchanged. Such processors will report type-checking failures if the value is used in a context where the required type is element(*, type-name).

You can use a different namespace prefix in place of "saxon", but it must be bound using a namespace declaration to the namespace "http://saxon.sf.net/".

Here is a complete example:


module namespace tim="http://www.example.com/module/hour-minute-time";
declare namespace saxon="http://saxon.sf.net/";
import schema namespace fpml = "http://www.fpml.org/2005/FpML-4-2" at "....";

declare function time:getCurrentHourMinuteTime() as element(*, fpml:HourMinuteTime) {
    let $time = string(current-time())
    return
        (# saxon:validate-type fpml:HourMinuteTime #) {
            <time>{substring($time, 1, 5)}:00</time>
        }
};

Saxon ignores any pragmas in a namespace other than the Saxon namespace; it rejects any pragmas whose QName is ill-formed, as well as pragmas in the Saxon namespace whose local name is not recognized.

The construct also allows validation of attributes against a simple type definition, for example:


module namespace tim="http://www.example.com/module/hour-minute-time";
declare namespace saxon="http://saxon.sf.net/";
import schema namespace fpml = "http://www.fpml.org/2005/FpML-4-2" at "....";

declare function time:getCurrentHourMinuteTime() as attribute(*, fpml:HourMinuteTime) {
    let $time = string(current-time())
    return (# saxon:validate-type fpml:HourMinuteTime #) {
       attribute time {concat(substring($time, 1, 5), ':00')}
    }
};

Next