Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanNotation.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(XALANNOTATION_HEADER_GUARD_1357924680)
17 #define XALANNOTATION_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 Notation interface.
34  *
35  * This class is experimental and subject to change!!
36  */
37 
39 {
40 public:
41 
42  XalanNotation();
43 
44  virtual
45  ~XalanNotation();
46 
47 
48  // These interfaces are inherited from XalanNode...
49  virtual const XalanDOMString&
50  getNodeName() const = 0;
51 
55  virtual const XalanDOMString&
56  getNodeValue() const = 0;
57 
61  virtual NodeType
62  getNodeType() const = 0;
63 
73  virtual XalanNode*
74  getParentNode() const = 0;
75 
89  virtual const XalanNodeList*
90  getChildNodes() const = 0;
91 
97  virtual XalanNode*
98  getFirstChild() const = 0;
99 
105  virtual XalanNode*
106  getLastChild() const = 0;
107 
113  virtual XalanNode*
114  getPreviousSibling() const = 0;
115 
121  virtual XalanNode*
122  getNextSibling() const = 0;
123 
128  virtual const XalanNamedNodeMap*
129  getAttributes() const = 0;
130 
140  virtual XalanDocument*
141  getOwnerDocument() const = 0;
142 
144 
146 
165  virtual XalanNode*
166  cloneNode(bool deep) const = 0;
167 
169 
171 
188  virtual XalanNode*
189  insertBefore(
190  XalanNode* newChild,
191  XalanNode* refChild) = 0;
192 
206  virtual XalanNode*
207  replaceChild(
208  XalanNode* newChild,
209  XalanNode* oldChild) = 0;
210 
218  virtual XalanNode*
219  removeChild(XalanNode* oldChild) = 0;
220 
232  virtual XalanNode*
233  appendChild(XalanNode* newChild) = 0;
234 
236 
238 
246  virtual bool
247  hasChildNodes() const = 0;
248 
249 
251 
253 
254 
268  virtual void
269  setNodeValue(const XalanDOMString& nodeValue) = 0;
270 
272 
274 
291  virtual void
292  normalize() = 0;
293 
307  virtual bool
308  isSupported(
309  const XalanDOMString& feature,
310  const XalanDOMString& version) const = 0;
311 
325  virtual const XalanDOMString&
326  getNamespaceURI() const = 0;
327 
332  virtual const XalanDOMString&
333  getPrefix() const = 0;
334 
342  virtual const XalanDOMString&
343  getLocalName() const = 0;
344 
374  virtual void
375  setPrefix(const XalanDOMString& prefix) = 0;
376 
382  virtual bool
383  isIndexed() const = 0;
384 
391  virtual IndexType
392  getIndex() const = 0;
393 
395 
396  // These interfaces are new to XalanNotation...
397 
405  virtual const XalanDOMString&
406  getPublicId() const = 0;
407 
415  virtual const XalanDOMString&
416  getSystemId() const = 0;
417 
418 protected:
419 
420  XalanNotation(const XalanNotation& theSource);
421 
423  operator=(const XalanNotation& theSource);
424 
425  bool
426  operator==(const XalanNotation& theRHS) const;
427 
428 private:
429 };
430 
431 
432 
433 XALAN_CPP_NAMESPACE_END
434 
435 
436 
437 #endif // !defined(XALANNOTATION_HEADER_GUARD_1357924680)
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.
Definition: XalanNotation.hpp:38
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