Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XercesTextWrapper.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(XERCESTEXTWRAPPER_HEADER_GUARD_1357924680)
17 #define XERCESTEXTWRAPPER_HEADER_GUARD_1357924680
18 
19 
20 
22 
23 
24 
26 
27 
28 
30 
31 
32 
33 XALAN_CPP_NAMESPACE_BEGIN
34 
35 
36 
38 
39 
40 
42 {
43 public:
44 
46  const DOMTextType* theXercesText,
47  const XercesWrapperNavigator& theNavigator);
48 
49  virtual
51 
52 
56  virtual const XalanDOMString&
57  getNodeName() const;
58 
62  virtual const XalanDOMString&
63  getNodeValue() const;
64 
68  virtual NodeType
69  getNodeType() const;
70 
80  virtual XalanNode*
81  getParentNode() const;
82 
96  virtual const XalanNodeList*
97  getChildNodes() const;
98 
104  virtual XalanNode*
105  getFirstChild() const;
106 
112  virtual XalanNode*
113  getLastChild() const;
114 
120  virtual XalanNode*
121  getPreviousSibling() const;
122 
128  virtual XalanNode*
129  getNextSibling() const;
130 
135  virtual const XalanNamedNodeMap*
136  getAttributes() const;
137 
147  virtual XalanDocument*
148  getOwnerDocument() const;
149 
151 
153 
172 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
173  virtual XalanNode*
174 #else
175  virtual XercesTextWrapper*
176 #endif
177  cloneNode(bool deep) const;
178 
180 
182 
199  virtual XalanNode*
200  insertBefore(
201  XalanNode* newChild,
202  XalanNode* refChild);
203 
217  virtual XalanNode*
218  replaceChild(
219  XalanNode* newChild,
220  XalanNode* oldChild);
221 
229  virtual XalanNode*
230  removeChild(XalanNode* oldChild);
231 
243  virtual XalanNode*
244  appendChild(XalanNode* newChild);
245 
247 
249 
257  virtual bool
258  hasChildNodes() const;
259 
260 
262 
264 
265 
279  virtual void
280  setNodeValue(const XalanDOMString& nodeValue);
281 
283 
285 
302  virtual void
303  normalize();
304 
318  virtual bool
319  isSupported(
320  const XalanDOMString& feature,
321  const XalanDOMString& version) const;
322 
336  virtual const XalanDOMString&
337  getNamespaceURI() const;
338 
343  virtual const XalanDOMString&
344  getPrefix() const;
345 
353  virtual const XalanDOMString&
354  getLocalName() const;
355 
385  virtual void
386  setPrefix(const XalanDOMString& prefix);
387 
388  virtual bool
389  isIndexed() const;
390 
391  virtual IndexType
392  getIndex() const;
393 
395 
396  // These interfaces are inherited from XalanText...
397 
416  virtual const XalanDOMString&
417  getData() const;
418 
426  virtual unsigned int
427  getLength() const;
428 
444  virtual XalanDOMString&
446  unsigned int offset,
447  unsigned int count,
448  XalanDOMString& theResult) const;
449 
451 
462  virtual void
463  appendData(const XalanDOMString& arg);
464 
475  virtual void
476  insertData(
477  unsigned int offset,
478  const XalanDOMString& arg);
479 
496  virtual void
497  deleteData(
498  unsigned int offset,
499  unsigned int count);
500 
519  virtual void
520  replaceData(
521  unsigned int offset,
522  unsigned int count,
523  const XalanDOMString& arg);
524 
526 
528 
530 
548  virtual XalanText*
549  splitText(unsigned int offset);
550 
552 
553  virtual bool
554  isIgnorableWhitespace() const;
555 
561  const DOMTextType*
563  {
564  return m_xercesNode;
565  }
566 
567 private:
568 
569  // Not implemented...
570  XercesTextWrapper(const XercesTextWrapper& theSource);
571 
573  operator=(const XercesTextWrapper& theSource);
574 
575  bool
576  operator==(const XercesTextWrapper& theRHS) const;
577 
578  // Data members...
579  const DOMTextType* const m_xercesNode;
580 
581  const XercesWrapperNavigator& m_navigator;
582 };
583 
584 
585 
586 XALAN_CPP_NAMESPACE_END
587 
588 
589 
590 #endif // !defined(XERCESTEXTWRAPPER_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.
Definition: XercesTextWrapper.hpp:41
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...
#define XALAN_XERCESPARSERLIAISON_EXPORT
Definition: XercesParserLiaisonDefinitions.hpp:37
XERCES_CPP_NAMESPACE_QUALIFIER DOMText DOMTextType
Definition: XercesWrapperTypes.hpp:64
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...
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.
const DOMTextType * getXercesNode() const
Get the Xerces node this instance represent.
Definition: XercesTextWrapper.hpp:562
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...
Definition: XercesWrapperNavigator.hpp:53
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