pdk.flow.xml.XmlText

contains functions to operate with XML Text 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.XmlCharacterData package for variables of type pdk.net.xml.Text, as the pdk.net.xml.Text structure extends the pdk.net.xml.CharacterData.

Functions

• getWholeText

• isElementContentWhitespace

• replaceWholeText

• splitText

---

getWholeText

Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order. For instance, in the example below wholeText on the Text node that contains "bar" returns "barfoo", while on the Text node that contains "foo" it returns "barfoo".

                     +-----+
                     | <p> |
                     +-----+
                       /\
                      /  \
               /-----\    +-------+
               | bar |    | &ent; |
               \-----/    +-------+
                              |
                              |
                           /-----\
                           | foo |
                           \-----/

Arguments:

• text :: pdk.net.xml.Text - The text

Result:

• output :: pdk.core.String

Possible exceptions

• NullPointerException - throws if the text is NULL

---

isElementContentWhitespace

Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while using XmlDocument.normalizeDocument.

Arguments:

• text :: pdk.net.xml.Text - The text

Result:

• output :: pdk.core.Boolean

Possible exceptions

• NullPointerException - throws if the text is NULL

---

replaceWholeText

Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.

This method returns the node which received the replacement text. The returned node is:

• null, when the replacement text is the empty string;

• the current node, except when the current node is read-only;

• a new Text node of the same type ( Text or CDATASection) as the current node inserted at the location of the replacement.

For instance, in the above example calling replaceWholeText on the Text node that contains "bar" with "yo" in argument results in the following:

                     +-----+
                     | <p> |
                     +-----+
                        |
                        |
                     /-----\
                     | yo  |
                     \-----/
 

Figure: barTextNode.replaceWholeText("yo") modifies the textual content of barTextNode with "yo"

Where the nodes to be removed are read-only descendants of an EntityReference, the EntityReference must be removed instead of the read-only nodes. If any EntityReference to be removed has descendants that are not EntityReference, Text, or CDATASection nodes, the replaceWholeText method must fail before performing any modification of the document, raising a DOMException with the code NO_MODIFICATION_ALLOWED_ERR.

For instance, in the example below calling replaceWholeText on the Text node that contains "bar" fails, because the EntityReference node "ent" contains an Element node which cannot be removed.

Arguments:

• text :: pdk.net.xml.Text - The text
• content :: pdk.core.String - The content of the replacing Text node.

Result:

• output :: pdk.net.xml.Text - The Text node created with the specified content.

Possible exceptions

• NullPointerException - throws if the text or content is NULL
• DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.

---

splitText

Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

Arguments:

• text :: pdk.net.xml.Text - The text
• offset :: pdk.core.Integer - The 16-bit unit offset at which to split, starting from 0.

Result:

• output :: pdk.net.xml.Text - The Text node created with the specified content.

Possible exceptions

• NullPointerException - throws if the text or offset 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