Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Member Functions | Protected Member Functions
XalanComment Class Reference
Inheritance diagram for XalanComment:
XalanCharacterData XalanNode XalanSourceTreeComment XercesCommentBridge XercesCommentWrapper

List of all members.

Public Member Functions

Cloning function.
Functions to modify the DOM Node.
Query functions.
Set functions.
Functions introduced in DOM Level 2.
Getter functions.
Functions that set or change data.

Protected Member Functions


Constructor & Destructor Documentation

XalanComment::XalanComment ( )
virtual XalanComment::~XalanComment ( ) [virtual]
XalanComment::XalanComment ( const XalanComment theSource) [protected]

Member Function Documentation

virtual XalanNode* XalanComment::appendChild ( XalanNode newChild) [pure virtual]

Adds the node newChild to the end of the list of children of this node.

If the newChild is already in the tree, it is first removed.

Parameters:
newChildThe node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node
Returns:
The node added.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::appendData ( const XalanDOMString 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 XalanDOMString specified.

Parameters:
argThe XalanDOMString to append.
Exceptions:
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanComment* XalanComment::cloneNode ( bool  deep) const [pure virtual]

Returns a duplicate of this node.

This function serves as a generic copy constructor for nodes.

The duplicate node has no parent ( parentNode returns null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.

Parameters:
deepIf true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::deleteData ( unsigned int  offset,
unsigned int  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.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanNamedNodeMap* XalanComment::getAttributes ( ) const [pure virtual]

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanNodeList* XalanComment::getChildNodes ( ) const [pure virtual]

Gets a NodeList that contains all children of this node.

If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanDOMString& XalanComment::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 CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single XalanDOMString. 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.
DOMExceptionDOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a XalanDOMString variable on the implementation platform.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::getFirstChild ( ) const [pure virtual]

Gets the first child of this node.

If there is no such node, this returns null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual IndexType XalanComment::getIndex ( ) const [pure virtual]

Get the node's index.

Valid only if the owner document reports that the document is node-order indexed.

Returns:
The index value, or 0 if the node is not indexed.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::getLastChild ( ) const [pure virtual]

Gets the last child of this node.

If there is no such node, this returns null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual unsigned int XalanComment::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.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanDOMString& XalanComment::getLocalName ( ) const [pure virtual]

Returns the local part of the qualified name of this node.

For nodes created with a DOM Level 1 method, such as createElement from the Document interface, it is null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanDOMString& XalanComment::getNamespaceURI ( ) const [pure virtual]

Get the namespace URI of this node, or null if it is unspecified.

This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::getNextSibling ( ) const [pure virtual]

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanDOMString& XalanComment::getNodeName ( ) const [pure virtual]
virtual NodeType XalanComment::getNodeType ( ) const [pure virtual]

An enum value representing the type of the underlying object.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanDOMString& XalanComment::getNodeValue ( ) const [pure virtual]

Gets the value of this node, depending on its type.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanDocument* XalanComment::getOwnerDocument ( ) const [pure virtual]

Gets the Document object associated with this node.

This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::getParentNode ( ) const [pure virtual]

Gets the parent of this node.

All nodes, except Document, DocumentFragment, and Attr may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, a null Node is returned.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual const XalanDOMString& XalanComment::getPrefix ( ) const [pure virtual]

Get the namespace prefix of this node, or null if it is unspecified.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::getPreviousSibling ( ) const [pure virtual]

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual bool XalanComment::hasChildNodes ( ) const [pure virtual]

This is a convenience method to allow easy determination of whether a node has any children.

Returns:
true if the node has any children, false if the node has no children.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::insertBefore ( XalanNode newChild,
XalanNode refChild 
) [pure virtual]

Inserts the node newChild before the existing child node refChild.

If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed. Note that a Node that has never been assigned to refer to an actual node is == null.

Parameters:
newChildThe node to insert.
refChildThe reference node, i.e., the node before which the new node must be inserted.
Returns:
The node being inserted.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::insertData ( unsigned int  offset,
const XalanDOMString arg 
) [pure virtual]

Insert a string at the specified character offset.

Parameters:
offsetThe character offset at which to insert.
argThe XalanDOMString 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.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual bool XalanComment::isIndexed ( ) const [pure virtual]

Determine if the document is node-order indexed.

Returns:
true if the document is indexed, otherwise false.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual bool XalanComment::isSupported ( const XalanDOMString feature,
const XalanDOMString version 
) const [pure virtual]

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Parameters:
featureThe string of the feature to test. This is the same name as what can be passed to the method hasFeature on DOMImplementation.
versionThis is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.
Returns:
Returns true if the specified feature is supported on this node, false otherwise.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::normalize ( ) [pure virtual]

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are no adjacent Text nodes.

This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.

Note: In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

XalanComment& XalanComment::operator= ( const XalanComment theSource) [protected]
bool XalanComment::operator== ( const XalanComment theRHS) const [protected]
virtual XalanNode* XalanComment::removeChild ( XalanNode oldChild) [pure virtual]

Removes the child node indicated by oldChild from the list of children, and returns it.

Parameters:
oldChildThe node being removed.
Returns:
The node removed.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanNode* XalanComment::replaceChild ( XalanNode newChild,
XalanNode oldChild 
) [pure virtual]

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order.

If the newChild is already in the tree, it is first removed.

Parameters:
newChildThe new node to put in the child list.
oldChildThe node being replaced in the list.
Returns:
The node replaced.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::replaceData ( unsigned int  offset,
unsigned int  count,
const XalanDOMString 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 XalanDOMString 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.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::setNodeValue ( const XalanDOMString nodeValue) [pure virtual]

Sets the value of the node.

Any node which can have a nodeValue (

See also:
getNodeValue) will also accept requests to set it to a string. The exact response to this varies from node to node -- Attribute, for example, stores its values in its children and has to replace them with a new Text holding the replacement value.

For most types of Node, value is null and attempting to set it will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will also be thrown if the node is read-only.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual void XalanComment::setPrefix ( const XalanDOMString prefix) [pure virtual]

Set the namespace prefix of this node.

Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.

Note also that changing the prefix of an attribute, that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.

Parameters:
prefixThe prefix of this node.
Exceptions:
DOMExceptionINVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if specified prefix is "xmlns" and the namespaceURI is neither null nor an empty string, or if the localName is null.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, XercesCommentWrapper, and XercesCommentBridge.

virtual XalanDOMString& XalanComment::substringData ( unsigned int  offset,
unsigned int  count,
XalanDOMString theResult 
) 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.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a XalanDOMString.

Implements XalanCharacterData.

Implemented in XalanSourceTreeComment, and XercesCommentWrapper.


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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo