pdk.flow.xml.XmlDocument

contains functions to operate with XML Document variables

This functions are based on Java org.w3c.dom package classes.

https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/package-summary.html

You can always rely on Java documentation and examples!

You can use functions from the pdk.floe.xml.XmlNode package for variables of type Document, as the pdk.net.xml.Document structure extends the pdk.net.xml.Node.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, this package contains functions needed to create these objects.

All functions

adoptNode

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 importNode which create a copy of the source node instead of moving it). When it fails, applications should use importNode 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.

  • ATTRIBUTE_NODE

    The ownerElement attribute is set to null and the specified flag is set to true on the adopted Attr. The descendants of the source Attr are recursively adopted.

  • DOCUMENT_FRAGMENT_NODE

    The descendants of the source node are recursively adopted.

  • DOCUMENT_NODE

    Document nodes cannot be adopted.

  • DOCUMENT_TYPE_NODE

    DocumentType nodes cannot be adopted.

  • 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

    Only the EntityReference 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.

  • 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.

Since it does not create new nodes unlike the importNode function, this function does not raise an INVALID_CHARACTER_ERR exception, and applications should use the normalizeDocument function to check if an imported name is not an XML name according to the XML version in use.

Arguments:

Result:

  • output :: pdk.net.xml.Node - The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.

Possible exceptions

Example:

XML Document

<order id="1">
</order>

Source node

<book id="b_1">
    Harry Potter and the Philosopher's Stone
</book>
document :: pdk.net.xml.Document
sourceNode :: pdk.net.xml.Node

XmlDocument.adoptNode(document, sourceNode) :: pdk.net.xml.Node ->
output -> adopted sourceNode
adoptedBookNode = output

//now we can add adopted sourceNode to elements inside document
XmlNode.getFirstChild(document) :: pdk.net.xml.Node -> // order node
output -> order node from the document
orderNode = output

// this would throw DOMException without node adoptation
XmlNode.appendChild(orderNode, adoptedBookNode) :: pdk.net.xml.Node ->
orderNode contains book node:
<order id="1">
  <book id="b_1">
    Harry Potter and the Philosopher's Stone
  </book>
</order>

createAttribute

Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the pdk.flow.xml.XmlElement.setAttributeNode function. To create an attribute with a qualified name and namespace URI, use the createAttributeNS function.

Arguments:

Result:

  • output :: pdk.net.xml.Attr - A new Attr 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.

Possible exceptions

Example:

XML Document

<order>
</order>
document :: pdk.net.xml.Document
name :: pdk.core.String = "id"

XmlDocument.createAttribute(document, name) :: pdk.net.xml.Attr ->
output -> adopted attr [id=""]
attr = output

//now we can add attr to "order" node
XmlDocument.getElementsByTagName​(document, "order") - >
orderElements :: Array = [order1]
orderElement :: Element = orderElements[0]

XmlElement.setAttributeNode(orderElement, attr) :: pdk.net.xml.Attr ->
output -> added id Attr
<order id="">
</order>

createAttributeNS

Creates an attribute of the given qualified name and namespace URI. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Arguments:

Result:

Attribute
Value

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

  • NullPointerException - throws if the document is NULL

  • DOMException - 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 " http://www.w3.org/XML/1998/namespace", if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" 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.

Example:

XML Document

<order>
</order>
document :: pdk.net.xml.Document
namespaceURI :: pdk.core.String = "http://www.w3.org/2000/xmlns/"
qualifiedName :: pdk.core.String = "http://www.w3.org/2000/xmlns:id"

XmlDocument.createAttributeNS(document, namespaceURI, qualifiedName) :: pdk.net.xml.Attr ->
output -> adopted attr [id=""]
attr = output

//now we can add attr to "order" node
XmlDocument.getElementsByTagName​(document, "order") - >
orderElements :: Array = [order1]
orderElement :: Element = orderElements[0]

XmlElement.setAttributeNode(orderElement, attr) :: pdk.net.xml.Attr ->
output -> added id Attr
<order id="">
</order>

createCDATASection

Creates a CDATASection node whose value is the specified string.

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order>
</order>
document :: pdk.net.xml.Document
data :: pdk.core.String = "<message>CDATA data</message>"

XmlDocument.createCDATASection(document, data) :: pdk.net.xml.CDATASection ->
output -> section
cdata = output

//now we can add attr to "order" node
XmlNode.getFirstChild(document) :: pdk.net.xml.Node -> // order node
output -> order node from the document
orderNode = output

XmlNode.appendChild(orderNode, cdata) :: pdk.net.xml.Node ->
orderNode contains cdata:
<order>
    <![CDATA[
        <message>CDATA data</message>
    ]] >
</order>

createComment

Creates a Comment node given the specified string.

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order>
</order>
document :: pdk.net.xml.Document
data :: pdk.core.String = "New comment"

XmlDocument.createComment(document, data) :: pdk.net.xml.Comment ->
output -> ["<!--New comment-->"]
comment = output

XmlNode.appendChild(document, comment) :: pdk.net.xml.Node ->
the document has comment
<order>
</order>
<!--New comment-->

createDocumentFragment

Creates an empty DocumentFragment object.

Arguments:

Result:

Possible exceptions

createElement

Creates an element of the type specified. Note that the variable returned has Element superstructure, so attributes can be specified directly on the returned object. In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element. To create an element with a qualified name and namespace URI, use the createElementNS method.

Arguments:

  • document :: pdk.net.xml.Document - The document

  • tagName :: pdk.core.String - 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.

Result:

  • output :: pdk.net.xml.Element - A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.

Possible exceptions

Example:

XML Document

<order>
</order>
document :: pdk.net.xml.Document
tagName :: pdk.core.String = "order"

XmlDocument.createElement(document, data) :: pdk.net.xml.Element ->
output -> [<order></order>]
order = output

XmlNode.appendChild(document, order) :: pdk.net.xml.Node ->
the document has one more order
<order>
</order>
<order>
</order>

createElementNS

Creates an element of the given qualified name and namespace URI. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for functions if they wish to have no namespace.

Arguments:

Result:

Attribute
Value

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

  • NullPointerException - throws if the document is NULL

  • DOMException - 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 " http://www.w3.org/XML/1998/namespace" [XML Namespaces] , or if the qualifiedName or its prefix is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI is "http://www.w3.org/2000/xmlns/" 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.

createEntityReference

Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference 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 EntityReference 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.

Arguments:

Result:

Possible exceptions

createProcessingInstruction

Creates a ProcessingInstruction node given the specified name and data strings.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the document is NULL

  • DOMException - INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in the getXmlVersion attribute. NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createTextNode

Creates a Text node given the specified string.

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order>
</order>
document :: pdk.net.xml.Document
data :: pdk.core.String = "New text"

XmlDocument.createText(document, data) :: pdk.net.xml.Text ->
output -> ["New text"]
text = output

//now we can add text to "order" node
XmlNode.getFirstChild(document) :: pdk.net.xml.Node -> // order node
output -> order node from the document
orderNode = output

XmlNode.appendChild(orderNode, text) :: pdk.net.xml.Node ->
orderNode contains text node:
<order>
    New text
</order>

getDoctype

The Document Type Declaration (see DocumentType) associated with this document. For XML documents without a document type declaration this returns null. For HTML documents, a DocumentType object may be returned, independently of the presence or absence of document type declaration in the HTML document. This provides direct access to the DocumentType node, child node of this Document. This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such as XmlNode.insertBefore, or XmlNode.replaceChild. Note, however, that while some implementations may instantiate different types of Document objects supporting additional features than the "Core", such as "HTML" [DOM Level 2 HTML] , based on the DocumentType specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.

Arguments:

Result:

Possible exceptions

getDocumentElement

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

getDocumentURI

The location of the document or null if undefined or if the Document was created using XmlDOMImplementation.createDocument. 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 Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.

Arguments:

Result:

Possible exceptions

getDomConfig

The configuration used when normalizeDocument is invoked.

Arguments:

Result:

Possible exceptions

getElementById

Returns the Element 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 XmlAttr.isId to determine if an attribute is of type ID.

Attributes with the name "ID" or "id" are not of type ID unless so defined.

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order>
    <book id="1"></book>
</order>
document :: pdk.net.xml.Document
elementId :: pdk.core.String = "1"

XmlDocument.getElementById(document, data) :: pdk.net.xml.Element ->
output -> [<book id="1"></book>]

getElementsByTagName

Returns a Array<Element> of all the Elements in document order with a given tag name and are contained in the document.

Arguments:

  • document :: pdk.net.xml.Document - The document

  • tagname :: pdk.core.String - 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.

Result:

Possible exceptions

Example:

XML Document

<order>
    <book id="1"></book>
    <book id="2"></book>
</order>
document :: pdk.net.xml.Document
tagname :: pdk.core.String = "book"

XmlDocument.getElementsByTagName(document, data) :: Array<pdk.net.xml.Node> ->
output -> [<book id="1"></book><book id="2"></book>]

getElementsByTagNameNS

Returns a Array<Element> of all the Elements with a given local name and namespace URI in document order.

Arguments:

  • document :: pdk.net.xml.Document - The document

  • namespaceURI :: pdk.core.String - The namespace URI of the elements to match on. The special value "*" matches all namespaces.

  • localName :: pdk.core.String - The local name of the elements to match on. The special value "*" matches all local names.

Result:

Possible exceptions

Example:

XML Document

<table xmlns:ns="http://example.com/">
  <name>African Coffee Table</name>
  <ns:price>100</ns:price>
</table>
document :: pdk.net.xml.Document
namespaceURI :: pdk.core.String = "http://example.com/"
localName :: pdk.core.String = "price"

XmlDocument.getElementsByTagNameNS(document, namespaceURI, localName) :: Array<pdk.net.xml.Node> ->
output -> [<ns:price>100</ns:price>]

getImplementation

The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.

Arguments:

Result:

Possible exceptions

getInputEncoding

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 Document was created in memory.

Arguments:

Result:

Possible exceptions

getStrictErrorChecking

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 DOMException on DOM operations or report errors while using normalizeDocument. In case of error, the behavior is undefined. This attribute is true by default.

Arguments:

Result:

Possible exceptions

getXmlEncoding

An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.

Arguments:

Result:

Possible exceptions

getXmlStandalone

An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.

No verification is done on the value when setting this attribute. Applications should use normalizeDocument with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

Arguments:

Result:

Possible exceptions

getXmlVersion

An attribute specifying, as part of the XML declaration, 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 normalizeDocument in order to check for invalid characters in the Nodes that are already part of this Document. DOM applications may use the XmlDOMImplementation.hasFeature(feature, version) function with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using getXmlVersion.

Arguments:

Result:

Possible exceptions

importNode

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 XmlNode.cloneNode 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.

ATTRIBUTE_NODE

The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendants of the source Attr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on Attr nodes; they always carry their children with them when imported.

DOCUMENT_FRAGMENT_NODE

If the deep option was set to true, the descendants of the source DocumentFragment are recursively imported and the resulting nodes reassembled under the imported DocumentFragment to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment.

DOCUMENT_NODE

Document nodes cannot be imported.

DOCUMENT_TYPE_NODE

DocumentType nodes cannot be imported.

ELEMENT_NODE

Specified attribute nodes of the source element are imported, and the generated Attr nodes are attached to the generated Element. 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_NODE

Entity nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType 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.

ENTITY_REFERENCE_NODE

Only the EntityReference 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_NODE

Notation nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType 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.

PROCESSING_INSTRUCTION_NODE

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.

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE

These three types of nodes inheriting from CharacterData 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.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the document or importedNode is NULL

  • DOMException - 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 getXmlVersion attribute. This may happen when importing an XML 1.1 [XML 1.1] element into an XML 1.0 document, for instance.

Example

XML Document One

<orders>
</orders>

XML Document Two

<orders>
</orders>

XML Document Three

<orders>
    <book>
        <name>Harry Potter and the Philosopher's Stone</name>
    </book>
</orders>
documentOne :: pdk.net.xml.Document
documentTwo :: pdk.net.xml.Document
nodeToImportFromDoc3 :: pdk.net.xml.Node = [
   <book>
     <name>Harry Potter and the Philosopher's Stone</name>
   </book>
]
deep :: pdk.core.Boolean = true
notDeep :: pdk.core.Boolean = false

XmlDocument.importNode(documentOne, nodeToImportFromDoc2, deep) :: pdk.net.xml.Node ->
output - [
   <book>
     <name>Harry Potter and the Philosopher's Stone</name>
   </book>
]

XmlDocument.importNode(documentTwo, nodeToImportFromDoc2, notDeep) :: pdk.net.xml.Node ->
output - [
   <book>
   </book>
]

normalizeDocument

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 EntityReference nodes and normalizes Text nodes, as defined in the method XmlNode.normalize. Otherwise, the actual result depends on the features being set on the domConfig 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 CDATASection nodes, etc. See DOMConfiguration for details.

Arguments:

Result:

  • no output. Document was normalized

Possible exceptions

renameNode

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 Element 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 Element 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 normalizeDocument to guarantee these attributes are up-to-date. When the node being renamed is an Attr that is attached to an Element, the node is first removed from the Element 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,

  • 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:

  • output :: pdk.net.xml.Node - The renamed node. This is either the specified node or the new node that was created to replace the specified node.

Possible exceptions

  • NullPointerException - throws if the document NULL

  • DOMException - 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 " http://www.w3.org/XML/1998/namespace" [XML Namespaces] . Also raised, when the node being renamed is an attribute, if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".

setDocumentURI

The location of the document or null if undefined or if the Document was created using XmlDOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using XmlNode.getBaseURI. Beware that when the Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing XmlNode.getBaseURI.

Arguments:

Result:

  • no output

Possible exceptions

setStrictErrorChecking

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 DOMException on DOM operations or report errors while using normalizeDocument. In case of error, the behavior is undefined. This attribute is true by default.

Arguments:

Result:

  • no output

Possible exceptions

setXmlStandalone

An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.

No verification is done on the value when setting this attribute. Applications should use normalizeDocument with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

Arguments:

Result:

  • no output

Possible exceptions

  • NullPointerException - throws if the document or strictErrorChecking isNULL

  • DomException - NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.

setXmlVersion

Set an attribute specifying, as part of the XML declaration, 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 normalizeDocument in order to check for invalid characters in the Nodes that are already part of this Document. DOM applications may use the XmlDOMImplementation.hasFeature(feature, version) function with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using getXmlVersion.

Arguments:

Result:

  • no output

Possible exceptions

  • NullPointerException - throws if the document or xmlVersion isNULL

  • DomException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by the input Document or if this document does not support the "XML" feature.

Previouspdk.flow.xml.XmlNodeNextpdk.flow.xml.XmlDocumentType

Last updated