Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanSourceTreeProcessingInstruction.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(XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680)
17 #define XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680
18 
19 
20 
22 
23 
24 
26 
27 
28 
30 
31 
32 
33 XALAN_CPP_NAMESPACE_BEGIN
34 
35 
36 
42 
43 
44 
46 {
47 public:
48 
63  const XalanDOMString& theTarget,
64  const XalanDOMString& theData,
65  XalanSourceTreeDocument* theOwnerDocument,
66  XalanNode* theParentNode = 0,
67  XalanNode* thePreviousSibling = 0,
68  XalanNode* theNextSibling = 0,
69  IndexType theIndex = 0);
70 
71  virtual
73 
74 
75  // These interfaces are inherited from XalanNode...
76 
77  virtual const XalanDOMString&
78  getNodeName() const;
79 
83  virtual const XalanDOMString&
84  getNodeValue() const;
85 
89  virtual NodeType
90  getNodeType() const;
91 
101  virtual XalanNode*
102  getParentNode() const;
103 
117  virtual const XalanNodeList*
118  getChildNodes() const;
119 
125  virtual XalanNode*
126  getFirstChild() const;
127 
133  virtual XalanNode*
134  getLastChild() const;
135 
141  virtual XalanNode*
142  getPreviousSibling() const;
143 
149  virtual XalanNode*
150  getNextSibling() const;
151 
156  virtual const XalanNamedNodeMap*
157  getAttributes() const;
158 
168  virtual XalanDocument*
169  getOwnerDocument() const;
170 
172 
174 
193 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
194  virtual XalanNode*
195 #else
197 #endif
198  cloneNode(bool deep) const;
199 
201 
203 
220  virtual XalanNode*
221  insertBefore(
222  XalanNode* newChild,
223  XalanNode* refChild);
224 
238  virtual XalanNode*
239  replaceChild(
240  XalanNode* newChild,
241  XalanNode* oldChild);
242 
250  virtual XalanNode*
251  removeChild(XalanNode* oldChild);
252 
264  virtual XalanNode*
265  appendChild(XalanNode* newChild);
266 
268 
270 
278  virtual bool
279  hasChildNodes() const;
280 
281 
283 
285 
286 
300  virtual void
301  setNodeValue(const XalanDOMString& nodeValue);
302 
304 
306 
323  virtual void
324  normalize();
325 
339  virtual bool
340  isSupported(
341  const XalanDOMString& feature,
342  const XalanDOMString& version) const;
343 
357  virtual const XalanDOMString&
358  getNamespaceURI() const;
359 
364  virtual const XalanDOMString&
365  getPrefix() const;
366 
374  virtual const XalanDOMString&
375  getLocalName() const;
376 
406  virtual void
407  setPrefix(const XalanDOMString& prefix);
408 
409  virtual bool
410  isIndexed() const;
411 
412  virtual IndexType
413  getIndex() const;
414 
416 
417  // These interfaces are inherited from XalanProcessingInstruction...
418 
420 
428  virtual const XalanDOMString&
429  getTarget() const;
430 
440  virtual const XalanDOMString&
441  getData() const;
442 
444 
454  virtual void
455  setData(const XalanDOMString& data);
457 
458 
459  // public interfaces not inherited from XalanProcessingInstruction...
460 
461  void
462  setParent(XalanSourceTreeElement* theParent);
463 
464  void
465  setParent(XalanSourceTreeDocumentFragment* theParent);
466 
467  void
468  setPreviousSibling(XalanSourceTreeComment* thePreviousSibling);
469 
470  void
471  setPreviousSibling(XalanSourceTreeElement* thePreviousSibling);
472 
473  void
474  setPreviousSibling(XalanSourceTreeProcessingInstruction* thePreviousSibling);
475 
476  void
477  setPreviousSibling(XalanSourceTreeText* thePreviousSibling);
478 
479  void
480  appendSiblingNode(XalanSourceTreeComment* theSibling);
481 
482  void
483  appendSiblingNode(XalanSourceTreeElement* theSibling);
484 
485  void
486  appendSiblingNode(XalanSourceTreeProcessingInstruction* theSibling);
487 
488  void
489  appendSiblingNode(XalanSourceTreeText* theSibling);
490 
491  void
492  setIndex(IndexType theIndex)
493  {
494  m_index = theIndex;
495  }
496 
497 protected:
498 
500  const XalanSourceTreeProcessingInstruction& theSource,
501  bool deep = false);
502 
503 private:
504 
505  // Not implemented...
508 
509  bool
511 
512 
513  // Data members...
514  const XalanDOMString& m_target;
515 
516  const XalanDOMString& m_data;
517 
518  XalanSourceTreeDocument* m_ownerDocument;
519 
520  XalanNode* m_parentNode;
521 
522  XalanNode* m_previousSibling;
523 
524  XalanNode* m_nextSibling;
525 
526  IndexType m_index;
527 };
528 
529 
530 
531 XALAN_CPP_NAMESPACE_END
532 
533 
534 
535 #endif // !defined(XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680)
virtual XalanDocument * getOwnerDocument() const =0
Gets the Document object associated with this node.
virtual const XalanDOMString & getTarget() const =0
The target of this processing instruction.
Definition: XalanNode.hpp:44
Definition: XalanNodeList.hpp:42
virtual XalanNode * insertBefore(XalanNode *newChild, XalanNode *refChild)=0
Inserts the node newChild before the existing child node refChild.
virtual const XalanDOMString & getData() const =0
The content of this processing instruction.
virtual const XalanNodeList * getChildNodes() const =0
Gets a NodeList that contains all children of this node.
virtual const XalanDOMString & getNodeValue() const =0
Gets the value of this node, depending on its type.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
virtual XalanNode * removeChild(XalanNode *oldChild)=0
Removes the child node indicated by oldChild from the list of children, and returns it...
virtual void setData(const XalanDOMString &data)=0
Sets the content of this processing instruction.
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
virtual NodeType getNodeType() const =0
An enum value representing the type of the underlying object.
NodeType
Definition: XalanNode.hpp:53
virtual const XalanNamedNodeMap * getAttributes() const =0
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise...
void setIndex(IndexType theIndex)
Definition: XalanSourceTreeProcessingInstruction.hpp:492
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
virtual bool hasChildNodes() const =0
This is a convenience method to allow easy determination of whether a node has any children...
virtual void setNodeValue(const XalanDOMString &nodeValue)=0
Sets the value of the node.
virtual const XalanDOMString & getNodeName() const =0
virtual XalanNode * appendChild(XalanNode *newChild)=0
Adds the node newChild to the end of the list of children of this node.
virtual IndexType getIndex() const =0
Get the node's index.
XalanProcessingInstruction & operator=(const XalanProcessingInstruction &theSource)
Definition: XalanSourceTreeDocumentFragment.hpp:49
Definition: XalanProcessingInstruction.hpp:38
#define XALAN_XALANSOURCETREE_EXPORT
Definition: XalanSourceTreeDefinitions.hpp:33
Definition: XalanNamedNodeMap.hpp:42
virtual XalanNode * getParentNode() const =0
Gets the parent of this node.
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
virtual void normalize()=0
Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes...
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: XalanSourceTreeText.hpp:44
Definition: XalanDocument.hpp:51
virtual const XalanDOMString & getLocalName() const =0
Returns the local part of the qualified name of this node.
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 const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node, or null if it is unspecified.
Definition: XalanDOMString.hpp:42
virtual XalanNode * cloneNode(bool deep) const =0
Returns a duplicate of this node.
virtual void setPrefix(const XalanDOMString &prefix)=0
Set the namespace prefix of this node.
unsigned long IndexType
Definition: XalanNode.hpp:70
Definition: XalanSourceTreeDocument.hpp:73
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node, or null if it is unspecified.
bool operator==(const XalanProcessingInstruction &theRHS) const
Definition: XalanSourceTreeElement.hpp:44
virtual XalanNode * getLastChild() const =0
Gets the last child of this node.
Definition: XalanSourceTreeProcessingInstruction.hpp:45
Definition: XalanSourceTreeComment.hpp:53

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