pdk.flow.xml.XmlDocument
contains functions to operate with XML Document variables
Last updated
contains functions to operate with XML Document variables
Last updated
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a , this package contains functions needed to create these objects.
ATTRIBUTE_NODE
DOCUMENT_FRAGMENT_NODE
The descendants of the source node are recursively adopted.
DOCUMENT_NODE
DOCUMENT_TYPE_NODE
ELEMENT_NODE
Specified attribute nodes of the source element are adopted. Default attributes are discarded, though if the document being adopted into defines default attributes for this element name, those are assigned. The descendants of the source element are recursively adopted.
ENTITY_NODE
Entity nodes cannot be adopted.
ENTITY_REFERENCE_NODE
NOTATION_NODE
Notation nodes cannot be adopted.
PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
These nodes can all be adopted. No specifics.
Arguments:
Result:
Possible exceptions
Example:
XML Document
Source node
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Node.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName
local name, extracted from qualifiedName
Attr.name
qualifiedName
Node.nodeValue
the empty string
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Node.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName
local name, extracted from qualifiedName
Element.tagName
qualifiedName
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
This is a convenience attribute that allows direct access to the child node that is the document element of the document.
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
Arguments:
Result:
Possible exceptions
The imported node copies its target and data values from those of the source node.Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
Arguments:
Result:
Possible exceptions
Example
XML Document One
XML Document Two
XML Document Three
Arguments:
Result:
no output. Document was normalized
Possible exceptions
a user data event NODE_RENAMED is fired,
when the implementation supports the feature "MutationNameEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event { http://www.w3.org/2001/xml-events, DOMElementNameChanged} or { http://www.w3.org/2001/xml-events, DOMAttributeNameChanged} is fired.
Arguments:
Result:
Possible exceptions
Arguments:
Result:
no output
Possible exceptions
Arguments:
Result:
no output
Possible exceptions
Arguments:
Result:
no output
Possible exceptions
Arguments:
Result:
no output
Possible exceptions
Attempts to adopt a node from another document to the input document. If supported, it changes the ownerDocument of the source node, its children, as well as the attached attribute nodes if there are any. If the source node has a parent it is first removed from the child list of its parent. This effectively allows moving a subtree from one document to another (unlike which create a copy of the source node instead of moving it). When it fails, applications should use instead. Note that if the adopted node is already part of this document (i.e. the source and target document are the same), this method still has the effect of removing the source node from the child list of its parent, if any. The following list describes the specifics for each type of node.
The ownerElement attribute is set to null and the specified flag is set to true on the adopted . The descendants of the source are recursively adopted.
nodes cannot be adopted.
nodes cannot be adopted.
Only the node itself is adopted, the descendants are discarded, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
Since it does not create new nodes unlike the function, this function does not raise an INVALID_CHARACTER_ERR exception, and applications should use the function to check if an imported name is not an XML name according to the XML version in use.
document :: - The document
source :: - The node to move into the document
output :: - The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.
- throws if the document or source is NULL
- NOT_SUPPORTED_ERR: Raised if the source node is of type , .
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.
Creates an of the given name. Note that the instance can then be set on an using the function. To create an attribute with a qualified name and namespace URI, use the function.
document :: - The document
name :: - The name of the attribute
output :: - A new object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null. The value of the attribute is the empty string.
- throws if the document or name is NULL
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the .
Creates an attribute of the given qualified name and namespace URI.
Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
document :: - The document
namespaceURI :: - The namespace URI of the attribute to create
qualifiedName :: - The qualified name of the attribute to instantiate
output :: - A new object with the following attributes:
- throws if the document is NULL
- INVALID_CHARACTER_ERR: Raised if the specified qualifiedName is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "", if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "", or if the namespaceURI is "" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
Creates a node whose value is the specified string.
document :: - The document
data :: - The data for the contents.
output :: - The new variable.
- throws if the document or data is NULL
- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Creates a node given the specified string.
document :: - The document
data :: - The data for the node
output :: - The new variable.
- throws if the document or data is NULL
Creates an empty object.
document :: - The document
output :: - The new variable.
- throws if the document is NULL
Creates an element of the type specified. Note that the variable returned has superstructure, so attributes can be specified directly on the returned object. In addition, if there are known attributes with default values, nodes representing them are automatically created and attached to the element. To create an element with a qualified name and namespace URI, use the method.
document :: - The document
tagName :: - The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup by the DOM implementation.
output :: - A new object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.
- throws if the document or tagName is NULL
Creates an element of the given qualified name and namespace URI.
Per [] , applications must use the value null as the namespaceURI parameter for functions if they wish to have no namespace.
document :: - The document
namespaceURI :: - The namespace URI of the element to create
qualifiedName :: - The qualified name of the element to instantiate
output :: - A new object with the following attributes:
- throws if the document is NULL
- INVALID_CHARACTER_ERR: Raised if the specified qualifiedName is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "" [] , or if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "", or if the namespaceURI is "" and neither the qualifiedName nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
Creates an object. In addition, if the referenced entity is known, the child list of the node is made the same as that of the corresponding Entity node.
If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created node is also unbound; (its namespaceURI is null). The DOM Level 2 and 3 do not support any mechanism to resolve namespace prefixes in this case.
document :: - The document
name :: - The name of the entity to reference. Unlike or , no namespace well-formed checking is done on the entity name. Applications should invoke with the parameter " namespaces" set to true in order to ensure that the entity name is namespace well-formed.
output :: - The new
- throws if the document or name is NULL
Creates a node given the specified name and data strings.
document :: - The document
name :: - The target part of the processing instruction. Unlike or , no namespace well-formed checking is done on the target name. Applications should invoke with the parameter " namespaces" set to true in order to ensure that the target name is namespace well-formed.
data :: - The data for the node
output :: - The new
- throws if the document is NULL
- INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in the attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
Creates a node given the specified string.
document :: - The document
data :: - The data for the node
output :: - The new variable.
- throws if the document or data is NULL
The Document Type Declaration (see ) associated with this document. For XML documents without a document type declaration this returns null. For HTML documents, a object may be returned, independently of the presence or absence of document type declaration in the HTML document.
This provides direct access to the node, child node of this . This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such as , or . Note, however, that while some implementations may instantiate different types of objects supporting additional features than the "Core", such as "HTML" [] , based on the specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.
document :: - The document
output :: - The new variable.
- throws if the document is NULL
document :: - The document
output ::
- throws if the document is NULL
The location of the document or null if undefined or if the was created using . No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI .
Beware that when the supports the feature "HTML" [] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.
document :: - The document
output ::
- throws if the document is NULL
The configuration used when is invoked.
document :: - The document
output ::
- throws if the document is NULL
Returns the that has an ID attribute with the given value. If no such element exists, this returns null . If more than one element has an ID attribute with that value, what is returned is undefined.
The DOM implementation is expected to use the attribute to determine if an attribute is of type ID.
document :: - The document
elementId :: - The unique id value for an element
output :: - The matching element or null if there is none.
- throws if the document or elementId is NULL
Returns a <> of all the in document order with a given tag name and are contained in the document.
document :: - The document
tagname :: - The name of the tag to match on. The special value "*" matches all tags. For XML, the tagname parameter is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use.
output :: <> - A new array containing all the matched . ( structure )
- throws if the document or tagname is NULL
Returns a <> of all the with a given local name and namespace URI in document order.
document :: - The document
namespaceURI :: - The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName :: - The local name of the elements to match on. The special value "*" matches all local names.
output :: <> - A new array containing all the matched . ( structure )
- throws if the document or namespaceURI or localName is NULL
The object that handles this document. A DOM application may use objects from multiple implementations.
document :: - The document
output ::
- throws if the document is NULL
An attribute specifying the encoding used for this document at the time of the parsing. This is null when it is not known, such as when the was created in memory.
document :: - The document
output ::
- throws if the document is NULL
An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any on DOM operations or report errors while using . In case of error, the behavior is undefined. This attribute is true by default.
document :: - The document
output ::
- throws if the document is NULL
An attribute specifying, as part of the , the encoding of this document. This is null when unspecified or when it is not known, such as when the was created in memory.
document :: - The document
output ::
- throws if the document is NULL
An attribute specifying, as part of the , whether this document is standalone. This is false when unspecified.
No verification is done on the value when setting this attribute. Applications should use with the "validate" parameter to verify if the value matches the as defined in [].
document :: - The document
output ::
- throws if the document is NULL
An attribute specifying, as part of the , the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke in order to check for invalid characters in the that are already part of this .
DOM applications may use the function with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports []. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports []. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using .
document :: - The document
output ::
- throws if the document is NULL
Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source node. The returned node has no parent; (parentNode is null).
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the operation, the source node is not altered. User data associated to the imported node is not carried over.
Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.
The ownerElement attribute is set to null and the specified flag is set to true on the generated . The descendants of the source are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on nodes; they always carry their children with them when imported.
If the deep option was set to true, the descendants of the source are recursively imported and the resulting nodes reassembled under the imported to form the corresponding subtree. Otherwise, this simply generates an empty .
nodes cannot be imported.
nodes cannot be imported.
Specified attribute nodes of the source element are imported, and the generated nodes are attached to the generated . Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode deep parameter was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
Entity nodes can be imported, however in the current release of the DOM the is readonly. Ability to add these imported nodes to a will be considered for addition to a future release of the DOM.On import, the publicId, systemId, and notationName attributes are copied. If a deep import is requested, the descendants of the the source Entity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
Only the itself is copied, even if a deep import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
Notation nodes can be imported, however in the current release of the DOM the is readonly. Ability to add these imported nodes to a will be considered for addition to a future release of the DOM.On import, the publicId and systemId attributes are copied. Note that the deep parameter has no effect on this type of nodes since they cannot have any children.
These three types of nodes inheriting from copy their data and length attributes from those of the source node.Note that the deep parameter has no effect on these types of nodes since they cannot have any children.
document :: - The document
importedNode :: - The node to import
deep :: - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on nodes that cannot have any children, and on , and nodes.
output :: - The imported node that belongs to the input .
- throws if the document or importedNode is NULL
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
INVALID_CHARACTER_ERR: Raised if one of the imported names is not an XML name according to the XML version in use specified in the attribute. This may happen when importing an XML 1.1 [] element into an XML 1.0 document, for instance.
This function acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree of nodes and normalizes nodes, as defined in the method . Otherwise, the actual result depends on the features being set on the object and governing what operations actually take place. Noticeably this method could also make the document namespace well-formed according to the algorithm described in , check the character normalization, remove the nodes, etc. See for details.
document :: - The document
- throws if the document NULL
Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below.
If simply changing the name of the given node is not possible, the following operations are performed: a new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is an its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attached to the new node.
When the node being renamed is an only the specified attributes are moved, default attributes originated from the DTD are updated according to the new element name. In addition, the implementation may update default attributes from other schemas. Applications should use to guarantee these attributes are up-to-date.
When the node being renamed is an that is attached to an , the node is first removed from the attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
In addition,
document :: - The document
node :: - The node to rename
namespaceURI :: - The new namespace URI
qualifiedName :: - The new qualified name
output :: - The renamed node. This is either the specified node or the new node that was created to replace the specified node.
- throws if the document NULL
- NOT_SUPPORTED_ERR: Raised when the type of the specified node is neither ELEMENT_NODE nor ATTRIBUTE_NODE, or if the implementation does not support the renaming of the document element.
INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "" [] . Also raised, when the node being renamed is an attribute, if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from "".
The location of the document or null if undefined or if the was created using . No lexical checking is performed when setting this attribute; this could result in a null value returned when using .
Beware that when the supports the feature "HTML" [] , the href attribute of the HTML BASE element takes precedence over this attribute when computing .
document :: - The document
documentURI ::
- throws if the document or documentURI isNULL
An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any on DOM operations or report errors while using . In case of error, the behavior is undefined. This attribute is true by default.
document :: - The document
strictErrorChecking ::
- throws if the document or strictErrorChecking isNULL
An attribute specifying, as part of the , whether this document is standalone. This is false when unspecified.
No verification is done on the value when setting this attribute. Applications should use with the "validate" parameter to verify if the value matches the as defined in [].
document :: - The document
xmlStandalone ::
- throws if the document or strictErrorChecking isNULL
- NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.
Set an attribute specifying, as part of the , the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke in order to check for invalid characters in the that are already part of this .
DOM applications may use the function with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports []. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports []. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using .
document :: - The document
xmlVersion ::
- throws if the document or xmlVersion isNULL
- NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by the input or if this document does not support the "XML" feature.