Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XalanSourceTreeText.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(XALANSOURCETREETEXT_HEADER_GUARD_1357924680)
19 #define XALANSOURCETREETEXT_HEADER_GUARD_1357924680
20 
21 
22 
24 
25 
26 
28 
29 
30 
32 
33 
34 
35 XALAN_CPP_NAMESPACE_BEGIN
36 
37 
38 
43 
44 
45 
47 {
48 public:
49 
50  /**
51  * Perform static initialization. See class XalanSourceTreeInit.
52  */
53  static void
54  initialize(MemoryManager& theManager);
55 
56  /**
57  * Perform static shut down. See class XalanSourceTreeInit.
58  */
59  static void
60  terminate();
61 
62  /**
63  * Constructor.
64  *
65  * @param theData The text data of the node
66  * @param isWhitespace true if the text data is only whitespace
67  * @param theParentNode The parent node, if any.
68  * @param thePreviousSibling The previous sibling, if any.
69  * @param theNextSibling The next sibling, if any.
70  * @param theIndex The document-order index of the node.
71  */
73  const XalanDOMString& theData,
74  XalanNode* theParentNode = 0,
75  XalanNode* thePreviousSibling = 0,
76  XalanNode* theNextSibling = 0,
77  IndexType theIndex = 0);
78 
79  virtual
81 
82 
83  // These interfaces are inherited from XalanText...
84 
85  virtual const XalanDOMString&
86  getNodeName() const;
87 
88  virtual const XalanDOMString&
89  getNodeValue() const;
90 
91  virtual NodeType
92  getNodeType() const;
93 
94  virtual XalanNode*
95  getParentNode() const;
96 
97  virtual const XalanNodeList*
98  getChildNodes() const;
99 
100  virtual XalanNode*
101  getFirstChild() const;
102 
103  virtual XalanNode*
104  getLastChild() const;
105 
106  virtual XalanNode*
107  getPreviousSibling() const;
108 
109  virtual XalanNode*
110  getNextSibling() const;
111 
112  virtual const XalanNamedNodeMap*
113  getAttributes() const;
114 
115  virtual XalanDocument*
116  getOwnerDocument() const;
117 
118  virtual const XalanDOMString&
119  getNamespaceURI() const;
120 
121  virtual const XalanDOMString&
122  getPrefix() const;
123 
124  virtual const XalanDOMString&
125  getLocalName() const;
126 
127  virtual bool
128  isIndexed() const;
129 
130  virtual IndexType
131  getIndex() const;
132 
133  virtual const XalanDOMString&
134  getData() const;
135 
136  virtual bool
137  isWhitespace() const;
138 
139 
140  // public interfaces not inherited from XalanText...
141 
142  void
143  setParent(XalanSourceTreeElement* theParent);
144 
145  void
146  setParent(XalanSourceTreeDocumentFragment* theParent);
147 
148  void
149  setPreviousSibling(XalanSourceTreeComment* thePreviousSibling);
150 
151  void
152  setPreviousSibling(XalanSourceTreeElement* thePreviousSibling);
153 
154  void
155  setPreviousSibling(XalanSourceTreeProcessingInstruction* thePreviousSibling);
156 
157  void
158  setPreviousSibling(XalanSourceTreeText* thePreviousSibling);
159 
160  void
161  appendSiblingNode(XalanSourceTreeComment* theSibling);
162 
163  void
164  appendSiblingNode(XalanSourceTreeElement* theSibling);
165 
166  void
167  appendSiblingNode(XalanSourceTreeProcessingInstruction* theSibling);
168 
169  void
170  appendSiblingNode(XalanSourceTreeText* theSibling);
171 
172  void
173  setIndex(IndexType theIndex)
174  {
175  m_index = theIndex;
176  }
177 
178 private:
179 
180  // Not implemented...
182 
184  operator=(const XalanSourceTreeText& theSource);
185 
186  bool
187  operator==(const XalanSourceTreeText& theRHS) const;
188 
189 
190  // Data members...
191  const XalanDOMString& m_data;
192 
193  XalanNode* m_parentNode;
194 
195  XalanNode* m_previousSibling;
196 
197  XalanNode* m_nextSibling;
198 
199  IndexType m_index;
200 
201  static const XalanDOMString& s_nameString;
202 };
203 
204 
205 
206 XALAN_CPP_NAMESPACE_END
207 
208 
209 
210 #endif // !defined(XALANSOURCETREETEXT_HEADER_GUARD_1357924680)
virtual const XalanDOMString & getNodeName() const =0
Gets the name of this node, depending on its type.
virtual const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node, or null if it is unspecified.
virtual NodeType getNodeType() const =0
An enum value representing the type of the underlying object.
virtual bool isWhitespace() const =0
Determine whether the text node instance is composed entirely of XML whitespace.
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node, or null if it is unspecified.
virtual XalanDocument * getOwnerDocument() const =0
Gets the Document object associated with this node.
virtual const XalanDOMString & getNodeValue() const =0
Gets the value of this node, depending on its type.
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
virtual const XalanDOMString & getLocalName() const =0
Returns the local part of the qualified name of this node.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
virtual const XalanNodeList * getChildNodes() const =0
Gets a NodeList that contains all children 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...
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
void setIndex(IndexType theIndex)
#define XALAN_XALANSOURCETREE_EXPORT
virtual IndexType getIndex() const =0
Get the node's index.
virtual XalanNode * getParentNode() const =0
Gets the parent of this node.
virtual const XalanDOMString & getData() const =0
Returns the character data of the node that implements this interface.
bool operator==(const XalanText &theRHS) const
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
unsigned long IndexType
Definition: XalanNode.hpp:64
XalanText & operator=(const XalanText &theSource)
virtual XalanNode * getLastChild() const =0
Gets the last child 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