Class PMRTextImpl

java.lang.Object
org.episteme.natural.chemistry.loaders.cml.dom.pmr.PMRNodeImpl
org.episteme.natural.chemistry.loaders.cml.dom.pmr.PMRCharacterDataImpl
org.episteme.natural.chemistry.loaders.cml.dom.pmr.PMRTextImpl
All Implemented Interfaces:
CharacterData, Node, Text
Direct Known Subclasses:
PMRCDATASectionImpl
public class PMRTextImpl extends PMRCharacterDataImpl implements Text
Implementation of the Text interface for the CML DOM.
Since:
1.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

  • Constructor Details

    • PMRTextImpl

      public PMRTextImpl()
      Constructor for the PMRTextImpl object.

    • PMRTextImpl

      public PMRTextImpl(Text text, PMRDocument doc)
      Creates a new PMRTextImpl object.
      Parameters:
      text - the generic W3C text node to delegate to
      doc - the owner CML document

  • Method Details

    • splitText

      public Text splitText(int i)
      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.
      Specified by:
      splitText in interface Text
      Parameters:
      i - The 16-bit unit offset at which to split, starting from 0.
      Returns:
      The new node, of the same type as this node.

    • getWholeText

      public String getWholeText()
      Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
      Specified by:
      getWholeText in interface Text
      Returns:
      the concatenated text
      Since:
      DOM Level 3

    • isElementContentWhitespace

      public boolean isElementContentWhitespace()
      Returns whether this text node contains element content whitespace, often called "ignorable whitespace".
      Specified by:
      isElementContentWhitespace in interface Text
      Returns:
      true if whitespace in element content, false otherwise
      Since:
      DOM Level 3

    • replaceWholeText

      public Text replaceWholeText(String content) throws DOMException
      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:
      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.

      Specified by:
      replaceWholeText in interface Text
      Parameters:
      content - The content of the replacing Text node.
      Returns:
      The Text node created with the specified content.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.
      Since:
      DOM Level 3