2005/5/9

acdk::xml::dom::XMLCharacterData Class Reference

Inheritance diagram for acdk::xml::dom::XMLCharacterData:

Detailed Description

Author:

Roger Rene Kommer

Version:

Revision

1.10

Date:

Date

2005/02/05 10:45:36

Public Member Functions
	XMLCharacterData (IN(RString) str, short type)
RString	toString ()
	return a string representation of this object Object::toString() return getName() by default
virtual RString	getNodeValue () throw ( org::w3c::dom::RDOMException )
	The value of this node, depending on its type; see the table above.
virtual RString	getData () throw ( org::w3c::dom::RDOMException )
	The character data of the node that implements this interface.
virtual void	setData (IN(RString) s) throw ( org::w3c::dom::RDOMException )
	The character data of the node that implements this interface.
virtual int	getLength ()
	The number of 16-bit units that are available through data and the substringData method below.
virtual RString	subStringData (int start, int count) throw ( org::w3c::dom::RDOMException )
	Extracts a range of data from the node.
virtual void	appendData (IN(RString) s) throw ( org::w3c::dom::RDOMException )
	Append the string to the end of the character data of the node.
virtual void	insertData (int i, IN(RString) s) throw ( org::w3c::dom::RDOMException )
	Insert a string at the specified 16-bit unit offset.
virtual void	deleteData (int start, int length) throw ( org::w3c::dom::RDOMException )
	Remove a range of 16-bit units from the node.
virtual void	replaceData (int start, int length, IN(RString) s) throw ( org::w3c::dom::RDOMException )
	Replace the characters starting at the specified 16-bit unit offset with the specified string.
RString	toXML ()
	dom4j like extension
Protected Attributes
RStringBuffer	_data

Constructor & Destructor Documentation

acdk::xml::dom::XMLCharacterData::XMLCharacterData (  IN(RString)  str, short  type )  [inline]

Member Function Documentation

virtual void acdk::xml::dom::XMLCharacterData::appendData (  IN(RString)  s  )  throw ( org::w3c::dom::RDOMException ) [inline, 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 DOMString specified. Parameters: arg  The DOMString to append. Exceptions: DOMException  NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implements org::w3c::dom::CharacterData.

virtual void acdk::xml::dom::XMLCharacterData::deleteData (  int  start, int  length )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

Remove a range of 16-bit units from the node. Upon success, data and length reflect the change. Parameters: offset  The offset from which to start removing. count  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. Exceptions: 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. Implements org::w3c::dom::CharacterData.

virtual RString acdk::xml::dom::XMLCharacterData::getData (   )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

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. 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. Exceptions: DOMException  DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. Implements org::w3c::dom::CharacterData.

virtual int acdk::xml::dom::XMLCharacterData::getLength (   )  [inline, virtual]

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

virtual RString acdk::xml::dom::XMLCharacterData::getNodeValue (   )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only. Exceptions: DOMException  DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. Reimplemented from acdk::xml::dom::XMLNode.

virtual void acdk::xml::dom::XMLCharacterData::insertData (  int  i, IN(RString)  s )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

Insert a string at the specified 16-bit unit offset. Parameters: offset  The character offset at which to insert. arg  The DOMString to insert. Exceptions: 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. Implements org::w3c::dom::CharacterData.

virtual void acdk::xml::dom::XMLCharacterData::replaceData (  int  start, int  length, IN(RString)  s )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

Replace the characters starting at the specified 16-bit unit offset with the specified string. Parameters: offset  The offset from which to start replacing. count  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 method call with the same range, followed by an append method invocation). arg  The DOMString with which the range must be replaced. Exceptions: 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. Implements org::w3c::dom::CharacterData.

virtual void acdk::xml::dom::XMLCharacterData::setData (  IN(RString)  s  )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

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. 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. Exceptions: DOMException  NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. Implements org::w3c::dom::CharacterData.

virtual RString acdk::xml::dom::XMLCharacterData::subStringData (  int  start, int  count )  throw ( org::w3c::dom::RDOMException ) [inline, virtual]

Extracts a range of data from the node. Parameters: offset  Start offset of substring to extract. count  The number of 16-bit units to extract. Returns: 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. Exceptions: 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. Implements org::w3c::dom::CharacterData.

RString acdk::xml::dom::XMLCharacterData::toString (   )  [inline, virtual]

return a string representation of this object Object::toString() return getName() by default Reimplemented from acdk::lang::Object. Reimplemented in acdk::xml::dom::XMLComment.

RString acdk::xml::dom::XMLCharacterData::toXML (   )  [inline, virtual]

dom4j like extension Todo: implement in derived interfaces Reimplemented from acdk::xml::dom::XMLNode. Reimplemented in acdk::xml::dom::XMLCDATASection, acdk::xml::dom::XMLComment, and acdk::xml::dom::XMLText.

Member Data Documentation

RStringBuffer acdk::xml::dom::XMLCharacterData::_data [protected]