Module : lang.xml

Module Overview

This module provides lang library operations on xml values defined by the language specification 2019R2.

Objects

$anonType$9

Functions

appendChildren

Append children to an XML if its an element type XML. Error otherwise. New children will be appended at the end of the existing children.

concat

Concatenate all the xs. Empty xml sequence if empty.

copy

Make a deep copy of an XML.

createComment

Creates a comment with the specified content.

createElement

Creates an element with the specified children The attributes are empty initially

createProcessingInstruction

Creates a processing instruction with the specified target and content.

elements

Get all the items that are of element type in an XML sequence.

filter

For xml sequence returns a new xml sequence constructed from children of x for which func returns true. For xml element returns a new xml sequence constructed from x if x applied to funct returns true, else returns an empty sequence.

forEach

For xml sequence apply the func to children of item. For xml element apply the func to item.

fromString

This is the inverse of value:toString applied to an xml.

getAttributes

Returns the map representing the attributes of elem. This includes namespace attributes. The keys in the map are the expanded name of the attribute. Panics if isElement(elem) is not true. There is no setAttributes function.

getChildren

Returns the children of elem. Panics if isElement(elem) is not true.

getContent

Returns the content of a text or processing instruction or comment item.

getElementName

Get the fully qualified name of the element as a string. Returns an empty string if the XML is not a singleton.

getItemType

Get the type of a XML as a string. If the XML is singleton, type can be one of 'element', 'text', 'comment' or 'pi'. Returns an empty string if the XML is not a singleton.

getName

Returns a string giving the expanded name of elem.

getTarget

Returns the target part of the processing instruction.

getTextValue

Get the text value of a XML. If the XML is a sequence, concatenation of the text values of the members of the sequence is returned. If the XML is an element, then the text value of the sequence of children is returned. If the XML is a text item, then the text is returned. Otherwise, an empty string is returned.

isComment

Returns true if x is a singleton xml sequence consisting of a comment item.

isElement

Returns true if x is a singleton xml sequence consisting of an element item.

isEmpty

Check whether the XML sequence is empty.

isProcessingInstruction

Returns true if x is a singleton xml sequence consisting of a processing instruction item.

isSingleton

Check whether the XML sequence contains only a single element.

isText

Returns true if x is an xml sequence consisting of one or more character items.

iterator

Returns an iterator over the xml items of x

length

Returns number of XML items in x.

map

For xml sequence returns the result of applying function func to each member of sequence item. For xml element returns the result of applying function funct to item.

removeAttribute

Remove an attribute from an XML.

removeChildren

Remove children matching the given name from an XML. This operation has no effect if the XML is not an element type XML.

select

Get all the items that are of element type, and matches the given qualified name, in an XML sequence.

selectDescendants

Searches in children recursively for elements matching the qualified name and returns a sequence containing them all. Does not search within a matched result.

setAttributes

Sets the attributes to the provided attributes map.

setChildren

Sets the children of elem to children. Panics if isElement(elem) is not true.

setName

Change the name of element elmem to xName.

slice

Slice and return a subsequence of the an XML sequence.

strip

Strips any text items from an XML sequence that are all whitespace.

Constants

XML_ELEMENT
XML_SEQUENCE
XML_TEXT
XML_COMMENT
XML_PI

Types

XMLType