Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanDocumentType.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(XALANDOCUMENTTYPE_HEADER_GUARD_1357924680)
17 #define XALANDOCUMENTTYPE_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 DocumentType interface.
34  *
35  * This class is experimental and subject to change!!
36  */
37 
39 {
40 public:
41 
43 
44  virtual
46 
47 
48  // These interfaces are inherited from XalanNode...
49 
53  virtual const XalanDOMString&
54  getNodeName() const = 0;
55 
59  virtual const XalanDOMString&
60  getNodeValue() const = 0;
61 
65  virtual NodeType
66  getNodeType() const = 0;
67 
77  virtual XalanNode*
78  getParentNode() const = 0;
79 
93  virtual const XalanNodeList*
94  getChildNodes() const = 0;
95 
101  virtual XalanNode*
102  getFirstChild() const = 0;
103 
109  virtual XalanNode*
110  getLastChild() const = 0;
111 
117  virtual XalanNode*
118  getPreviousSibling() const = 0;
119 
125  virtual XalanNode*
126  getNextSibling() const = 0;
127 
132  virtual const XalanNamedNodeMap*
133  getAttributes() const = 0;
134 
144  virtual XalanDocument*
145  getOwnerDocument() const = 0;
146 
148 
150 
169  virtual XalanNode*
170  cloneNode(bool deep) const = 0;
171 
173 
175 
192  virtual XalanNode*
193  insertBefore(
194  XalanNode* newChild,
195  XalanNode* refChild) = 0;
196 
210  virtual XalanNode*
211  replaceChild(
212  XalanNode* newChild,
213  XalanNode* oldChild) = 0;
214 
222  virtual XalanNode*
223  removeChild(XalanNode* oldChild) = 0;
224 
236  virtual XalanNode*
237  appendChild(XalanNode* newChild) = 0;
238 
240 
242 
250  virtual bool
251  hasChildNodes() const = 0;
252 
253 
255 
257 
258 
272  virtual void
273  setNodeValue(const XalanDOMString& nodeValue) = 0;
274 
276 
278 
295  virtual void
296  normalize() = 0;
297 
311  virtual bool
312  isSupported(
313  const XalanDOMString& feature,
314  const XalanDOMString& version) const = 0;
315 
329  virtual const XalanDOMString&
330  getNamespaceURI() const = 0;
331 
336  virtual const XalanDOMString&
337  getPrefix() const = 0;
338 
346  virtual const XalanDOMString&
347  getLocalName() const = 0;
348 
378  virtual void
379  setPrefix(const XalanDOMString& prefix) = 0;
380 
386  virtual bool
387  isIndexed() const = 0;
388 
395  virtual IndexType
396  getIndex() const = 0;
397 
399 
400  // These interfaces are new to XalanDocumentType...
401 
404 
409  virtual const XalanDOMString&
410  getName() const = 0;
411 
417  virtual const XalanNamedNodeMap*
418  getEntities() const = 0;
419 
424  virtual const XalanNamedNodeMap*
425  getNotations() const = 0;
427 
434  virtual const XalanDOMString&
435  getPublicId() const = 0;
436 
441  virtual const XalanDOMString&
442  getSystemId() const = 0;
443 
448  virtual const XalanDOMString&
449  getInternalSubset() const = 0;
451 
452 protected:
453 
454  XalanDocumentType(const XalanDocumentType& theSource);
455 
457  operator=(const XalanDocumentType& theSource);
458 
459  bool
460  operator==(const XalanDocumentType& theRHS) const;
461 
462 private:
463 };
464 
465 
466 
467 XALAN_CPP_NAMESPACE_END
468 
469 
470 
471 #endif // !defined(XALANDOCUMENTTYPE_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.
Definition: XalanDocumentType.hpp:38
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