Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.9

XercesCommentBridge Class Reference

This class is deprecated. More...

Inheritance diagram for XercesCommentBridge:

[legend]Collaboration diagram for XercesCommentBridge:

[legend]List of all members.

Public Member Functions

• XercesCommentBridge (const DOM_CommentType &theXercesComment, const XercesBridgeNavigator &theNavigator)
• virtual ~XercesCommentBridge ()
• virtual const XalanDOMString & getNodeName () const

  Gets the name of this node.
  
  

• virtual const XalanDOMString & getNodeValue () const

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

• virtual NodeType getNodeType () const

  An enum value representing the type of the underlying object.
  
  

• virtual XalanNode * getParentNode () const

  Gets the parent of this node.
  
  

• virtual const XalanNodeList * getChildNodes () const

  Gets a NodeList that contains all children of this node.
  
  

• virtual XalanNode * getFirstChild () const

  Gets the first child of this node.
  
  

• virtual XalanNode * getLastChild () const

  Gets the last child of this node.
  
  

• virtual XalanNode * getPreviousSibling () const

  Gets the node immediately preceding this node.
  
  

• virtual XalanNode * getNextSibling () const

  Gets the node immediately following this node.
  
  

• virtual const XalanNamedNodeMap * getAttributes () const

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

• virtual XalanDocument * getOwnerDocument () const

  Gets the DOM_Document object associated with this node.
  
  

Cloning function.

• virtual XercesCommentBridge * cloneNode (bool deep) const

  Returns a duplicate of this node.
  
  

Functions to modify the DOM Node.

• virtual XalanNode * insertBefore (XalanNode *newChild, XalanNode *refChild)

  Inserts the node newChild before the existing child node refChild.
  
  

• virtual XalanNode * replaceChild (XalanNode *newChild, XalanNode *oldChild)

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

• virtual XalanNode * removeChild (XalanNode *oldChild)

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

• virtual XalanNode * appendChild (XalanNode *newChild)

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

Query functions.

• virtual bool hasChildNodes () const

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

Set functions.

• virtual void setNodeValue (const XalanDOMString &nodeValue)

  Sets the value of the node.
  
  

Functions introduced in DOM Level 2.

• virtual void normalize ()

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

• virtual bool isSupported (const XalanDOMString &feature, const XalanDOMString &version) const

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

• virtual const XalanDOMString & getNamespaceURI () const

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

• virtual const XalanDOMString & getPrefix () const

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

• virtual const XalanDOMString & getLocalName () const

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

• virtual void setPrefix (const XalanDOMString &prefix)

  Set the namespace prefix of this node.
  
  

• virtual bool isIndexed () const

  Determine if the document is node-order indexed.
  
  

• virtual IndexType getIndex () const

  Get the node's index.
  
  

Getter functions.

• virtual const XalanDOMString & getData () const

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

• virtual unsigned int getLength () const

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

• virtual XalanDOMString substringData (unsigned int offset, unsigned int count) const

  Extracts a range of data from the node.
  
  

Functions that set or change data.

• virtual void appendData (const XalanDOMString &arg)

  Append the string to the end of the character data of the node.
  
  

• virtual void insertData (unsigned int offset, const XalanDOMString &arg)

  Insert a string at the specified character offset.
  
  

• virtual void deleteData (unsigned int offset, unsigned int count)

  Remove a range of characters from the node.
  
  

• virtual void replaceData (unsigned int offset, unsigned int count, const XalanDOMString &arg)

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

• DOM_CommentType getXercesNode () const

  Get the Xerces node this instance represent.
  
  

---

Detailed Description

This class is deprecated.

Deprecated:

This class is part of the deprecated Xerces DOM bridge.

---

Constructor & Destructor Documentation

XercesCommentBridge::XercesCommentBridge (  const DOM_CommentType &  theXercesComment, const XercesBridgeNavigator &  theNavigator )

virtual XercesCommentBridge::~XercesCommentBridge (   )  [virtual]

---

Member Function Documentation

virtual XalanNode* XercesCommentBridge::appendChild (  XalanNode *  newChild  )  [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: newChild  The 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 XalanComment.

virtual void XercesCommentBridge::appendData (  const XalanDOMString &  arg  )  [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 XalanComment.

virtual XercesCommentBridge* XercesCommentBridge::cloneNode (  bool  deep  )  const [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: deep  If 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 XalanComment.

virtual void XercesCommentBridge::deleteData (  unsigned int  offset, unsigned int  count )  [virtual]

Remove a range of characters from the node. Upon success, data and length reflect the change. Parameters: offset  The offset from which to remove characters. count  The 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: DOMException  INDEX_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 XalanComment.

virtual const XalanNamedNodeMap* XercesCommentBridge::getAttributes (   )  const [virtual]

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

virtual const XalanNodeList* XercesCommentBridge::getChildNodes (   )  const [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 XalanComment.

virtual const XalanDOMString& XercesCommentBridge::getData (   )  const [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 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. DOMException  DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. Implements XalanComment.

virtual XalanNode* XercesCommentBridge::getFirstChild (   )  const [virtual]

Gets the first child of this node. If there is no such node, this returns null. Implements XalanComment.

virtual IndexType XercesCommentBridge::getIndex (   )  const [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 XalanComment.

virtual XalanNode* XercesCommentBridge::getLastChild (   )  const [virtual]

Gets the last child of this node. If there is no such node, this returns null. Implements XalanComment.

virtual unsigned int XercesCommentBridge::getLength (   )  const [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 XalanComment.

virtual const XalanDOMString& XercesCommentBridge::getLocalName (   )  const [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 DOM_Document interface, it is null. Implements XalanComment.

virtual const XalanDOMString& XercesCommentBridge::getNamespaceURI (   )  const [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 XalanComment.

virtual XalanNode* XercesCommentBridge::getNextSibling (   )  const [virtual]

Gets the node immediately following this node. If there is no such node, this returns null. Implements XalanComment.

virtual const XalanDOMString& XercesCommentBridge::getNodeName (   )  const [virtual]

Gets the name of this node. Implements XalanComment.

virtual NodeType XercesCommentBridge::getNodeType (   )  const [virtual]

An enum value representing the type of the underlying object. Implements XalanComment.

virtual const XalanDOMString& XercesCommentBridge::getNodeValue (   )  const [virtual]

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

virtual XalanDocument* XercesCommentBridge::getOwnerDocument (   )  const [virtual]

Gets the DOM_Document object associated with this node. This is also the DOM_Document object used to create new nodes. When this node is a DOM_Document or a DOM_DocumentType which is not used with any DOM_Document yet, this is null. Implements XalanComment.

virtual XalanNode* XercesCommentBridge::getParentNode (   )  const [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 DOM_Node is returned. Implements XalanComment.

virtual const XalanDOMString& XercesCommentBridge::getPrefix (   )  const [virtual]

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

virtual XalanNode* XercesCommentBridge::getPreviousSibling (   )  const [virtual]

Gets the node immediately preceding this node. If there is no such node, this returns null. Implements XalanComment.

DOM_CommentType XercesCommentBridge::getXercesNode (   )  const

Get the Xerces node this instance represent. Returns: The Xerces node

virtual bool XercesCommentBridge::hasChildNodes (   )  const [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 XalanComment.

virtual XalanNode* XercesCommentBridge::insertBefore (  XalanNode *  newChild, XalanNode *  refChild )  [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 DOM_Node that has never been assigned to refer to an actual node is == null. Parameters: newChild  The node to insert. refChild  The reference node, i.e., the node before which the new node must be inserted. Returns: The node being inserted. Implements XalanComment.

virtual void XercesCommentBridge::insertData (  unsigned int  offset, const XalanDOMString &  arg )  [virtual]

Insert a string at the specified character 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 characters in data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implements XalanComment.

virtual bool XercesCommentBridge::isIndexed (   )  const [virtual]

Determine if the document is node-order indexed. Returns: true if the document is indexed, otherwise false. Implements XalanComment.

virtual bool XercesCommentBridge::isSupported (  const XalanDOMString &  feature, const XalanDOMString &  version )  const [virtual]

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. Parameters: feature  The string of the feature to test. This is the same name as what can be passed to the method hasFeature on DOMImplementation. version  This 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 XalanComment.

virtual void XercesCommentBridge::normalize (   )  [virtual]

Puts all DOM_Text nodes in the full depth of the sub-tree underneath this DOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOM_Text nodes, i.e., there are no adjacent DOM_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 DOM_CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between DOM_Text nodes and DOM_CDATASection nodes. Implements XalanComment.

virtual XalanNode* XercesCommentBridge::removeChild (  XalanNode *  oldChild  )  [virtual]

Removes the child node indicated by oldChild from the list of children, and returns it. Parameters: oldChild  The node being removed. Returns: The node removed. Implements XalanComment.

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

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DOM_DocumentFragment object, oldChild is replaced by all of the DOM_DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed. Parameters: newChild  The new node to put in the child list. oldChild  The node being replaced in the list. Returns: The node replaced. Implements XalanComment.

virtual void XercesCommentBridge::replaceData (  unsigned int  offset, unsigned int  count, const XalanDOMString &  arg )  [virtual]

Replace the characters starting at the specified character offset with the specified string. Parameters: offset  The offset from which to start replacing. count  The 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). 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 characters in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implements XalanComment.

virtual void XercesCommentBridge::setNodeValue (  const XalanDOMString &  nodeValue  )  [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 XalanComment.

virtual void XercesCommentBridge::setPrefix (  const XalanDOMString &  prefix  )  [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 DOM_Element and DOM_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: prefix  The prefix of this node. Exceptions: DOMException  INVALID_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 XalanComment.

virtual XalanDOMString XercesCommentBridge::substringData (  unsigned int  offset, unsigned int  count )  const [virtual]

Extracts a range of data from the node. Parameters: offset  Start offset of substring to extract. count  The 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: DOMException  INDEX_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 DOMString.

---

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

• XercesCommentBridge.hpp

Interpreting class diagrams

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

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