All Classes and Interfaces
Class
Description
F&O 3.1 array:append — returns a new array with one additional member (the appendage sequence).
XPath and XQuery Functions and Operators 3.1
array:filter:
array:filter($array as array(*), $predicate as function(item()*) as xs:boolean) as array(*).XPath and XQuery Functions and Operators 3.1
array:for-each:
array:for-each($array as array(*), $action as function(item()*) as item()*) as array(*).XPath and XQuery Functions and Operators 3.1
array:for-each-pair:
array:for-each-pair($array1 as array(*), $array2 as array(*), $function as function(item()*, item()*) as item()*) as array(*).F&O 3.1 array:join — concatenates the members of a sequence of arrays in order into one array.
F&O 3.1 array:put — returns a new array with the member at a 1-based position replaced
by a given sequence (FOAY0001 if position is out of bounds).
F&O 3.1 array:remove — returns a new array with members at the given 1-based positions omitted
(distinct positions; order preserved).
XPath and XQuery Functions and Operators 3.1
array:sort:
array:sort($array), array:sort($array, $collation?),
array:sort($array, $collation?, $key).Atom-only
fn:deep-equal behavior shared by op:same-key (FO 3.1, section 17.1.1)
and sequence fn:deep-equal for non-node, non-array items.This class describes all the primitive built-in atomic types in the JSONiq data model.
Expression representing text content within XML attribute values.
Runtime iterator for attribute node content.
Expression representing an attribute node in a direct element constructor.
Class representing attribute() and attribute(QName) item types.
Runtime iterator for attribute nodes in a direct element constructor.
Exception for XQTY0024: It is a type error if the content sequence in an element constructor
contains an attribute node or a namespace node following a node that is not an attribute or namespace node.
Implementation of the fn:base-uri function according to XPath and XQuery Functions and Operators 3.1
(
https://www.w3.org/TR/xpath-functions-31/#func-base-uri) and the XDM 3.1 base-uri accessor.Special enum type to specify diverse range of execution modes for built-in functions
These are only used to generate the corresponding (standard) execution modes while generating iterators
Resolves
ExecutionMode for a builtin from its catalogue metadata and the first argument mode.Dynamic invocation of a function item that represents a builtin named function reference.
Placeholder body iterator for
FunctionItems that represent
a builtin named function reference (fn:abs#1).Legal values for the
cardinality fundamental facet per
XSD 1.1 Part 2 §4.2.3.This is a clause, which is a component of a FLWOR expression.
An expression representing a computed comment constructor.
Runtime iterator for computed comment node constructors.
XQuery 3.1 Section 2.5.5 - SequenceType Matching
CommentTest ::= "comment" "(" ")"
A CommentTest matches any comment node.
Visitor checks rules for composing statements based on sequential properties
or nesting (e.g., break statements).
Expression representing a computed attribute constructor.
Runtime iterator for computed attribute constructors.
Expression representing a computed element constructor.
Runtime iterator for computed element constructors.
Expression representing a computed namespace constructor.
Runtime iterator for computed namespace constructors.
Expression representing a computed processing instruction constructor.
Runtime iterator for computed processing instruction constructors.
Constraining facet kinds per XSD 1.1 Part 2 §4.3.
This class exposes a reusable context that is dynamically populated from the input tuples stored in DataFrames.
An expression representing a direct comment constructor.
Runtime iterator for direct comment node constructors.
Expression representing a direct element constructor.
Runtime iterator for direct element constructors.
Expression representing a direct processing instruction constructor.
Runtime iterator for direct processing instruction constructors.
The `DocFunctionIterator` class implements the `doc` function from XQuery.
An expression representing a document node constructor.
Runtime iterator for document node constructors.
Class representing document-node() and document-node(element(...)) item types.
Implementation of the fn:document-uri function according to XPath and XQuery Functions and Operators 3.1
(
https://www.w3.org/TR/xpath-functions-31/#func-document-uri) and the XDM 3.1 document-uri accessor.Exception for XQDY0025: It is a dynamic error if any attribute of a constructed element
does not have a name that is distinct from the names of all other attributes of the constructed element.
Dynamic context visitor.
Class representing element() and element(QName) item types.
Metadata for error reporting (line and column number)
Static context visitor implements a multi-pass algorithm that enables function hoisting
An expression is the first-class citizen in JSONiq syntax.
An ExpressionClassification classifies an expression under 4 possible classifications.
Facets class represent a container with the ability to get and set facets and is intended to be a mutable proxy that
will be passed to a DerivedAtomicType to indicate the specified facets
Shared argument arity checks and type-promotion wrapping for dynamic calls on
FunctionItems.Construction helpers for
FunctionItem values used by the runtime.FOTY0014: no string value for maps, arrays, or function items (e.g.
fn:function-lookup($name as xs:QName, $arity as xs:integer) as function(*)?
Fundamental facet kinds per
XSD 1.1 Part 2 §4.2.
This visitor infers a static SequenceType for each expression in the query
Implementation of fn:in-scope-prefixes according to
XPath and XQuery Functions and Operators 3.1, Section 14.1.
Exception for XQDY0072: computed comment constructor content contains illegal hyphen sequences.
Exception for XQDY0101: It is a dynamic error if a computed namespace constructor attempts to do any of the
following:
- Bind the prefix xml to some namespace URI other than http://www.w3.org/XML/1998/namespace
- Bind a prefix other than xml to the namespace URI http://www.w3.org/XML/1998/namespace
- Bind the prefix xmlns to any namespace URI
- Bind a prefix to the namespace URI http://www.w3.org/2000/xmlns/
- Bind any prefix (including the empty prefix) to a zero-length namespace URI
Exception for SEPM0016: It is an error if a parameter value is invalid for the defined domain.
An instance of this class is an item in the JSONiq data model.
Class representing the generic 'item' item type
This class provides an empty implementation of
JsoniqVisitor,
which can be extended to create a visitor which only needs to handle a subset
of the available methods.This interface defines a complete generic visitor for a parse tree produced
by
JsoniqParser.Class representing the generic 'item' item type
Static context visitor implements a multi-pass algorithm that enables function hoisting
XPath/XQuery
op:same-key for map keys (atomic values), per FO 3.1 section 17.1.1.XQuery 3.1 map constructor:
map { key : value, ... }.XQuery 3.1 map constructor: atomized single-atomic keys and general- sequence values.
XPath/XQuery map:contains($map, $key) implementation.
W3C XPath/XQuery
map:entry:
atomizes a single key into exactly one atomic value
materializes the value into a general sequence (possibly empty)
returns a map containing a single key/value binding
FO 3.1 map:find($input as item()*, $key as xs:anyAtomicType) as array(*).
FO 3.1 map:for-each($map as map(*), $action as function(xs:anyAtomicType, item()*) as item()*)
as item()*.
Dynamic function call when the function item is an XDM map (
$map($key)), equivalent to map:get.W3C XPath/XQuery
map:get:
requires exactly one map argument
atomizes the key and requires exactly one atomic value
returns the associated value sequence, if present
This built-in is local execution only (consistent with map/array accessors).XQuery/XPath map item type: map(*) and map(K, V) per XDM 3.1 / XPath 3.1.
W3C XPath/XQuery
map:keys:
requires exactly one map argument
returns the atomic keys present in the map
This built-in is local execution only (consistent with map/array accessors).W3C XPath/XQuery
map:merge:W3C XPath/XQuery
map:put:
requires exactly one map argument
atomizes the key and requires exactly one atomic value
returns a new map with the entry added or replaced (key equivalence via op:same-key)
This built-in is local execution only.W3C XPath/XQuery
map:remove:
map:remove($map as map(*), $keys as xs:anyAtomicType*) as map(*).Hash/equals wrapper for map keys compatible with
op:same-key.W3C map:size function.
This visitor removes duplicate module import, by depopulating variable and function declarations upon
duplicate visits.
This class represents expanded names, corresponding to QNames in the W3C XQuery standard.
Resolves a
FunctionIdentifier against user-defined and built-in named functions in the dynamic context.Resolves a namespace prefix (including
"" for the default element/type namespace) to a URI,
or null if unbound.Namespace declaration in a direct element constructor start tag.
Exception for XQST0022: It is a static error if a namespace declaration attribute contains an enclosed expression.
XQuery 3.1 Section 2.5.5 - SequenceType Matching
NamespaceNodeTest ::= "namespace-node" "(" ")"
A NamespaceNodeTest matches any namespace node.
This class describes the context of a native clause and is used when processing FLWOR expressions without UDF
Neutral element ItemType for aggregation operations.
Implementation of the fn:nilled function according to XPath and XQuery Functions and Operators 3.1
(
https://www.w3.org/TR/xpath-functions-31/#func-nilled) and the XDM 3.1 nilled accessor.This is the top-level class for nodes in the intermediate representation of a
JSONiq query.
An expression that represents a node comparison.
Runtime iterator for node comparisons.
Class representing the abstract node() item type.
Implementation of the fn:name function according to XQuery 3.1 specification.
Implementation of the fn:node-name function according to XPath and XQuery Functions and Operators 3.1
(
https://www.w3.org/TR/xpath-functions-31/#func-node-name) and the XDM 3.1 node-name accessor.Legal values for the
ordered fundamental facet per
XSD 1.1 Part 2 §4.2.1.Class representing processing-instruction() and processing-instruction(N) item types.
XQuery 3.1 Section 2.5.5 - SequenceType Matching
PITest ::= "processing-instruction" "(" (NCName | StringLiteral)?
Spark closure for postfix lookup with XQuery 3.1 semantics: array index out of bounds
raises err:FOAY0001 (propagated from
ArrayIndexOutOfBoundsException).Postfix lookup with XQuery 3.1 semantics.
Exception for XQST0070: It is a static error if a namespace declaration attribute attempts to do any of the
following:
- Bind the prefix xml to some namespace URI other than http://www.w3.org/XML/1998/namespace
- Bind the prefix xmlns to any namespace URI
- Bind a prefix to the namespace URI http://www.w3.org/2000/xmlns/
A program is the first-class citizen in JSONiq scripting syntax.
fn:QName($paramURI as xs:string?, $paramQName as xs:string) as xs:QNameAtomic item representing an
xs:QName value as an expanded name (Name).Implementation based on W3C spec: ...
The entry point for Java applications that want to execute JSONiq queries with Rumble.
A sequence of items is the value returned by any expression in JSONiq, which is a set-based language.
Helper class to configure and materialize the output of a
SequenceOfItems.This visitor is used to classify expressions into sequential/non-sequential.
Builder class for constructing and updating SerializationParameters from string parameters.
Default serialization parameters stored in the XQuery static context.
Shared helpers for
Serializer implementations (map serialization, DM node names).Lexicographic comparison of sort-key sequences for F&O 3.1
fn:sort / array:sort
(deep-less-than and fn:deep-equal on key sequences with a collation).Static context visitor implements a multi-pass algorithm that enables function hoisting
This is a helper class that organizes the children expressions of a switch expression.
Helper class that organizes children statements of a switch statement.
An expression representing a text node constructor.
Runtime iterator for text node constructors.
An expression representing a text node, as part of a direct element constructor content.
Runtime iterator for text nodes in a direct element constructor.
Translation is the phase in which the Abstract Syntax Tree is transformed
into an Expression Tree, which is a JSONiq intermediate representation.
This is a helper class that organizes the children expressions of a typeswitch expression.
This is a helper class that organizes the children statements of a TypeSwitchStatement.
Unary lookup with XQuery 3.1 semantics.
This visitor resolves dependencies between variable and function declarations.
Represents the three legal values of the
whiteSpace constraining facet
as defined in XSD 1.1 Part 2, Section 4.3.6.The `XMLDocumentPosition` class represents the position of an item within an XML document.
Class representing a concrete XML node item type at depth 2 in the type hierarchy.
XQuery/XPath array item type: array(*) and array(T) per XDM 3.1 / XPath 3.1.
This class provides an empty implementation of
XQueryParserVisitor,
which can be extended to create a visitor which only needs to handle a subset
of the available methods.This interface defines a complete generic visitor for a parse tree produced
by
XQueryParser.Translation is the phase in which the Abstract Syntax Tree is transformed
into an Expression Tree, which is a JSONiq intermediate representation.