Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XercesCommentWrapper.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(XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680)
17 #define XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680
18 
19 
20 
22 
24 
27 
28 
29 
30 XALAN_CPP_NAMESPACE_BEGIN
31 
32 
33 
35 
36 
37 
39 {
40 public:
41 
43  const DOMCommentType* theXercesComment,
44  const XercesWrapperNavigator& theNavigator);
45 
46  static XercesCommentWrapper*
47  create( MemoryManagerType& theManager,
48  const DOMCommentType* theXercesComment,
49  const XercesWrapperNavigator& theNavigator);
50 
51  virtual
53 
54 
58  virtual const XalanDOMString&
59  getNodeName() const;
60 
64  virtual const XalanDOMString&
65  getNodeValue() const;
66 
70  virtual NodeType
71  getNodeType() const;
72 
82  virtual XalanNode*
83  getParentNode() const;
84 
98  virtual const XalanNodeList*
99  getChildNodes() const;
100 
106  virtual XalanNode*
107  getFirstChild() const;
108 
114  virtual XalanNode*
115  getLastChild() const;
116 
122  virtual XalanNode*
123  getPreviousSibling() const;
124 
130  virtual XalanNode*
131  getNextSibling() const;
132 
137  virtual const XalanNamedNodeMap*
138  getAttributes() const;
139 
149  virtual XalanDocument*
150  getOwnerDocument() const;
151 
153 
155 
174 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
175  virtual XalanNode*
176 #else
177  virtual XercesCommentWrapper*
178 #endif
179  cloneNode(bool deep) const;
180 
182 
184 
201  virtual XalanNode*
202  insertBefore(
203  XalanNode* newChild,
204  XalanNode* refChild);
205 
219  virtual XalanNode*
220  replaceChild(
221  XalanNode* newChild,
222  XalanNode* oldChild);
223 
231  virtual XalanNode*
232  removeChild(XalanNode* oldChild);
233 
245  virtual XalanNode*
246  appendChild(XalanNode* newChild);
247 
249 
251 
259  virtual bool
260  hasChildNodes() const;
261 
262 
264 
266 
280  virtual void
281  setNodeValue(const XalanDOMString& nodeValue);
282 
284 
286 
303  virtual void
304  normalize();
305 
319  virtual bool
320  isSupported(
321  const XalanDOMString& feature,
322  const XalanDOMString& version) const;
323 
337  virtual const XalanDOMString&
338  getNamespaceURI() const;
339 
344  virtual const XalanDOMString&
345  getPrefix() const;
346 
354  virtual const XalanDOMString&
355  getLocalName() const;
356 
386  virtual void
387  setPrefix(const XalanDOMString& prefix);
388 
389  virtual bool
390  isIndexed() const;
391 
392  virtual IndexType
393  getIndex() const;
394 
396 
397  // These interfaces are inherited from XalanCDATASection...
398 
417  virtual const XalanDOMString&
418  getData() const;
419 
427  virtual unsigned int
428  getLength() const;
429 
445  virtual XalanDOMString&
447  unsigned int offset,
448  unsigned int count,
449  XalanDOMString& theResult) const;
450 
452 
463  virtual void
464  appendData(const XalanDOMString& arg);
465 
476  virtual void
477  insertData(
478  unsigned int offset,
479  const XalanDOMString& arg);
480 
497  virtual void
498  deleteData(
499  unsigned int offset,
500  unsigned int count);
501 
520  virtual void
521  replaceData(
522  unsigned int offset,
523  unsigned int count,
524  const XalanDOMString& arg);
525 
531  const DOMCommentType*
533  {
534  return m_xercesNode;
535  }
536 
538 
539 private:
540 
541  // Not implemented...
542  XercesCommentWrapper(const XercesCommentWrapper& theSource);
543 
545  operator=(const XercesCommentWrapper& theSource);
546 
547  bool
548  operator==(const XercesCommentWrapper& theRHS) const;
549 
550  // Data members...
551  const DOMCommentType* const m_xercesNode;
552 
553  const XercesWrapperNavigator& m_navigator;
554 };
555 
556 
557 
558 XALAN_CPP_NAMESPACE_END
559 
560 
561 #endif // !defined(XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680)
Definition: XalanNode.hpp:44
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...
XALAN_CPP_NAMESPACE_BEGIN typedef XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager MemoryManagerType
Definition: XalanMemoryManagement.hpp:39
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
const DOMCommentType * getXercesNode() const
Get the Xerces node this instance represent.
Definition: XercesCommentWrapper.hpp:532
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.
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.
Definition: XercesCommentWrapper.hpp:38
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...
Definition: XercesWrapperNavigator.hpp:53
virtual void deleteData(unsigned int offset, unsigned int count)=0
Remove a range of characters from the node.
XERCES_CPP_NAMESPACE_QUALIFIER DOMComment DOMCommentType
Definition: XercesWrapperTypes.hpp:53
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