Xerces-C++  3.1.3
List of all members
DOMCharacterData Class Referenceabstract

The DOMCharacterData interface extends DOMNode with a set of attributes and methods for accessing character data in the DOM. More...

Inheritance diagram for DOMCharacterData:
DOMNode DOMComment DOMText DOMCDATASection

Public Member Functions

Destructor
virtual ~DOMCharacterData ()
 Destructor. More...
 
Functions introduced in DOM Level 1
virtual const XMLChgetData () const =0
 Returns the character data of the node that implements this interface. More...
 
virtual XMLSize_t getLength () const =0
 Returns the number of characters that are available through data and the substringData method below. More...
 
virtual const XMLChsubstringData (XMLSize_t offset, XMLSize_t count) const =0
 Extracts a range of data from the node. More...
 
virtual void appendData (const XMLCh *arg)=0
 Append the string to the end of the character data of the node. More...
 
virtual void insertData (XMLSize_t offset, const XMLCh *arg)=0
 Insert a string at the specified character offset. More...
 
virtual void deleteData (XMLSize_t offset, XMLSize_t count)=0
 Remove a range of characters from the node. More...
 
virtual void replaceData (XMLSize_t offset, XMLSize_t count, const XMLCh *arg)=0
 Replace the characters starting at the specified character offset with the specified string. More...
 
virtual void setData (const XMLCh *data)=0
 Sets the character data of the node that implements this interface. More...
 
- Public Member Functions inherited from DOMNode
virtual ~DOMNode ()
 Destructor. More...
 
virtual const XMLChgetNodeName () const =0
 The name of this node, depending on its type; see the table above. More...
 
virtual const XMLChgetNodeValue () const =0
 Gets the value of this node, depending on its type. More...
 
virtual NodeType getNodeType () const =0
 An enum value representing the type of the underlying object. More...
 
virtual DOMNodegetParentNode () const =0
 Gets the parent of this node. More...
 
virtual DOMNodeListgetChildNodes () const =0
 Gets a DOMNodeList that contains all children of this node. More...
 
virtual DOMNodegetFirstChild () const =0
 Gets the first child of this node. More...
 
virtual DOMNodegetLastChild () const =0
 Gets the last child of this node. More...
 
virtual DOMNodegetPreviousSibling () const =0
 Gets the node immediately preceding this node. More...
 
virtual DOMNodegetNextSibling () const =0
 Gets the node immediately following this node. More...
 
virtual DOMNamedNodeMapgetAttributes () const =0
 Gets a DOMNamedNodeMap containing the attributes of this node (if it is an DOMElement) or null otherwise. More...
 
virtual DOMDocumentgetOwnerDocument () const =0
 Gets the DOMDocument object associated with this node. More...
 
virtual DOMNodecloneNode (bool deep) const =0
 Returns a duplicate of this node. More...
 
virtual DOMNodeinsertBefore (DOMNode *newChild, DOMNode *refChild)=0
 Inserts the node newChild before the existing child node refChild. More...
 
virtual DOMNodereplaceChild (DOMNode *newChild, DOMNode *oldChild)=0
 Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. More...
 
virtual DOMNoderemoveChild (DOMNode *oldChild)=0
 Removes the child node indicated by oldChild from the list of children, and returns it. More...
 
virtual DOMNodeappendChild (DOMNode *newChild)=0
 Adds the node newChild to the end of the list of children of this node. More...
 
virtual bool hasChildNodes () const =0
 This is a convenience method to allow easy determination of whether a node has any children. More...
 
virtual void setNodeValue (const XMLCh *nodeValue)=0
 Sets the value of the node. More...
 
virtual void normalize ()=0
 Puts all DOMText nodes in the full depth of the sub-tree underneath this DOMNode, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOMText nodes, i.e., there are neither adjacent DOMText nodes nor empty DOMText nodes. More...
 
virtual bool isSupported (const XMLCh *feature, const XMLCh *version) const =0
 Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. More...
 
virtual const XMLChgetNamespaceURI () const =0
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XMLChgetPrefix () const =0
 Get the namespace prefix of this node, or null if it is unspecified. More...
 
virtual const XMLChgetLocalName () const =0
 Returns the local part of the qualified name of this node. More...
 
virtual void setPrefix (const XMLCh *prefix)=0
 Set the namespace prefix of this node. More...
 
virtual bool hasAttributes () const =0
 Returns whether this node (if it is an element) has any attributes. More...
 
virtual bool isSameNode (const DOMNode *other) const =0
 Returns whether this node is the same node as the given one. More...
 
virtual bool isEqualNode (const DOMNode *arg) const =0
 Tests whether two nodes are equal. More...
 
virtual void * setUserData (const XMLCh *key, void *data, DOMUserDataHandler *handler)=0
 Associate an object to a key on this node. More...
 
virtual void * getUserData (const XMLCh *key) const =0
 Retrieves the object associated to a key on a this node. More...
 
virtual const XMLChgetBaseURI () const =0
 The absolute base URI of this node or null if undefined. More...
 
virtual short compareDocumentPosition (const DOMNode *other) const =0
 Compares the reference node, i.e. More...
 
virtual const XMLChgetTextContent () const =0
 This attribute returns the text content of this node and its descendants. More...
 
virtual void setTextContent (const XMLCh *textContent)=0
 This attribute removes any possible children this node may have and, if the new string is not empty or null, replaced by a single DOMText node containing the string this attribute is set to. More...
 
virtual const XMLChlookupPrefix (const XMLCh *namespaceURI) const =0
 Look up the prefix associated to the given namespace URI, starting from this node. More...
 
virtual bool isDefaultNamespace (const XMLCh *namespaceURI) const =0
 This method checks if the specified namespaceURI is the default namespace or not. More...
 
virtual const XMLChlookupNamespaceURI (const XMLCh *prefix) const =0
 Look up the namespace URI associated to the given prefix, starting from this node. More...
 
virtual void * getFeature (const XMLCh *feature, const XMLCh *version) const =0
 This method makes available a DOMNode's specialized interface. More...
 
virtual void release ()=0
 Called to indicate that this Node (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. More...
 

Protected Member Functions

Hidden constructors
 DOMCharacterData ()
 
 DOMCharacterData (const DOMCharacterData &other)
 
- Protected Member Functions inherited from DOMNode
 DOMNode ()
 
 DOMNode (const DOMNode &)
 

Additional Inherited Members

- Public Types inherited from DOMNode
enum  NodeType {
  ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4,
  ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8,
  DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12
}
 NodeType. More...
 
enum  DocumentPosition {
  DOCUMENT_POSITION_DISCONNECTED = 0x01, DOCUMENT_POSITION_PRECEDING = 0x02, DOCUMENT_POSITION_FOLLOWING = 0x04, DOCUMENT_POSITION_CONTAINS = 0x08,
  DOCUMENT_POSITION_CONTAINED_BY = 0x10, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20
}
 DocumentPosition: More...
 

Detailed Description

The DOMCharacterData interface extends DOMNode with a set of attributes and methods for accessing character data in the DOM.

For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to DOMCharacterData, though DOMText and others do inherit the interface from it. All offsets in this interface start from 0.

As explained in the DOM spec, 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 DOMCharacterData is done in 16-bit units.

See also the Document Object Model (DOM) Level 2 Core Specification.

Since
DOM Level 1

Constructor & Destructor Documentation

DOMCharacterData::DOMCharacterData ( )
protected
DOMCharacterData::DOMCharacterData ( const DOMCharacterData other)
protected
virtual DOMCharacterData::~DOMCharacterData ( )
virtual

Destructor.

Member Function Documentation

virtual void DOMCharacterData::appendData ( const XMLCh arg)
pure virtual

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 XMLCh* String specified.

Parameters
argThe XMLCh* String to append.
Exceptions
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Since
DOM Level 1
virtual void DOMCharacterData::deleteData ( XMLSize_t  offset,
XMLSize_t  count 
)
pure virtual

Remove a range of characters from the node.

Upon success, data and length reflect the change.

Parameters
offsetThe offset from which to remove characters.
countThe number of characters to delete. If the sum of offset and count exceeds length then all characters from offset to the end of the data are deleted.
Exceptions
DOMExceptionINDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Since
DOM Level 1
virtual const XMLCh* DOMCharacterData::getData ( ) const
pure virtual

Returns 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 DOMCharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single XMLCh* String. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Exceptions
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Since
DOM Level 1
virtual XMLSize_t DOMCharacterData::getLength ( ) const
pure virtual

Returns the number of characters that are available through data and the substringData method below.

This may have the value zero, i.e., CharacterData nodes may be empty.

Since
DOM Level 1
virtual void DOMCharacterData::insertData ( XMLSize_t  offset,
const XMLCh arg 
)
pure virtual

Insert a string at the specified character offset.

Parameters
offsetThe character offset at which to insert.
argThe XMLCh* String to insert.
Exceptions
DOMExceptionINDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Since
DOM Level 1
virtual void DOMCharacterData::replaceData ( XMLSize_t  offset,
XMLSize_t  count,
const XMLCh arg 
)
pure virtual

Replace the characters starting at the specified character offset with the specified string.

Parameters
offsetThe offset from which to start replacing.
countThe number of characters to replace. If the sum of offset and count exceeds length , then all characters to the end of the data are replaced (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).
argThe XMLCh* String with which the range must be replaced.
Exceptions
DOMExceptionINDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
Since
DOM Level 1
virtual void DOMCharacterData::setData ( const XMLCh data)
pure virtual

Sets the character data of the node that implements this interface.

Parameters
dataThe XMLCh* String to set.
Since
DOM Level 1
virtual const XMLCh* DOMCharacterData::substringData ( XMLSize_t  offset,
XMLSize_t  count 
) const
pure virtual

Extracts a range of data from the node.

Parameters
offsetStart offset of substring to extract.
countThe number of characters to extract.
Returns
The specified substring. If the sum of offset and count exceeds the length, then all characters to the end of the data are returned.
Exceptions
DOMExceptionINDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
Since
DOM Level 1

The documentation for this class was generated from the following file: