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";

Zorba version for this module:

The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.

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
External base-uri ( ) as xs:string?
The function returns the base URI.
External boundary-space-policy ( ) as xs:string
The function returns the static context component which controls the processing of boundary whitespace by direct element constructors.
External construction-mode ( ) as xs:string
The function returns the static context construction mode of element and document nodes.
External copy-namespaces-mode ( ) as xs:string+
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.
External default-collation ( ) as xs:string
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.
External default-collection-type ( ) as xs:string
The function returns the statically known default collection type.
External default-function-namespace ( ) as xs:string
The function returns the URI of the default function namespace.
External default-order ( ) as xs:string
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.
External function-annotations ( $name as xs:QName, $arity as xs:integer ) as xs:QName*
Retrieves the list of annotations declared for the given function.
External function-arguments-count ( $function as xs:QName ) as xs:int*
The function returns the number of arguments the given XQuery $function takes.
External function-names ( ) as xs:QName*
The function returns a sequence containing the QNames of all defined functions, which are available to be called from within an expression.
External in-scope-attribute-declarations ( ) as xs:QName*
The function return a sequence of QNames identifying declared attributes in the imported schemas.
External in-scope-attribute-groups ( ) as xs:QName*
The function returns a sequence of QNames identifying declared in-scope schema attribute groups.
External in-scope-element-declarations ( ) as xs:QName*
The function return a sequence of QNames identifying declared elements in the imported schemas.
External in-scope-element-groups ( ) as xs:QName*
The function returns a sequence of QNames identifying declared in-scope schema element groups.
External in-scope-schema-types ( ) as xs:QName*
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.
External in-scope-variables ( ) as xs:QName*
The function return a sequence of QNames identifying declared variables from the static context.
External option ( $name as xs:QName ) as xs:string?
Retrieves the value of an option that is declared in the prolog of the module.
External ordering-mode ( ) as xs:string
The function returns the static context ordering mode, which affects the ordering of the result sequences returned by certain expressions.
External statically-known-collations ( ) as xs:anyURI*
The function returns a sequence that contains the statically known collations.
External statically-known-document-type ( $document as xs:string ) as xs:QName
For the given document, the function returns the static type of its root node.
External statically-known-documents ( ) as xs:anyURI*
The function returns a sequence that contains the URIs of all statically known documents.
External statically-known-namespace-binding ( $prefix as xs:string ) as xs:string?
For any statically know namespace prefix, the bound URI can be retrieved with the statically-known-namespace-bindings() function.
External statically-known-namespaces ( ) as xs:string*
The function returns a list of known statically known namespaces as prefixes (fn, xml, xs, xsi, etc).
External xpath10-compatibility-mode ( ) as xs:boolean
The function returns true or false depending on whether rules for compatibility with XPath 1.
Functions
External base-uri back to 'Function Summary'
declare function sctx:base-uri (

) as xs:string?

The function returns the base URI.

Returns:
See:

External boundary-space-policy back to 'Function Summary'
declare function sctx:boundary-space-policy (

) as xs:string

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

Returns:
See:

External construction-mode back to 'Function Summary'
declare function sctx:construction-mode (

) as xs:string

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

Returns:
See:

External copy-namespaces-mode back to 'Function Summary'
declare function sctx:copy-namespaces-mode (

) as xs:string+

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:

External default-collation back to 'Function Summary'
declare function sctx:default-collation (

) as xs:string

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:

External default-collection-type back to 'Function Summary'
declare function sctx:default-collection-type (

) as xs:string

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:

External default-function-namespace back to 'Function Summary'
declare function sctx:default-function-namespace (

) as xs:string

The function returns the URI of the default function namespace.

Returns:
See:

External default-order back to 'Function Summary'
declare function sctx:default-order (

) as xs:string

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:

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

Retrieves the list of annotations declared for the given function.

Parameters:
Returns:

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

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

Parameters:
Returns:
See:

External function-names back to 'Function Summary'
declare function sctx:function-names (

) as xs:QName*

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

Returns:
See:

External in-scope-attribute-declarations back to 'Function Summary'
declare function sctx:in-scope-attribute-declarations (

) as xs:QName*

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

Returns:
See:

External in-scope-attribute-groups back to 'Function Summary'
declare function sctx:in-scope-attribute-groups (

) as xs:QName*

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

Returns:

External in-scope-element-declarations back to 'Function Summary'
declare function sctx:in-scope-element-declarations (

) as xs:QName*

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

Returns:
See:

External in-scope-element-groups back to 'Function Summary'
declare function sctx:in-scope-element-groups (

) as xs:QName*

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

Returns:

External in-scope-schema-types back to 'Function Summary'
declare function sctx:in-scope-schema-types (

) as xs:QName*

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:

External in-scope-variables back to 'Function Summary'
declare function sctx:in-scope-variables (

) as xs:QName*

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

Returns:
See:

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

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

Parameters:
Returns:

External ordering-mode back to 'Function Summary'
declare function sctx:ordering-mode (

) as xs:string

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

Returns:
See:

External statically-known-collations back to 'Function Summary'
declare function sctx:statically-known-collations (

) as xs:anyURI*

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

Returns:
See:

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

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

Parameters:
Returns:
See:

External statically-known-documents back to 'Function Summary'
declare function sctx:statically-known-documents (

) as xs:anyURI*

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

Returns:
See:

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

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

Parameters:
Returns:
See:

External statically-known-namespaces back to 'Function Summary'
declare function sctx:statically-known-namespaces (

) as xs:string*

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

Returns:
See:

External xpath10-compatibility-mode back to 'Function Summary'
declare function sctx:xpath10-compatibility-mode (

) as xs:boolean

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