Poco::XML

class CDATASection

File Information

Library: XML
Package: DOM
Header: Poco/DOM/CDATASection.h

Description

CDATA sections are used to escape blocks of text containing characters that would otherwise be regarded as markup. The only delimiter that is recognized in a CDATA section is the "]]>" string that ends the CDATA section. CDATA sections cannot be nested. Their primary purpose is for including material such as XML fragments, without needing to escape all the delimiters.

The DOMString attribute of the Text node holds the text that is contained by the CDATA section. Note that this may contain characters that need to be escaped outside of CDATA sections and that, depending on the character encoding ("charset") chosen for serialization, it may be impossible to write out some characters as part of a CDATA section.

The CDATASection interface inherits from the CharacterData interface through the Text interface. Adjacent CDATASection nodes are not merged by use of the normalize method on the Element interface.

Note: Because no markup is recognized within a CDATASection, character numeric references cannot be used as an escape mechanism when serializing. Therefore, action needs to be taken when serializing a CDATASection with a character encoding where some of the contained characters cannot be represented. Failure to do so would not produce well-formed XML. One potential solution in the serialization process is to end the CDATA section before the character, output the character using a character reference or entity reference, and open a new CDATA section for any further characters in the text node. Note, however, that some code conversion libraries at the time of writing do not return an error or exception when a character is missing from the encoding, making the task of ensuring that data is not corrupted on serialization more difficult.

Inheritance

Direct Base Classes: Text

All Base Classes: AbstractNode, CharacterData, DOMObject, EventTarget, Node, Text

Member Summary

Member Functions: copyNode, nodeName, nodeType, splitText

Inherited Functions: addEventListener, appendChild, appendData, attributes, autoRelease, bubbleEvent, captureEvent, childNodes, cloneNode, copyNode, data, deleteData, dispatchAttrModified, dispatchCharacterDataModified, dispatchEvent, dispatchNodeInserted, dispatchNodeInsertedIntoDocument, dispatchNodeRemoved, dispatchNodeRemovedFromDocument, dispatchSubtreeModified, duplicate, events, eventsSuspended, firstChild, getData, getNodeByPath, getNodeByPathNS, getNodeValue, hasAttributes, hasChildNodes, innerText, insertAfterNP, insertBefore, insertData, isSupported, lastChild, length, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, normalize, ownerDocument, parentNode, prefix, previousSibling, release, removeChild, removeEventListener, replaceChild, replaceData, setData, setNodeValue, setOwnerDocument, splitText, substringData, trimmedData

Constructors

CDATASection protected

CDATASection(
    Document * pOwnerDocument,
    const XMLString & data
);

CDATASection protected

CDATASection(
    Document * pOwnerDocument,
    const CDATASection & sec
);

Destructor

~CDATASection protected virtual

~CDATASection();

Member Functions

nodeName virtual

const XMLString & nodeName() const;

See also: Poco::XML::Text::nodeName()

nodeType virtual

unsigned short nodeType() const;

See also: Poco::XML::Text::nodeType()

splitText

Text * splitText(
    unsigned long offset
);

copyNode protected virtual

Node * copyNode(
    bool deep,
    Document * pOwnerDocument
) const;

See also: Poco::XML::Text::copyNode()