ProcessMIX Guide
  • Platform Overview
    • Introduction
    • Platform Purpose
    • Main Concepts
      • Organization Structure
      • Visual Language
      • Project Development Environment (IDE)
      • Deployment and Integration
      • Administration and Troubleshooting
    • First Steps
    • Change Log
      • 5.0.0
      • 5.0.5
      • 5.0.5.1
      • 5.0.5.2
      • 5.0.5.3
      • 5.0.5.4
  • Language Reference Guide
    • Overview
    • Data Structures and Types
      • Core Types (pdk.core)
      • Dictionary (pdk.asset.dictionary)
      • Scorecard (pdk.asset.scorecard)
      • Blockchain (pdk.blockchain)
      • Exceptions (pdk.ex)
      • Input/Output (pdk.io)
      • JSON Web Token (pdk.jwt)
      • Networking (pdk.net)
      • HTTP (pdk.net.http)
      • SOAP/Web Services (pdk.net.soap)
      • XML/DOM (pdk.net.xml)
      • S3 (pdk.s3)
      • SQL (pdk.sql)
      • Postgres (pdk.db.postgre)
      • Util (pdk.util)
      • Default Data Structure Field Values
    • Flows
      • Variables
        • Local Flow Variables
        • Node Variables
      • Flow Node Types
        • Core Nodes
          • In
          • Out
          • Assign
          • If
          • Switch
          • Iterator
          • Function Call
          • Subflow
          • Raise Exception
          • Exception Handler
          • Validator
        • Connector Nodes
          • Database Begin Transaction
          • Database Commit Transaction
          • Database Rollback Transaction
          • Database Query Executor
          • EVM Blockchain Functions
          • EVM Blockchain Smart Contract Functions
          • REST Service Executor
          • SOAP Service Executor
          • S3 Connector
          • SMB Connector
      • Expressions
      • Built-In Functions
        • Expression functions
          • pdk.util.Any
          • pdk.util.Array
          • pdk.util.Blockchain
          • pdk.util.Cast
          • pdk.util.Codec
          • pdk.util.Crypto
          • pdk.util.Date
          • pdk.util.File
          • pdk.util.Json
          • pdk.util.JWT
          • pdk.util.Map
          • pdk.util.Math
          • pdk.util.String
          • pdk.util.Util
        • Node functions
          • pdk.flow.Any
          • pdk.flow.Array
          • pdk.flow.File
          • pdk.flow.JsonArray
          • pdk.flow.JsonObject
          • pdk.flow.HttpRequest
          • pdk.flow.HttpResponse
          • pdk.flow.Logger
          • pdk.flow.Map
          • pdk.flow.Xml
            • pdk.flow.xml.XmlAttr
            • pdk.flow.xml.XmlElement
            • pdk.flow.xml.XmlNode
            • pdk.flow.xml.XmlDocument
            • pdk.flow.xml.XmlDocumentType
            • pdk.flow.xml.XmlDOMConfiguration
            • pdk.flow.xml.XmlDOMImplementation
            • pdk.flow.xml.XmlProcessingInstruction
            • pdk.flow.xml.XmlTypeInfo
            • pdk.flow.xml.XmlCharacterData
            • pdk.flow.xml.XmlText
            • pdk.flow.xml.XmlNamedNodeMap
          • pdk.node.BlockchainEth
          • pdk.node.S3
          • pdk.node.Smb
      • Exceptions
        • Checked Exceptions
        • Runtime Exceptions
    • Assets
      • Dictionary
      • Decision Table
      • Scorecard
      • PMML
    • Connectors
      • DB Connector
        • Prepared Query
        • Dynamic Query
        • Query input parameters
        • Stored Procedure
      • REST Connector
      • SOAP Connector
      • S3 Connector
      • SMB Connector
      • EVM Blockchain Connector
    • Global Variables
    • Appendices
      • Overview of Database Transactions
      • Reserved Words
  • Project Development Environment (IDE)
    • Project Explorer Panel
    • Flow Builder
    • Flow Node Editor
    • Data Structure Builder
    • Connector Builders
      • REST Connector Builder
      • SOAP Connector Builder
      • DB (Database) Connector Builder
      • EVM Blockchain Connectors Builder
      • S3 Connector Builder
    • Asset Builders
      • Dictionary Builder
      • Decision Table Builder
      • Scorecard Builder
      • PMML Asset Builder
    • Global Variables Panel
    • Expression Editor
    • Project Deployment and Execution
    • Cron Expression Generator
    • Test Helper
    • Debugging the Project
    • DB transactions
    • Team Collaboration Tools
      • Version Control
      • Conflict Resolver
    • Selectors
    • Error Panel
    • Local History
  • Home and Administration Guide
    • Organization and Subscription
    • Organization Team
    • Repositories and Projects
    • Environments
    • Deployments
    • Database Provisioning
    • Roles and Permissions
  • Logs and Troubleshooting
    • Request/Call Logs
    • Deployment Logs
    • Application Logs
  • Appendix: Example Project
    • Risk Mitigation Solution
Powered by GitBook
On this page
  • All functions
  • getAttribute
  • getAttributeNode
  • getAttributeNodeNS
  • getAttributeNS
  • getElementsByTagName
  • getElementsByTagNameNS
  • getSchemaTypeInfo
  • getTagName
  • hasAttribute
  • hasAttributeNS
  • removeAttribute
  • removeAttributeNode
  • removeAttributeNS
  • setAttribute
  • setAttributeNode
  • setAttributeNodeNS
  • setAttributeNS
  • setIdAttribute
  • setIdAttributeNode
  • setIdAttributeNS
  1. Language Reference Guide
  2. Flows
  3. Built-In Functions
  4. Node functions
  5. pdk.flow.Xml

pdk.flow.xml.XmlElement

contains functions to operate with XML Element variables

Previouspdk.flow.xml.XmlAttrNextpdk.flow.xml.XmlNode

Last updated 1 year ago

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

You can always rely on Java documentation and examples!

You can use functions from the package for variables of type , as the structure the .

The represents an element in an HTML or XML document. Elements may have attributes associated with them; since the structure inherits from , the generic structure attribute attributes may be used to retrieve the set of all attributes for an element. There are functions on the package to retrieve either an object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience.

All functions

getAttribute

Retrieves an attribute value by name.

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order id="1">
</order>
element :: pdk.net.xml.Element = [<order id="1"></order>]
name :: pdk.core.String = "id"

XmlElement.getAttribute(element, name) :: pdk.core.String ->
output :: String = "1"

getAttributeNode

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order id="1">
</order>
element :: pdk.net.xml.Element = [<order id="1"></order>]
name :: pdk.core.String = "id"

XmlElement.getAttributeNode(element, name) :: pdk.net.xml.Attr ->
output :: Attr = [id="1"]

getAttributeNodeNS

Arguments:

Result:

Possible exceptions

getAttributeNS

Arguments:

Result:

Possible exceptions

getElementsByTagName

Arguments:

Result:

Possible exceptions

Example:

XML Document

<order>
    <book id="1"></book>
    <book id="2"></book>
</order>
element :: pdk.net.xml.Element = [<order>...</order>]
name :: pdk.core.String = "book"

XmlElement.getElementsByTagName(element, name) :: pdk.core.Array<String> ->
output :: Array<String> = [<book id="1"></book>, <book id="2"></book>]

getElementsByTagNameNS

Arguments:

Result:

Possible exceptions:

getSchemaTypeInfo

The type information associated with this element.

Arguments:

Result:

Possible exceptions:

getTagName

<elementExample id="demo"> ...
</elementExample>

tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

Arguments:

Result:

Possible exceptions:

hasAttribute

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

Arguments:

Result:

Possible exceptions:

Example:

XML Document

<order id="1">
</order>
element :: pdk.net.xml.Element = [<order id="1"></order>]
name :: pdk.core.String = "id"

XmlElement.hasAttribute(element, name) :: pdk.core.Boolean ->
output :: Boolean = true

hasAttributeNS

Arguments:

Result:

Possible exceptions:

removeAttribute

Arguments:

Result:

  • no output

Possible exceptions:

removeAttributeNode

Arguments:

Result:

Possible exceptions:

removeAttributeNS

Arguments:

Result:

  • no output

Possible exceptions:

setAttribute

Arguments:

Result:

  • no output

Possible exceptions:

setAttributeNode

Arguments:

Result:

Possible exceptions:

setAttributeNodeNS

Arguments:

Result:

Possible exceptions:

setAttributeNS

Arguments:

Result:

  • no output

Possible exceptions:

setIdAttribute

Arguments:

Result:

  • no output

Possible exceptions:

setIdAttributeNode

Arguments:

Result:

  • no output

Possible exceptions:

setIdAttributeNS

Arguments:

Result:

  • no output

Possible exceptions:

element :: - The element

name :: - The name of the attribute to retrieve

output :: - The value as a string, or the empty string if that attribute does not have a specified or default value

- throws if the element is NULL

Retrieves an attribute node by name. To retrieve an attribute node by qualified name and namespace URI, use the method.

element :: - The element

name :: - The name (nodeName) of the attribute to retrieve

output :: - The node with the specified name ( nodeName) or null if there is no such attribute.

- throws if the element is NULL

Retrieves an node by local name and namespace URI. Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

element :: - The element

namespaceURI :: - The namespace URI of the attribute to retrieve

localName :: - The local name of the attribute to retrieve

output :: - The node with the specified attribute local name and namespace URI or null if there is no such attribute.

- throws if the element is NULL

- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [])

Retrieves an attribute value by local name and namespace URI. Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

element :: - The element

namespaceURI :: - The namespace URI of the attribute to retrieve

localName :: - The local name of the attribute to retrieve

output :: - The value as a string, or the empty string if that attribute does not have a specified or default value.

- throws if the element is NULL

- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as []).

Returns a Nodes array of all descendant with a given tag name, in document order.

element :: - The element

name :: - The name of the tag to match on. The special value "*" matches all tags

output :: <> - A list of matching nodes.

- throws if the element is NULL

Returns a Nodes array of all descendant with a given local name and namespace URI in document order.

element :: - The element

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 of matching

- throws if the element is NULL

- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [])

element :: - The element

output ::

- throws if the element is NULL

The name of the element. If is different from null, this attribute is a qualified name. For example, in:

element :: - The element

output ::

- throws if the element is NULL

element :: - The element

name :: - The name of the attribute to look for

output :: - true if an attribute with the given name is specified on this element or has a default value, false otherwise

- throws if the element is NULL

Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

element :: - The element

namespaceURI :: - The namespace URI of the attribute to look for

localName :: - The local name of the attribute to look for

output :: - true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise

- throws if the element is NULL

- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as []).

Removes an attribute by name. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should use to guarantee this information is up-to-date. If no attribute with this name is found, this function has no effect. To remove an attribute by local name and namespace URI, use the function.

element :: - The element

name :: - The name of the attribute to remove

- throws if the element is NULL

- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly

Removes the specified attribute node. If a default value for the removed node is defined in the DTD, a new node immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should use to guarantee this information is up-to-date.

element :: - The element

oldAttr :: - The node to remove from the attribute list

output :: - The node that was removed

- throws if the element or oldAttr is NULL

- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

Removes an attribute by local name and namespace URI. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should use to guarantee this information is up-to-date. If no attribute with this local name and namespace URI is found, this method has no effect. Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace

element :: - The element

namespaceURI :: - The namespace URI of the attribute to remove

localName :: - The local name of the attribute to remove

- throws if the element is NULL

- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [])

Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an node plus any and nodes, build the appropriate subtree, and use to assign it as the value of an attribute. To set an attribute with a qualified name and namespace URI, use the function.

element :: - The element

name :: - The name of the attribute to create or alter

value :: - Value to set in string form

- throws if the element 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 attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly

Adds a new attribute node. If an attribute with that name ( nodeName) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect. To add a new attribute node with a qualified name and namespace URI, use the function

element :: - The element

newAttr :: - The node to add to the attribute list

output :: - If the newAttr attribute replaces an existing attribute, the replaced node is returned, otherwise null is returned

- throws if the element is NULL

- WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect. Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

element :: - The element

newAttr :: - The node to add to the attribute list

output :: - If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned

- throws if the element is NULL

- WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another object. The DOM user must explicitly clone nodes to re-use them in other elements. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as []).

Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an node plus any and nodes, build the appropriate subtree, and use or to assign it as the value of an attribute. Per [] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

element :: - The element

namespaceURI :: - The namespace URI of the attribute to create or alter

qualifiedName :: - The qualified name of the attribute to create or alter

value :: - The value to set in string form

- throws if the element is NULL

- INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to the XML version in use specified in the attribute. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, 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: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as []).

If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute . This affects the value of and the behavior of , but does not change any schema that may be in use, in particular this does not affect the of the specified node. Use the value false for the parameter isId to undeclare an attribute for being a user-determined ID attribute. To specify an attribute by local name and namespace URI, use the function.

element :: - The element

name :: - The name of the attribute

isId :: - Whether the attribute is a of type ID

- throws if the element is NULL

- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element

If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute . This affects the value of and the behavior of , but does not change any schema that may be in use, in particular this does not affect the of the specified node. Use the value false for the parameter isId to undeclare an attribute for being a user-determined ID attribute.

element :: - The element

idAttr :: - The attribute node

isId :: - Whether the attribute is a of type ID

- throws if the element is NULL

- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element

If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute . This affects the value of and the behavior of , but does not change any schema that may be in use, in particular this does not affect the of the specified node. Use the value false for the parameter isId to undeclare an attribute for being a user-determined ID attribute.

element :: - The element

namespaceURI :: - The namespace URI of the attribute

qualifiedName :: - The local name of the attribute

isId :: - Whether the attribute is a of type ID

- throws if the element is NULL

- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element

XML Namespaces
XML Namespaces
XML Namespaces
getAttributeNodeNS
setAttributeNS
https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/package-summary.html
pdk.floe.xml.XmlNode
XmlElement
getAttribute
getAttributeNode
getAttributeNodeNS
getAttributeNS
getElementsByTagName
getElementsByTagNameNS
getSchemaTypeInfo
getTagName
hasAttribute
hasAttributeNS
removeAttribute
removeAttributeNode
removeAttributeNS
setAttribute
setAttributeNode
setAttributeNodeNS
setAttributeNS
setIdAttribute
setIdAttributeNode
setIdAttributeNS
XML Namespaces
HTML 4.01
HTML 4.01
HTML 4.01
HTML 4.01
XML Namespaces
HTML 4.01
HTML 4.01
XML Namespaces
setAttributeNodeNS
setAttributeNode
http://www.w3.org/XML/1998/namespace
http://www.w3.org/2000/xmlns/
http://www.w3.org/2000/xmlns/
HTML 4.01
removeAttributeNS
setAttributeNode
setAttributeNS
setIdAttributeNS
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
NullPointerException
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.Boolean
pdk.core.String
pdk.core.String
pdk.core.Boolean
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.String
pdk.core.Boolean
pdk.core.Boolean
pdk.core.String
pdk.core.String
pdk.core.Boolean
pdk.core.String
pdk.core.String
pdk.core.Array
pdk.core.Array
extends
Element
pdk.net.xml.Element
pdk.net.xml.Node
Element
Element
Node
Node
Attr
Attr
pdk.net.xml.Element
Attr
pdk.net.xml.Element
pdk.net.xml.Attr
Attr
Attr
pdk.net.xml.Element
pdk.net.xml.Attr
Attr
DOMException
pdk.net.xml.Element
Attr
DOMException
Elements
pdk.net.xml.Element
Node
Element
Elements
pdk.net.xml.Element
Node
Elements
DOMException
pdk.net.xml.Element
pdk.net.xml.TypeInfo
pdk.net.xml.Element
pdk.net.xml.Element
pdk.net.xml.Element
DOMException
pdk.net.xml.Element
DOMException
pdk.net.xml.Element
pdk.net.xml.Attr
Attr
pdk.net.xml.Attr
Attr
DOMException
pdk.net.xml.Element
DOMException
Attr
Text
EntityReference
pdk.net.xml.Element
pdk.net.xml.Element
pdk.net.xml.Attr
Attr
pdk.net.xml.Attr
Attr
DOMException
pdk.net.xml.Element
pdk.net.xml.Attr
Attr
pdk.net.xml.Attr
DOMException
Element
Attr
Attr
Text
EntityReference
pdk.net.xml.Element
pdk.net.xml.Element
DOMException
pdk.net.xml.Element
pdk.net.xml.Attr
DOMException
pdk.net.xml.Element
DOMException
Attr
DOMException
DOMException
Attr
Attr
Attr
XmlNode.getLocalName
XmlDocument.normalizeDocument
XmlDocument.normalizeDocument
XmlDocument.normalizeDocument
XmlDocument.getXmlVersion
XmlDocument.getXmlVersion
XmlDocument.getElementById
XmlDocument.getElementById
XmlDocument.getElementById
XmlAttr.isId
XmlAttr.getSchemaTypeInfo
XmlAttr.isId
XmlAttr.getSchemaTypeInfo
XmlAttr.isId
XmlAttr.getSchemaTypeInfo