Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanCharacterData.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(XALANCHARACTERDATA_HEADER_GUARD_1357924680)
17 #define XALANCHARACTERDATA_HEADER_GUARD_1357924680
18 
19 
20 
23 
24 
25 
26 XALAN_CPP_NAMESPACE_BEGIN
27 
28 
29 
30 /*
31  * <meta name="usage" content="experimental"/>
32  *
33  * Base class for the DOM CharacterData interface.
34  *
35  * This class is experimental and subject to change!!
36  */
37 
39 {
40 public:
41 
43 
44  virtual
46 
47  // These interfaces are inherited from XalanNode...
48  virtual const XalanDOMString&
49  getNodeName() const = 0;
50 
54  virtual const XalanDOMString&
55  getNodeValue() const = 0;
56 
60  virtual NodeType
61  getNodeType() const = 0;
62 
72  virtual XalanNode*
73  getParentNode() const = 0;
74 
88  virtual const XalanNodeList*
89  getChildNodes() const = 0;
90 
96  virtual XalanNode*
97  getFirstChild() const = 0;
98 
104  virtual XalanNode*
105  getLastChild() const = 0;
106 
112  virtual XalanNode*
113  getPreviousSibling() const = 0;
114 
120  virtual XalanNode*
121  getNextSibling() const = 0;
122 
127  virtual const XalanNamedNodeMap*
128  getAttributes() const = 0;
129 
139  virtual XalanDocument*
140  getOwnerDocument() const = 0;
141 
143 
145 
164 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
165  virtual XalanNode*
166 #else
167  virtual XalanCharacterData*
168 #endif
169  cloneNode(bool deep) const = 0;
170 
172 
174 
191  virtual XalanNode*
192  insertBefore(
193  XalanNode* newChild,
194  XalanNode* refChild) = 0;
195 
209  virtual XalanNode*
210  replaceChild(
211  XalanNode* newChild,
212  XalanNode* oldChild) = 0;
213 
221  virtual XalanNode*
222  removeChild(XalanNode* oldChild) = 0;
223 
235  virtual XalanNode*
236  appendChild(XalanNode* newChild) = 0;
237 
239 
241 
249  virtual bool
250  hasChildNodes() const = 0;
251 
252 
254 
256 
270  virtual void
271  setNodeValue(const XalanDOMString& nodeValue) = 0;
272 
274 
276 
293  virtual void
294  normalize() = 0;
295 
309  virtual bool
310  isSupported(
311  const XalanDOMString& feature,
312  const XalanDOMString& version) const = 0;
313 
327  virtual const XalanDOMString&
328  getNamespaceURI() const = 0;
329 
334  virtual const XalanDOMString&
335  getPrefix() const = 0;
336 
344  virtual const XalanDOMString&
345  getLocalName() const = 0;
346 
376  virtual void
377  setPrefix(const XalanDOMString& prefix) = 0;
378 
384  virtual bool
385  isIndexed() const = 0;
386 
393  virtual IndexType
394  getIndex() const = 0;
395 
397 
398  // These interfaces are new to XalanCharacterData...
399 
418  virtual const XalanDOMString&
419  getData() const = 0;
420 
428  virtual unsigned int
429  getLength() const = 0;
430 
446  virtual XalanDOMString&
447  substringData(
448  unsigned int offset,
449  unsigned int count,
450  XalanDOMString& theResult) const = 0;
451 
453 
464  virtual void
465  appendData(const XalanDOMString& arg) = 0;
466 
477  virtual void
478  insertData(
479  unsigned int offset,
480  const XalanDOMString& arg) = 0;
481 
498  virtual void
499  deleteData(
500  unsigned int offset,
501  unsigned int count) = 0;
502 
521  virtual void
522  replaceData(
523  unsigned int offset,
524  unsigned int count,
525  const XalanDOMString& arg) = 0;
526 
528 
529 protected:
530 
531  XalanCharacterData(const XalanCharacterData& theSource);
532 
534  operator=(const XalanCharacterData& theSource);
535 
536  bool
537  operator==(const XalanCharacterData& theRHS) const;
538 
539 private:
540 };
541 
542 
543 
544 XALAN_CPP_NAMESPACE_END
545 
546 
547 
548 #endif // !defined(XALANCHARACTERDATA_HEADER_GUARD_1357924680)
Definition: XalanCharacterData.hpp:38
virtual const XalanNamedNodeMap * getAttributes() const =0
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise...
Definition: XalanNode.hpp:44
Definition: XalanNodeList.hpp:42
virtual XalanNode * cloneNode(bool deep) const =0
Returns a duplicate of this node.
virtual XalanNode * getLastChild() const =0
Gets the last child of this node.
XalanNode & operator=(const XalanNode &theSource)
virtual IndexType getIndex() const =0
Get the node's index.
virtual XalanNode * removeChild(XalanNode *oldChild)=0
Removes the child node indicated by oldChild from the list of children, and returns it...
virtual const XalanDOMString & getLocalName() const =0
Returns the local part of the qualified name of this node.
NodeType
Definition: XalanNode.hpp:53
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 void normalize()=0
Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes...
bool operator==(const XalanNode &theRHS) const
virtual const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node, or null if it is unspecified.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
#define XALAN_DOM_EXPORT
Definition: XalanDOMDefinitions.hpp:35
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 bool hasChildNodes() const =0
This is a convenience method to allow easy determination of whether a node has any children...
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...
virtual NodeType getNodeType() const =0
An enum value representing the type of the underlying object.
virtual const XalanNodeList * getChildNodes() const =0
Gets a NodeList that contains all children of this node.
Definition: XalanNamedNodeMap.hpp:42
virtual void setNodeValue(const XalanDOMString &nodeValue)=0
Sets the value of the node.
virtual XalanNode * insertBefore(XalanNode *newChild, XalanNode *refChild)=0
Inserts the node newChild before the existing child node refChild.
Definition: XalanDocument.hpp:51
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
virtual void setPrefix(const XalanDOMString &prefix)=0
Set the namespace prefix of this node.
virtual XalanDocument * getOwnerDocument() const =0
Gets the Document object associated with this node.
virtual XalanNode * appendChild(XalanNode *newChild)=0
Adds the node newChild to the end of the list of children of this node.
Definition: XalanDOMString.hpp:42
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
unsigned long IndexType
Definition: XalanNode.hpp:70
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node, or null if it is unspecified.
virtual const XalanDOMString & getNodeName() const =0

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