Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanEntity.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(XALANENTITY_HEADER_GUARD_1357924680)
17 #define XALANENTITY_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 Entity interface.
34  *
35  * This class is experimental and subject to change!!
36  */
37 
39 {
40 public:
41 
42  XalanEntity();
43 
44  virtual
45  ~XalanEntity();
46 
47 
48  // These interfaces are inherited from XalanNode...
49 
50  virtual const XalanDOMString&
51  getNodeName() const = 0;
52 
56  virtual const XalanDOMString&
57  getNodeValue() const = 0;
58 
62  virtual NodeType
63  getNodeType() const = 0;
64 
74  virtual XalanNode*
75  getParentNode() const = 0;
76 
90  virtual const XalanNodeList*
91  getChildNodes() const = 0;
92 
98  virtual XalanNode*
99  getFirstChild() const = 0;
100 
106  virtual XalanNode*
107  getLastChild() const = 0;
108 
114  virtual XalanNode*
115  getPreviousSibling() const = 0;
116 
122  virtual XalanNode*
123  getNextSibling() const = 0;
124 
129  virtual const XalanNamedNodeMap*
130  getAttributes() const = 0;
131 
141  virtual XalanDocument*
142  getOwnerDocument() const = 0;
143 
145 
147 
166  virtual XalanNode*
167  cloneNode(bool deep) const = 0;
168 
170 
172 
189  virtual XalanNode*
190  insertBefore(
191  XalanNode* newChild,
192  XalanNode* refChild) = 0;
193 
207  virtual XalanNode*
208  replaceChild(
209  XalanNode* newChild,
210  XalanNode* oldChild) = 0;
211 
219  virtual XalanNode*
220  removeChild(XalanNode* oldChild) = 0;
221 
233  virtual XalanNode*
234  appendChild(XalanNode* newChild) = 0;
235 
237 
239 
247  virtual bool
248  hasChildNodes() const = 0;
249 
250 
252 
254 
255 
269  virtual void
270  setNodeValue(const XalanDOMString& nodeValue) = 0;
271 
273 
275 
292  virtual void
293  normalize() = 0;
294 
308  virtual bool
309  isSupported(
310  const XalanDOMString& feature,
311  const XalanDOMString& version) const = 0;
312 
326  virtual const XalanDOMString&
327  getNamespaceURI() const = 0;
328 
333  virtual const XalanDOMString&
334  getPrefix() const = 0;
335 
343  virtual const XalanDOMString&
344  getLocalName() const = 0;
345 
375  virtual void
376  setPrefix(const XalanDOMString& prefix) = 0;
377 
383  virtual bool
384  isIndexed() const = 0;
385 
392  virtual IndexType
393  getIndex() const = 0;
394 
396 
397  // These interfaces are new to XalanEntity...
398 
406  virtual const XalanDOMString&
407  getPublicId() const = 0;
408 
416  virtual const XalanDOMString&
417  getSystemId() const = 0;
418 
424  virtual const XalanDOMString&
425  getNotationName() const = 0;
426 
427 protected:
428 
429  XalanEntity(const XalanEntity& theSource);
430 
431  XalanEntity&
432  operator=(const XalanEntity& theSource);
433 
434  bool
435  operator==(const XalanEntity& theRHS) const;
436 
437 private:
438 };
439 
440 
441 
442 XALAN_CPP_NAMESPACE_END
443 
444 
445 
446 #endif // !defined(XALANENTITY_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
Definition: XalanEntity.hpp:38
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