Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XalanSourceTreeComment.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
19 #define XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680
20 
21 
22 
24 
25 
26 
28 
29 
30 
32 
33 
34 
35 XALAN_CPP_NAMESPACE_BEGIN
36 
37 
38 
44 
45 
46 
48 {
49 public:
50 
51  /**
52  * Perform static initialization. See class XalanSourceTreeInit.
53  */
54  static void
55  initialize(MemoryManager& theManager);
56 
57  /**
58  * Perform static shut down. See class XalanSourceTreeInit.
59  */
60  static void
61  terminate();
62 
63 
64  /**
65  * Constructor.
66  *
67  * @param theData The text data of the node.
68  * @param theOwnerDocument The owner document of the comment node.
69  * @param theParentNode The parent node, if any.
70  * @param thePreviousSibling The previous sibling, if any.
71  * @param theNextSibling The next sibling, if any.
72  * @param theIndex The document-order index of the node.
73  */
75  const XalanDOMString& theData,
76  XalanSourceTreeDocument* theOwnerDocument,
77  XalanNode* theParentNode = 0,
78  XalanNode* thePreviousSibling = 0,
79  XalanNode* theNextSibling = 0,
80  IndexType theIndex = 0);
81 
82  virtual
84 
85  // These interfaces are inherited from XalanComment
86  virtual const XalanDOMString&
87  getNodeName() const;
88 
89  virtual const XalanDOMString&
90  getNodeValue() const;
91 
92  virtual NodeType
93  getNodeType() const;
94 
95  virtual XalanNode*
96  getParentNode() const;
97 
98  virtual const XalanNodeList*
99  getChildNodes() const;
100 
101  virtual XalanNode*
102  getFirstChild() const;
103 
104  virtual XalanNode*
105  getLastChild() const;
106 
107  virtual XalanNode*
108  getPreviousSibling() const;
109 
110  virtual XalanNode*
111  getNextSibling() const;
112 
113  virtual const XalanNamedNodeMap*
114  getAttributes() const;
115 
116  virtual XalanDocument*
117  getOwnerDocument() const;
118 
119  virtual const XalanDOMString&
120  getNamespaceURI() const;
121 
122  virtual const XalanDOMString&
123  getPrefix() const;
124 
125  virtual const XalanDOMString&
126  getLocalName() const;
127 
128  virtual bool
129  isIndexed() const;
130 
131  virtual IndexType
132  getIndex() const;
133 
134  virtual const XalanDOMString&
135  getData() const;
136 
137  // public interfaces not inherited from XalanComment...
138 
139  void
140  setParent(XalanSourceTreeElement* theParent);
141 
142  void
143  setParent(XalanSourceTreeDocumentFragment* theParent);
144 
145  void
146  setPreviousSibling(XalanSourceTreeComment* thePreviousSibling);
147 
148  void
149  setPreviousSibling(XalanSourceTreeElement* thePreviousSibling);
150 
151  void
152  setPreviousSibling(XalanSourceTreeProcessingInstruction* thePreviousSibling);
153 
154  void
155  setPreviousSibling(XalanSourceTreeText* thePreviousSibling);
156 
157  void
158  appendSiblingNode(XalanSourceTreeComment* theSibling);
159 
160  void
161  appendSiblingNode(XalanSourceTreeElement* theSibling);
162 
163  void
164  appendSiblingNode(XalanSourceTreeProcessingInstruction* theSibling);
165 
166  void
167  appendSiblingNode(XalanSourceTreeText* theSibling);
168 
169  void
170  setIndex(IndexType theIndex)
171  {
172  m_index = theIndex;
173  }
174 
175 private:
176 
177  // Not implemented...
179 
181  operator=(const XalanSourceTreeComment& theSource);
182 
183  bool
184  operator==(const XalanSourceTreeComment& theRHS) const;
185 
186 
187  // Data members...
188  const XalanDOMString& m_data;
189 
190  XalanSourceTreeDocument* m_ownerDocument;
191 
192  XalanNode* m_parentNode;
193 
194  XalanNode* m_previousSibling;
195 
196  XalanNode* m_nextSibling;
197 
198  IndexType m_index;
199 
200  static const XalanDOMString& s_nameString;
201 };
202 
203 
204 
205 XALAN_CPP_NAMESPACE_END
206 
207 
208 
209 #endif // !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
XalanComment & operator=(const XalanComment &theSource)
virtual XalanDocument * getOwnerDocument() const =0
Gets the XalanDocument object associated with this node.
virtual const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node.
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 XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null ...
virtual const XalanDOMString & getNodeName() const =0
Gets the name of this node, depending on its type.
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
bool operator==(const XalanComment &theRHS) const
#define XALAN_XALANSOURCETREE_EXPORT
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
virtual const XalanDOMString & getNodeValue() const =0
Gets the value of this node, depending on its type.
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 IndexType getIndex() const =0
Get the node's index.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node.
virtual const XalanDOMString & getData() const =0
Returns the character data of the node that implements this interface.
unsigned long IndexType
Definition: XalanNode.hpp:64
void setIndex(IndexType theIndex)
virtual const XalanNodeList * getChildNodes() const =0
Gets a XalanNodeList that contains all children of this node.

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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo