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
  • appendData
  • deleteData
  • getData
  • getLength
  • insertData
  • replaceData
  • setData
  • substringData
  1. Language Reference Guide
  2. Flows
  3. Built-In Functions
  4. Node functions
  5. pdk.flow.Xml

pdk.flow.xml.XmlCharacterData

contains functions to operate with XML CharacterData 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 CharacterData, as the pdk.net.xml.CharacterData structure extends the pdk.net.xml.Node.

Text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term 16-bit units is used whenever necessary to indicate that indexing on CharacterData is done in 16-bit units.

All functions

  • appendData

  • deleteData

  • getData

  • getLength

  • insertData

  • replaceData

  • setData

  • substringData

appendData

Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

  • arg :: pdk.core.String

Result:

  • No variable is returned. The input characterData has arg data.

Possible exceptions

  • NullPointerException - throws if the input characterData or arg is NULL

  • DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"
arg :: pdk.core.String = " chapter 2"

XmlCharacterData.appendData(attr, arg) :: Void ->
attr = "Harry Potter and the Philosopher's Stone chapter 2"

deleteData

Removes a range of 16-bit units from the node. Upon success, data and length reflect the change.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

  • offset :: pdk.core.Integer - The offset from which to start removing.

  • limit :: pdk.core.Integer - The number of 16-bit units to delete. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted.

Result:

  • No variable is returned. The input characterData has updated value.

Possible exceptions

  • NullPointerException - throws if the input characterData or offset or limit is NULL

  • DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"
offset :: pdk.core.Integer = 12
limit :: pdk.core.Integer = 3

XmlCharacterData.deleteData(attr, offset, limit) :: Void ->
attr = "Harry Potter  the Philosopher's Stone"

getData

The character data of the node. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

Result:

  • output :: pdk.core.String

Possible exceptions

  • NullPointerException - throws if the input characterData is NULL

  • DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"

XmlCharacterData.getData(attr) :: pdk.core.String ->
output = "Harry Potter and the Philosopher's Stone"

getLength

The number of 16-bit units that are available through data and the substringData functions below. This may have the value zero, i.e., CharacterData nodes may be empty.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

Result:

  • output :: pdk.core.Integer

Possible exceptions

  • NullPointerException - throws if the input characterData is NULL

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"

XmlCharacterData.getLength(attr) :: pdk.core.Integer ->
output = 40

insertData

Insert a string at the specified 16-bit unit offset.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

  • offset :: pdk.core.Integer - The character offset at which to insert.

  • arg :: pdk.core.String - The DOMString to insert.

Result:

  • No variable is returned. The input characterData has updated value.

Possible exceptions

  • NullPointerException - throws if the input characterData or offset or arg is NULL

  • DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter Philosopher's Stone"
offset :: pdk.core.Integer = 12
arg :: pdk.core.String = "and the "

XmlCharacterData.insertData(attr, offset, arg) :: Void ->
attr = "Harry Potter and the Philosopher's Stone"

replaceData

Replace the characters starting at the specified 16-bit unit offset with the specified string.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

  • offset :: pdk.core.Integer - The offset from which to start replacing.

  • count :: pdk.core.Integer - The number of 16-bit units to replace. If the sum of offset and count exceeds length, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a remove function call with the same range, followed by an appendData function invocation).

  • arg :: pdk.core.String - The DOMString with which the range must be replaced.

Result:

  • No variable is returned. The input characterData has updated value.

Possible exceptions

  • NullPointerException - throws if the input characterData or offset or arg is NULL

  • DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"
offset :: pdk.core.Integer = 21
count :: pdk.core.Integer = 19
arg :: pdk.core.String = "Chamber of Secrets"

XmlCharacterData.replaceData(attr, offset, count, arg) :: Void ->
attr = "Harry Potter and the Chamber of Secrets"

setData

Sets the character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

  • data :: pdk.core.String

Result:

  • No variable is returned. The input characterData has updated value.

Possible exceptions

  • NullPointerException - throws if the input characterData or offset or arg is NULL

  • DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"
data :: pdk.core.String = "Harry Potter and the Chamber of Secrets"

XmlCharacterData.setData(attr, data) :: Void ->
attr = "Harry Potter and the Chamber of Secrets"

substringData

Extracts a range of data from the node.

Arguments:

  • characterData :: pdk.net.xml.CharacterData

  • offset :: pdk.core.Integer - Start offset of substring to extract.

  • count :: pdk.core.Integer - The number of 16-bit units to extract.

Result:

  • output :: pdk.core.String - The specified substring. If the sum of offset and count exceeds the length, then all 16-bit units to the end of the data are returned.

Possible exceptions

  • NullPointerException - throws if the input characterData or offset or arg is NULL

  • DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.

Example:

XML Document

<order id="1">
    <book id="b_1">
        Harry Potter and the Philosopher's Stone
    </book>
</order>
attr :: pdk.net.xml.CharacterData = "Harry Potter and the Philosopher's Stone"
offset :: pdk.core.Integer = 21
count :: pdk.core.Integer = 19

XmlCharacterData.substringData(attr, offset, count) :: pdk.core.String ->
output = "Philosopher's Stone"
Previouspdk.flow.xml.XmlTypeInfoNextpdk.flow.xml.XmlText

Last updated 1 year ago