Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XercesCommentBridge.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #if !defined(XERCESCOMMENTBRIDGE_HEADER_GUARD_1357924680)
17 #define XERCESCOMMENTBRIDGE_HEADER_GUARD_1357924680
18 
19 
20 
22 
23 
24 
25 #if XERCES_VERSION_MAJOR >= 2
26 #include <xercesc/dom/deprecated/DOM_Comment.hpp>
27 #else
28 #include <xercesc/dom/DOM_Comment.hpp>
29 #endif
30 
31 
32 
34 
35 
36 
38 
39 
40 
41 XALAN_CPP_NAMESPACE_BEGIN
42 
43 
44 
46 
47 
54 {
55 public:
56 
58  const DOM_CommentType& theXercesComment,
59  const XercesBridgeNavigator& theNavigator);
60 
61  virtual
63 
64 
68  virtual const XalanDOMString&
69  getNodeName() const;
70 
74  virtual const XalanDOMString&
75  getNodeValue() const;
76 
80  virtual NodeType
81  getNodeType() const;
82 
92  virtual XalanNode*
93  getParentNode() const;
94 
108  virtual const XalanNodeList*
109  getChildNodes() const;
110 
116  virtual XalanNode*
117  getFirstChild() const;
118 
124  virtual XalanNode*
125  getLastChild() const;
126 
132  virtual XalanNode*
133  getPreviousSibling() const;
134 
140  virtual XalanNode*
141  getNextSibling() const;
142 
147  virtual const XalanNamedNodeMap*
148  getAttributes() const;
149 
159  virtual XalanDocument*
160  getOwnerDocument() const;
161 
163 
165 
184 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
185  virtual XalanNode*
186 #else
187  virtual XercesCommentBridge*
188 #endif
189  cloneNode(bool deep) const;
190 
192 
194 
211  virtual XalanNode*
212  insertBefore(
213  XalanNode* newChild,
214  XalanNode* refChild);
215 
229  virtual XalanNode*
230  replaceChild(
231  XalanNode* newChild,
232  XalanNode* oldChild);
233 
241  virtual XalanNode*
242  removeChild(XalanNode* oldChild);
243 
255  virtual XalanNode*
256  appendChild(XalanNode* newChild);
257 
259 
261 
269  virtual bool
270  hasChildNodes() const;
271 
272 
274 
276 
290  virtual void
291  setNodeValue(const XalanDOMString& nodeValue);
292 
294 
296 
313  virtual void
314  normalize();
315 
329  virtual bool
330  isSupported(
331  const XalanDOMString& feature,
332  const XalanDOMString& version) const;
333 
347  virtual const XalanDOMString&
348  getNamespaceURI() const;
349 
354  virtual const XalanDOMString&
355  getPrefix() const;
356 
364  virtual const XalanDOMString&
365  getLocalName() const;
366 
396  virtual void
397  setPrefix(const XalanDOMString& prefix);
398 
399  virtual bool
400  isIndexed() const;
401 
402  virtual IndexType
403  getIndex() const;
404 
406 
407  // These interfaces are inherited from XalanCDATASection...
408 
427  virtual const XalanDOMString&
428  getData() const;
429 
437  virtual unsigned int
438  getLength() const;
439 
455  virtual XalanDOMString
457  unsigned int offset,
458  unsigned int count) const;
459 
461 
472  virtual void
473  appendData(const XalanDOMString& arg);
474 
485  virtual void
486  insertData(
487  unsigned int offset,
488  const XalanDOMString& arg);
489 
506  virtual void
507  deleteData(
508  unsigned int offset,
509  unsigned int count);
510 
529  virtual void
530  replaceData(
531  unsigned int offset,
532  unsigned int count,
533  const XalanDOMString& arg);
534 
542  {
543  return m_xercesNode;
544  }
545 
547 
548 private:
549 
550  // Not implemented...
551  XercesCommentBridge(const XercesCommentBridge& theSource);
552 
554  operator=(const XercesCommentBridge& theSource);
555 
556  bool
557  operator==(const XercesCommentBridge& theRHS) const;
558 
559  // Data members...
560  DOM_CommentType m_xercesNode;
561 
562  const XercesBridgeNavigator& m_navigator;
563 };
564 
565 
566 
567 XALAN_CPP_NAMESPACE_END
568 
569 
570 
571 #endif // !defined(XERCESCOMMENTBRIDGE_HEADER_GUARD_1357924680)
Definition: XalanNode.hpp:44
DOM_CommentType getXercesNode() const
Get the Xerces node this instance represent.
Definition: XercesCommentBridge.hpp:541
Definition: XalanNodeList.hpp:42
virtual void replaceData(unsigned int offset, unsigned int count, const XalanDOMString &arg)=0
Replace the characters starting at the specified character offset with the specified string...
virtual bool hasChildNodes() const =0
This is a convenience method to allow easy determination of whether a node has any children...
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
virtual XalanNode * removeChild(XalanNode *oldChild)=0
Removes the child node indicated by oldChild from the list of children, and returns it...
#define XALAN_XERCESPARSERLIAISON_EXPORT
Definition: XercesParserLiaisonDefinitions.hpp:37
virtual XalanNode * replaceChild(XalanNode *newChild, XalanNode *oldChild)=0
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node...
XalanComment & operator=(const XalanComment &theSource)
Definition: XalanComment.hpp:38
virtual XalanDocument * getOwnerDocument() const =0
Gets the Document object associated with this node.
NodeType
Definition: XalanNode.hpp:53
virtual const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node, or null if it is unspecified.
virtual const XalanDOMString & getLocalName() const =0
Returns the local part of the qualified name of this node.
virtual XalanNode * getLastChild() const =0
Gets the last child of this node.
virtual const XalanNamedNodeMap * getAttributes() const =0
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise...
bool operator==(const XalanComment &theRHS) const
virtual bool isSupported(const XalanDOMString &feature, const XalanDOMString &version) const =0
Tests whether the DOM implementation implements a specific feature and that feature is supported by t...
virtual const XalanDOMString & getNodeName() const =0
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
XERCES_CPP_NAMESPACE_QUALIFIER DOM_Comment DOM_CommentType
Definition: XercesBridgeTypes.hpp:59
This class is deprecated.
Definition: XercesCommentBridge.hpp:53
Definition: XalanNamedNodeMap.hpp:42
virtual void appendData(const XalanDOMString &arg)=0
Append the string to the end of the character data of the node.
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
virtual unsigned int getLength() const =0
Returns the number of characters that are available through data and the substringData method below...
virtual XalanComment * cloneNode(bool deep) const =0
Returns a duplicate of this node.
virtual XalanDOMString & substringData(unsigned int offset, unsigned int count, XalanDOMString &theResult) const =0
Extracts a range of data from the node.
virtual void insertData(unsigned int offset, const XalanDOMString &arg)=0
Insert a string at the specified character offset.
virtual const XalanDOMString & getNodeValue() const =0
Gets the value of this node, depending on its type.
Definition: XalanDocument.hpp:51
virtual XalanNode * getParentNode() const =0
Gets the parent of this node.
virtual NodeType getNodeType() const =0
An enum value representing the type of the underlying object.
virtual void setPrefix(const XalanDOMString &prefix)=0
Set the namespace prefix of this node.
virtual IndexType getIndex() const =0
Get the node's index.
virtual XalanNode * insertBefore(XalanNode *newChild, XalanNode *refChild)=0
Inserts the node newChild before the existing child node refChild.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
Definition: XalanDOMString.hpp:42
virtual XalanNode * appendChild(XalanNode *newChild)=0
Adds the node newChild to the end of the list of children of this node.
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node, or null if it is unspecified.
virtual const XalanDOMString & getData() const =0
Returns the character data of the node that implements this interface.
unsigned long IndexType
Definition: XalanNode.hpp:70
virtual void normalize()=0
Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes...
This class is deprecated.
Definition: XercesBridgeNavigator.hpp:53
virtual void deleteData(unsigned int offset, unsigned int count)=0
Remove a range of characters from the node.
virtual const XalanNodeList * getChildNodes() const =0
Gets a NodeList that contains all children of this node.
virtual void setNodeValue(const XalanDOMString &nodeValue)=0
Sets the value of the node.

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