- All Modules
- All Functions
-
www.w3.org
- 2005
- XDM
- store
- introspection
- reflection
- external
-
xqdoc
-
project_xqdoc
-
xqdoc
(E)
- xqdoc2xhtml
-
project_xqdoc
- data processing
- expath.org
- www.functx.com
- debugger
- error
- www.zorba-xquery.com
http://www.zorba-xquery.com/modules/introspection/sctx
import module namespace sctx = "http://www.zorba-xquery.com/modules/introspection/sctx";
Intospection Module for the Static Context components.
Nicolae Brinza
xquery version "1.0" encoding "utf-8";
The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.
- the XQuery module can be found here.
For more details please also see:
sctx | http://www.zorba-xquery.com/modules/introspection/sctx |
ver | http://www.zorba-xquery.com/options/versioning |
![]() |
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. |
declare function sctx:base-uri ( ) as xs:string? external
The function returns the base URI.
- The base URI.
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.
- Either "preserve" or "strip", as strings.
declare function sctx:construction-mode ( ) as xs:string external
The function returns the static context construction mode of element and document nodes.
- Either "preserve" or "strip", as strings.
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
- A sequence containing exactly two strings, of which the first has a value of either "preserve" or "no-preserve" and the second a value of either "inherit" or "no-inherit".
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.
- The collations that is used by default.
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.
- The type of the default collection.
declare function sctx:default-function-namespace ( ) as xs:string external
The function returns the URI of the default function namespace.
- The URI of the of the default function namespace.
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.
- Either "greatest" or "least", as strings.
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.
- $name the name of the function
- $arity the number of arguments the function takes
- the list of annotations
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.
- $function A QName identifying a function.
- A sequence of zero or more integers, one for each overloaded version of the given function. An empty sequence is returned if the function is not defined.
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.
- A sequence for QNames identifying all functions.
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.
- A sequence of QNames, one for each attribute.
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.
- A sequence of QNames, one for each attribute group.
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.
- A sequence of QNames, one for each declared element.
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.
- A sequence of QNames, one for each element group.
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.
- A sequence of QNames, one for each defined type.
declare function sctx:in-scope-variables ( ) as xs:QName* external
The function return a sequence of QNames identifying declared variables from the static context.
- A sequence of QNames, one for each variable.
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.
- $name the name of the option value to retrieve
- the value of the option if contained in the static context or the empty sequence otherwise.
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.
- Either "ordered" or "unordered", as strings.
declare function sctx:statically-known-collations ( ) as xs:anyURI* external
The function returns a sequence that contains the statically known collations.
- The sequence of collations.
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.
- $document An URI of a document.
- The static type of the given document.
declare function sctx:statically-known-documents ( ) as xs:anyURI* external
The function returns a sequence that contains the URIs of all statically known documents.
- The sequence of document URIs.
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.
- $prefix The prefix of the known namespace, for which the bound URI is being requested.
- The URI bound to the prefix is returned, or an empty sequence if the prefix is not known.
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).
- A sequence of xs:strings, one for each known namespace prefix.
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.
- The function should return false