1. Zorba 3.0 Documentation
  2. Modules
  3. Zorba
  4. Static Context

http://zorba.io/modules/sctx

View as XML or JSON.

This module provides functions that gets components of the static context.

Function Summary

base-uri () as xs:string? external

Gets the base URI.
boundary-space-policy () as xs:string external

Gets the boundary whitespace policy used by direct element constructors.
construction-mode () as xs:string external

Gets the static context construction mode of element and document nodes.
copy-namespaces-mode () as xs:string+ external

Gets the static context components that control the the namespace bindings that are assigned when an existing element node is copied by an element constructor.
default-collation () as xs:string external

Gets one of statically known collations 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

Gets the statically known default collection type.
default-function-namespace () as xs:string external

Gets the URI of the default function namespace.
default-order () as xs:string external

Gets the component that 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

Gets the list of annotations declared for the given function.
function-arguments-count ($function as xs:QName) as xs:int* external

Gets the number of arguments the given XQuery function takes.
function-names () as xs:QName* external

Gets a sequence containing the QNames of all defined functions that are available to be called from within an expression.
functions () as object()* external

Gets a sequence of JSON objects containing the name, arity, and annotations of all defined functions that are available to be called form within an expression.
in-scope-attribute-declarations () as xs:QName* external

Gets a sequence of QNames identifying declared attributes in the imported schemas.
in-scope-attribute-groups () as xs:QName* external

Gets a sequence of QNames identifying declared in-scope schema attribute groups.
in-scope-element-declarations () as xs:QName* external

Gets a sequence of QNames identifying declared elements in the imported schemas.
in-scope-element-groups () as xs:QName* external

Gets a sequence of QNames identifying declared in-scope schema element groups.
in-scope-schema-types () as xs:QName* external

Gets 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

Gets a sequence of QNames identifying declared variables from the static context.
option ($name as xs:QName) as xs:string? external

Gets the value of an option that is declared in the prolog of the module.
ordering-mode () as xs:string external

Gets the ordering mode that affects the ordering of the result sequences returned by certain expressions.
statically-known-collations () as xs:anyURI* external

Gets a sequence that contains the statically known collations.
statically-known-document-type ($document as xs:string) as xs:QName external

For the given document, returns the static type of its root node.
statically-known-documents () as xs:anyURI* external

Gets a sequence that contains the URIs of all statically known documents.
statically-known-namespace-binding ($prefix as xs:string) as xs:string? external

Gets the bound URI for the given prefix.
statically-known-namespaces () as xs:string* external

Gets a list of known statically known namespaces as prefixes (fn, xml, xs, xsi, etc).
xpath10-compatibility-mode () as xs:boolean external

Gets true or false depending on whether rules for compatibility with XPath 1.

Functions

base-uri#0

declare  function sctx:base-uri() as xs:string? external
Gets the base URI.

Parameters

Returns

xs:string?
The base URI.

boundary-space-policy#0

declare  function sctx:boundary-space-policy() as xs:string external
Gets the boundary whitespace policy used by direct element constructors.

Parameters

Returns

xs:string
Either preserve or strip.

construction-mode#0

declare  function sctx:construction-mode() as xs:string external
Gets the static context construction mode of element and document nodes.

Parameters

Returns

xs:string
Either preserve or strip.

copy-namespaces-mode#0

declare  function sctx:copy-namespaces-mode() as xs:string+ external
Gets the static context components that control the the namespace bindings that are assigned when an existing element node is copied by an element constructor.

Parameters

Returns

xs:string+
A sequence of two strings: the first is either preserve or no-preserve and the second is either inherit or no-inherit.

default-collation#0

declare  function sctx:default-collation() as xs:string external
Gets one of statically known collations used by functions and operators for comparing and ordering values of type xs:string or xs:anyURI when no explicit collation is specified.

Parameters

Returns

xs:string
The collations that is used by default.

default-collection-type#0

declare  function sctx:default-collection-type() as xs:string external
Gets 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.

Parameters

Returns

xs:string
The type of the default collection.

default-function-namespace#0

declare  function sctx:default-function-namespace() as xs:string external
Gets the URI of the default function namespace.

Parameters

Returns

xs:string
The URI of the of the default function namespace.

default-order#0

declare  function sctx:default-order() as xs:string external
Gets the component that controls the processing of empty sequences and NaN values as ordering keys in an order by clause in a FLWOR expression.

Parameters

Returns

xs:string
Either greatest or least.

function-annotations#2

declare  function sctx:function-annotations($name as xs:QName, $arity as xs:integer) as xs:QName* external
Gets the list of annotations declared for the given function.

Parameters

name as xs:QName
The name of the function.
arity as xs:integer
The number of arguments the function takes.

Returns

xs:QName*
the list of annotations

function-arguments-count#1

declare  function sctx:function-arguments-count($function as xs:QName) as xs:int* external
Gets the number of arguments the given XQuery function takes.

Parameters

function as xs:QName
A QName identifying a function.

Returns

xs:int*
Either a sequence of zero or more integers (one for each overloaded version of the given function) or an empty sequence if the function is not defined.

function-names#0

declare  function sctx:function-names() as xs:QName* external
Gets a sequence containing the QNames of all defined functions that are available to be called from within an expression.

Parameters

Returns

xs:QName*
A sequence for QNames identifying all functions.

functions#0

declare  function sctx:functions() as object()* external
Gets a sequence of JSON objects containing the name, arity, and annotations of all defined functions that are available to be called form within an expression.

Parameters

Returns

object()*
A sequence of objects.

in-scope-attribute-declarations#0

declare  function sctx:in-scope-attribute-declarations() as xs:QName* external
Gets a sequence of QNames identifying declared attributes in the imported schemas.

Parameters

Returns

xs:QName*
A sequence of QNames, one for each attribute.

in-scope-attribute-groups#0

declare  function sctx:in-scope-attribute-groups() as xs:QName* external
Gets a sequence of QNames identifying declared in-scope schema attribute groups.

Parameters

Returns

xs:QName*
A sequence of QNames, one for each attribute group.

in-scope-element-declarations#0

declare  function sctx:in-scope-element-declarations() as xs:QName* external
Gets a sequence of QNames identifying declared elements in the imported schemas.

Parameters

Returns

xs:QName*
A sequence of QNames, one for each declared element.

in-scope-element-groups#0

declare  function sctx:in-scope-element-groups() as xs:QName* external
Gets a sequence of QNames identifying declared in-scope schema element groups.

Parameters

Returns

xs:QName*
A sequence of QNames, one for each element group.

in-scope-schema-types#0

declare  function sctx:in-scope-schema-types() as xs:QName* external
Gets a sequence of QNames identifying in-scope schema types including all the predefined schema types and all definitions found in imported schemas.

Parameters

Returns

xs:QName*
A sequence of QNames, one for each defined type.

in-scope-variables#0

declare  function sctx:in-scope-variables() as xs:QName* external
Gets a sequence of QNames identifying declared variables from the static context.

Parameters

Returns

xs:QName*
A sequence of QNames, one for each variable.

option#1

declare  function sctx:option($name as xs:QName) as xs:string? external
Gets the value of an option that is declared in the prolog of the module.

Parameters

name as xs:QName
the name of the option value to retrieve

Returns

xs:string?
the value of the option if contained in the static context or the empty sequence otherwise.

ordering-mode#0

declare  function sctx:ordering-mode() as xs:string external
Gets the ordering mode that affects the ordering of the result sequences returned by certain expressions.

Parameters

Returns

xs:string
Either ordered or unordered.

statically-known-collations#0

declare  function sctx:statically-known-collations() as xs:anyURI* external
Gets a sequence that contains the statically known collations.

Parameters

Returns

xs:anyURI*
The sequence of collations.

statically-known-document-type#1

declare  function sctx:statically-known-document-type($document as xs:string) as xs:QName external
For the given document, returns the static type of its root node.

Parameters

document as xs:string
A URI of a document.

Returns

xs:QName
The static type of the given document.

statically-known-documents#0

declare  function sctx:statically-known-documents() as xs:anyURI* external
Gets a sequence that contains the URIs of all statically known documents.

Parameters

Returns

xs:anyURI*
The sequence of document URIs.

statically-known-namespace-binding#1

declare  function sctx:statically-known-namespace-binding($prefix as xs:string) as xs:string? external
Gets the bound URI for the given prefix.

Parameters

prefix as xs:string
The prefix of the known namespace for which the bound URI is being requested.

Returns

xs:string?
The URI bound to the prefix is returned, or an empty sequence if the prefix is not known.

statically-known-namespaces#0

declare  function sctx:statically-known-namespaces() as xs:string* external
Gets a list of known statically known namespaces as prefixes (fn, xml, xs, xsi, etc).

Parameters

Returns

xs:string*
A sequence of xs:strings, one for each known namespace prefix.

xpath10-compatibility-mode#0

declare  function sctx:xpath10-compatibility-mode() as xs:boolean external
Gets 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.

Parameters

Returns

xs:boolean
The function should return false.