Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XercesTextBridge.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(XERCESTEXTBRIDGE_HEADER_GUARD_1357924680)
17 #define XERCESTEXTBRIDGE_HEADER_GUARD_1357924680
18 
19 
20 
22 
23 
24 
25 #if XERCES_VERSION_MAJOR >= 2
26 #include <xercesc/dom/deprecated/DOM_Text.hpp>
27 #else
28 #include <xercesc/dom/DOM_Text.hpp>
29 #endif
30 
31 
33 
34 
35 
37 
38 
39 
40 XALAN_CPP_NAMESPACE_BEGIN
41 
42 
43 
45 
46 
53 {
54 public:
55 
56  typedef XERCES_CPP_NAMESPACE_QUALIFIER DOM_Text DOM_TextType;
57 
59  const DOM_TextType& theXercesText,
60  const XercesBridgeNavigator& theNavigator);
61 
62  virtual
64 
65 
69  virtual const XalanDOMString&
70  getNodeName() const;
71 
75  virtual const XalanDOMString&
76  getNodeValue() const;
77 
81  virtual NodeType
82  getNodeType() const;
83 
93  virtual XalanNode*
94  getParentNode() const;
95 
109  virtual const XalanNodeList*
110  getChildNodes() const;
111 
117  virtual XalanNode*
118  getFirstChild() const;
119 
125  virtual XalanNode*
126  getLastChild() const;
127 
133  virtual XalanNode*
134  getPreviousSibling() const;
135 
141  virtual XalanNode*
142  getNextSibling() const;
143 
148  virtual const XalanNamedNodeMap*
149  getAttributes() const;
150 
160  virtual XalanDocument*
161  getOwnerDocument() const;
162 
164 
166 
185 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
186  virtual XalanNode*
187 #else
188  virtual XercesTextBridge*
189 #endif
190  cloneNode(bool deep) const;
191 
193 
195 
212  virtual XalanNode*
213  insertBefore(
214  XalanNode* newChild,
215  XalanNode* refChild);
216 
230  virtual XalanNode*
231  replaceChild(
232  XalanNode* newChild,
233  XalanNode* oldChild);
234 
242  virtual XalanNode*
243  removeChild(XalanNode* oldChild);
244 
256  virtual XalanNode*
257  appendChild(XalanNode* newChild);
258 
260 
262 
270  virtual bool
271  hasChildNodes() const;
272 
273 
275 
277 
278 
292  virtual void
293  setNodeValue(const XalanDOMString& nodeValue);
294 
296 
298 
315  virtual void
316  normalize();
317 
331  virtual bool
332  isSupported(
333  const XalanDOMString& feature,
334  const XalanDOMString& version) const;
335 
349  virtual const XalanDOMString&
350  getNamespaceURI() const;
351 
356  virtual const XalanDOMString&
357  getPrefix() const;
358 
366  virtual const XalanDOMString&
367  getLocalName() const;
368 
398  virtual void
399  setPrefix(const XalanDOMString& prefix);
400 
401  virtual bool
402  isIndexed() const;
403 
404  virtual IndexType
405  getIndex() const;
406 
408 
409  // These interfaces are inherited from XalanText...
410 
429  virtual const XalanDOMString&
430  getData() const;
431 
439  virtual unsigned int
440  getLength() const;
441 
457  virtual XalanDOMString
459  unsigned int offset,
460  unsigned int count) const;
461 
463 
474  virtual void
475  appendData(const XalanDOMString& arg);
476 
487  virtual void
488  insertData(
489  unsigned int offset,
490  const XalanDOMString& arg);
491 
508  virtual void
509  deleteData(
510  unsigned int offset,
511  unsigned int count);
512 
531  virtual void
532  replaceData(
533  unsigned int offset,
534  unsigned int count,
535  const XalanDOMString& arg);
536 
538 
540 
542 
560  virtual XalanText*
561  splitText(unsigned int offset);
562 
564 
565  virtual bool
566  isIgnorableWhitespace() const;
567 
575  {
576  return m_xercesNode;
577  }
578 
579 private:
580 
581  // Not implemented...
582  XercesTextBridge(const XercesTextBridge& theSource);
583 
585  operator=(const XercesTextBridge& theSource);
586 
587  bool
588  operator==(const XercesTextBridge& theRHS) const;
589 
590  // Data members...
591  XercesDOM_TextHack m_xercesNode;
592 
593  const XercesBridgeNavigator& m_navigator;
594 };
595 
596 
597 
598 XALAN_CPP_NAMESPACE_END
599 
600 
601 
602 #endif // !defined(XERCESTEXTBRIDGE_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.
This class is deprecated.
Definition: XercesTextBridge.hpp:52
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...
#define XALAN_XERCESPARSERLIAISON_EXPORT
Definition: XercesParserLiaisonDefinitions.hpp:37
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.
XERCES_CPP_NAMESPACE_QUALIFIER DOM_Text DOM_TextType
Definition: XercesTextBridge.hpp:56
virtual XalanText * cloneNode(bool deep) const =0
Returns a duplicate of this node.
Definition: XercesDOM_NodeHack.hpp:161
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.
DOM_TextType getXercesNode() const
Get the Xerces node this instance represent.
Definition: XercesTextBridge.hpp:574
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...
This class is deprecated.
Definition: XercesBridgeNavigator.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