http://www.zorba-xquery.com/modules/introspection/sctx ZC

Module Description
Before using any of the functions below please remember to import the module namespace:
import module namespace sctx = "http://www.zorba-xquery.com/modules/introspection/sctx";

Intospection Module for the Static Context components.

Author:

Nicolae Brinza

XQuery version and encoding for this module:

xquery version "1.0" encoding "utf-8";

Module Resources
Related Documentation

For more details please also see:

Namespaces
sctx http://www.zorba-xquery.com/modules/introspection/sctx
ver http://www.zorba-xquery.com/options/versioning
Function Summary
base-uri ( ) as xs:string? external
The function returns the base URI.
boundary-space-policy ( ) as xs:string external
The function returns the static context component which controls the processing of boundary whitespace by direct element constructors.
construction-mode ( ) as xs:string external
The function returns the static context construction mode of element and document nodes.
copy-namespaces-mode ( ) as xs:string+ external
default-collation ( ) as xs:string external
The function returns one of statically known collations that is used by functions and operators for comparing and ordering values of type xs:string or xs:anyURI when no explicit collation is specified.
default-collection-type ( ) as xs:string external
The function returns the statically known default collection type.
default-function-namespace ( ) as xs:string external
The function returns the URI of the default function namespace.
default-order ( ) as xs:string external
The function returns the static context component which controls the processing of empty sequences and NaN values as ordering keys in an order by clause in a FLWOR expression.
function-annotations ( $name as xs:QName, $arity as xs:integer ) as xs:QName* external
Retrieves the list of annotations declared for the given function.
function-arguments-count ( $function as xs:QName ) as xs:int* external
The function returns the number of arguments the given XQuery $function takes.
function-names ( ) as xs:QName* external
The function returns a sequence containing the QNames of all defined functions, which are available to be called from within an expression.
in-scope-attribute-declarations ( ) as xs:QName* external
The function return a sequence of QNames identifying declared attributes in the imported schemas.
in-scope-attribute-groups ( ) as xs:QName* external
The function returns a sequence of QNames identifying declared in-scope schema attribute groups.
in-scope-element-declarations ( ) as xs:QName* external
The function return a sequence of QNames identifying declared elements in the imported schemas.
in-scope-element-groups ( ) as xs:QName* external
The function returns a sequence of QNames identifying declared in-scope schema element groups.
in-scope-schema-types ( ) as xs:QName* external
The function returns a sequence of QNames identifying in-scope schema types, including all the predefined schema types and all definitions found in imported schemas.
in-scope-variables ( ) as xs:QName* external
The function return a sequence of QNames identifying declared variables from the static context.
option ( $name as xs:QName ) as xs:string? external
Retrieves the value of an option that is declared in the prolog of the module.
ordering-mode ( ) as xs:string external
The function returns the static context ordering mode, which affects the ordering of the result sequences returned by certain expressions.
statically-known-collations ( ) as xs:anyURI* external
The function returns a sequence that contains the statically known collations.
statically-known-document-type ( $document as xs:string ) as xs:QName external
For the given document, the function returns the static type of its root node.
statically-known-documents ( ) as xs:anyURI* external
The function returns a sequence that contains the URIs of all statically known documents.
statically-known-namespace-binding ( $prefix as xs:string ) as xs:string? external
For any statically know namespace prefix, the bound URI can be retrieved with the statically-known-namespace-bindings() function.
statically-known-namespaces ( ) as xs:string* external
The function returns a list of known statically known namespaces as prefixes (fn, xml, xs, xsi, etc).
xpath10-compatibility-mode ( ) as xs:boolean external
The function returns true or false depending on whether rules for compatibility with XPath 1.
Functions
base-uri back to 'Function Summary'
declare function sctx:base-uri (
 ) as xs:string? external

The function returns the base URI.

Returns:
See:

boundary-space-policy back to 'Function Summary'
declare function sctx:boundary-space-policy (
 ) as xs:string external

The function returns the static context component which controls the processing of boundary whitespace by direct element constructors.

Returns:
See:

construction-mode back to 'Function Summary'
declare function sctx:construction-mode (
 ) as xs:string external

The function returns the static context construction mode of element and document nodes.

Returns:
See:

copy-namespaces-mode back to 'Function Summary'
declare function sctx:copy-namespaces-mode (
 ) as xs:string+ external

The function returns the static context components which control the the namespace bindings that are assigned when an existing element node is copied by an element constructor

Returns:
See:

default-collation back to 'Function Summary'
declare function sctx:default-collation (
 ) as xs:string external

The function returns one of statically known collations that is used by functions and operators for comparing and ordering values of type xs:string or xs:anyURI when no explicit collation is specified.

Returns:
See:

default-collection-type back to 'Function Summary'
declare function sctx:default-collection-type (
 ) as xs:string external

The function returns the statically known default collection type. This is the type of the sequence of nodes that would result from calling the fn:collection function with no arguments.

Returns:
See:

default-function-namespace back to 'Function Summary'
declare function sctx:default-function-namespace (
 ) as xs:string external

The function returns the URI of the default function namespace.

Returns:
See:

default-order back to 'Function Summary'
declare function sctx:default-order (
 ) as xs:string external

The function returns the static context component which controls the processing of empty sequences and NaN values as ordering keys in an order by clause in a FLWOR expression.

Returns:
See:

function-annotations back to 'Function Summary'
declare function sctx:function-annotations (
            $name as xs:QName, 
            $arity as xs:integer 
 ) as xs:QName* external

Retrieves the list of annotations declared for the given function.

Parameters:
Returns:

function-arguments-count back to 'Function Summary'
declare function sctx:function-arguments-count (
            $function as xs:QName 
 ) as xs:int* external

The function returns the number of arguments the given XQuery $function takes.

Parameters:
Returns:
See:

function-names back to 'Function Summary'
declare function sctx:function-names (
 ) as xs:QName* external

The function returns a sequence containing the QNames of all defined functions, which are available to be called from within an expression.

Returns:
See:

in-scope-attribute-declarations back to 'Function Summary'
declare function sctx:in-scope-attribute-declarations (
 ) as xs:QName* external

The function return a sequence of QNames identifying declared attributes in the imported schemas.

Returns:
See:

in-scope-attribute-groups back to 'Function Summary'
declare function sctx:in-scope-attribute-groups (
 ) as xs:QName* external

The function returns a sequence of QNames identifying declared in-scope schema attribute groups.

Returns:

in-scope-element-declarations back to 'Function Summary'
declare function sctx:in-scope-element-declarations (
 ) as xs:QName* external

The function return a sequence of QNames identifying declared elements in the imported schemas.

Returns:
See:

in-scope-element-groups back to 'Function Summary'
declare function sctx:in-scope-element-groups (
 ) as xs:QName* external

The function returns a sequence of QNames identifying declared in-scope schema element groups.

Returns:

in-scope-schema-types back to 'Function Summary'
declare function sctx:in-scope-schema-types (
 ) as xs:QName* external

The function returns a sequence of QNames identifying in-scope schema types, including all the predefined schema types and all definitions found in imported schemas.

Returns:
See:

in-scope-variables back to 'Function Summary'
declare function sctx:in-scope-variables (
 ) as xs:QName* external

The function return a sequence of QNames identifying declared variables from the static context.

Returns:
See:

option back to 'Function Summary'
declare function sctx:option (
            $name as xs:QName 
 ) as xs:string? external

Retrieves the value of an option that is declared in the prolog of the module.

Parameters:
Returns:

ordering-mode back to 'Function Summary'
declare function sctx:ordering-mode (
 ) as xs:string external

The function returns the static context ordering mode, which affects the ordering of the result sequences returned by certain expressions.

Returns:
See:

statically-known-collations back to 'Function Summary'
declare function sctx:statically-known-collations (
 ) as xs:anyURI* external

The function returns a sequence that contains the statically known collations.

Returns:
See:

statically-known-document-type back to 'Function Summary'
declare function sctx:statically-known-document-type (
            $document as xs:string 
 ) as xs:QName external

For the given document, the function returns the static type of its root node.

Parameters:
Returns:
See:

statically-known-documents back to 'Function Summary'
declare function sctx:statically-known-documents (
 ) as xs:anyURI* external

The function returns a sequence that contains the URIs of all statically known documents.

Returns:
See:

statically-known-namespace-binding back to 'Function Summary'
declare function sctx:statically-known-namespace-binding (
            $prefix as xs:string 
 ) as xs:string? external

For any statically know namespace prefix, the bound URI can be retrieved with the statically-known-namespace-bindings() function.

Parameters:
Returns:
See:

statically-known-namespaces back to 'Function Summary'
declare function sctx:statically-known-namespaces (
 ) as xs:string* external

The function returns a list of known statically known namespaces as prefixes (fn, xml, xs, xsi, etc).

Returns:
See:

xpath10-compatibility-mode back to 'Function Summary'
declare function sctx:xpath10-compatibility-mode (
 ) as xs:boolean external

The function returns true or false depending on whether rules for compatibility with XPath 1.0 are in effect. XQuery set the value of this component to false.

Returns:
See:

blog comments powered by Disqus