Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanCDATASection.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(XALANCDATASECTION_HEADER_GUARD_1357924680)
17 #define XALANCDATASECTION_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 CDATASection 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 XalanCDATASection*
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 
257 
271  virtual void
272  setNodeValue(const XalanDOMString& nodeValue) = 0;
273 
275 
277 
294  virtual void
295  normalize() = 0;
296 
310  virtual bool
311  isSupported(
312  const XalanDOMString& feature,
313  const XalanDOMString& version) const = 0;
314 
328  virtual const XalanDOMString&
329  getNamespaceURI() const = 0;
330 
335  virtual const XalanDOMString&
336  getPrefix() const = 0;
337 
345  virtual const XalanDOMString&
346  getLocalName() const = 0;
347 
377  virtual void
378  setPrefix(const XalanDOMString& prefix) = 0;
379 
385  virtual bool
386  isIndexed() const = 0;
387 
394  virtual IndexType
395  getIndex() const = 0;
396 
398 
399  // These interfaces are inherited from XalanCharacterData...
400 
419  virtual const XalanDOMString&
420  getData() const = 0;
421 
429  virtual unsigned int
430  getLength() const = 0;
431 
447  virtual XalanDOMString&
449  unsigned int offset,
450  unsigned int count,
451  XalanDOMString& theResult) const = 0;
452 
454 
465  virtual void
466  appendData(const XalanDOMString& arg) = 0;
467 
478  virtual void
479  insertData(
480  unsigned int offset,
481  const XalanDOMString& arg) = 0;
482 
499  virtual void
500  deleteData(
501  unsigned int offset,
502  unsigned int count) = 0;
503 
522  virtual void
523  replaceData(
524  unsigned int offset,
525  unsigned int count,
526  const XalanDOMString& arg) = 0;
527 
529 
530  // These interfaces are inherited from XalanText...
531 
533 
535 
553  virtual XalanText*
554  splitText(unsigned int offset) = 0;
555 
557 
558  virtual bool
559  isIgnorableWhitespace() const = 0;
560 
561 protected:
562 
563  XalanCDATASection(const XalanCDATASection& theSource);
564 
566  operator=(const XalanCDATASection& theSource);
567 
568  bool
569  operator==(const XalanCDATASection& theRHS) const;
570 
571 private:
572 };
573 
574 
575 
576 XALAN_CPP_NAMESPACE_END
577 
578 
579 
580 #endif // !defined(XALANCDATASECTION_HEADER_GUARD_1357924680)
virtual unsigned int getLength() const =0
Returns the number of characters that are available through data and the substringData method below...
virtual const XalanDOMString & getNodeName() const =0
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 const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node, or null if it is unspecified.
Definition: XalanNode.hpp:44
Definition: XalanNodeList.hpp:42
virtual XalanDocument * getOwnerDocument() const =0
Gets the Document object associated with this node.
Definition: XalanText.hpp:38
virtual void normalize()=0
Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes...
virtual void setPrefix(const XalanDOMString &prefix)=0
Set the namespace prefix of 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 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 XalanText * splitText(unsigned int offset)=0
Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings...
NodeType
Definition: XalanNode.hpp:53
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...
Definition: XalanCDATASection.hpp:38
#define XALAN_DOM_EXPORT
Definition: XalanDOMDefinitions.hpp:35
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 XalanNode * getFirstChild() const =0
Gets the first child of this node.
virtual XalanText * cloneNode(bool deep) const =0
Returns a duplicate of this node.
Definition: XalanNamedNodeMap.hpp:42
virtual IndexType getIndex() const =0
Get the node's index.
virtual void deleteData(unsigned int offset, unsigned int count)=0
Remove a range of characters from the node.
virtual XalanNode * appendChild(XalanNode *newChild)=0
Adds the node newChild to the end of the list of children of this node.
virtual bool hasChildNodes() const =0
This is a convenience method to allow easy determination of whether a node has any children...
Definition: XalanDocument.hpp:51
virtual XalanNode * getParentNode() const =0
Gets the parent 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 appendData(const XalanDOMString &arg)=0
Append the string to the end of the character data of the node.
virtual const XalanDOMString & getData() const =0
Returns the character data of the node that implements this interface.
virtual bool isIgnorableWhitespace() const =0
Determine whether the text node instance is composed entirely of XML whitespace.
virtual void insertData(unsigned int offset, const XalanDOMString &arg)=0
Insert a string at the specified character offset.
bool operator==(const XalanText &theRHS) const
virtual XalanNode * removeChild(XalanNode *oldChild)=0
Removes the child node indicated by oldChild from the list of children, and returns it...
Definition: XalanDOMString.hpp:42
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
unsigned long IndexType
Definition: XalanNode.hpp:70
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...
XalanText & operator=(const XalanText &theSource)
virtual void setNodeValue(const XalanDOMString &nodeValue)=0
Sets the value of the node.
virtual XalanNode * getLastChild() const =0
Gets the last child of this node.
virtual XalanNode * insertBefore(XalanNode *newChild, XalanNode *refChild)=0
Inserts the node newChild before the existing child node refChild.

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