Xalan-C++ API Reference  1.12.0
XalanSourceTreeProcessingInstruction.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680)
19 #define XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680
20 
21 
22 
24 
25 
26 
28 
29 
30 
32 
33 
34 
35 namespace XALAN_CPP_NAMESPACE {
36 
37 
38 
39 class XalanSourceTreeComment;
40 class XalanSourceTreeDocument;
41 class XalanSourceTreeDocumentFragment;
42 class XalanSourceTreeElement;
43 class XalanSourceTreeText;
44 
45 
46 
48 {
49 public:
50 
51  /**
52  * Create an instance.
53  *
54  * @param theTarget The target for the processing instruction.
55  * @param theData The data for the node
56  * @param theOwnerDocument The document that owns the instance.
57  * @param theParentNode The parent node, if any.
58  * @param thePreviousSibling The next sibling, if any.
59  * @param theNextSibling The next sibling, if any.
60  * @param theIndex The document-order index of the node.
61  *
62  * @return pointer to the instance
63  */
65  const XalanDOMString& theTarget,
66  const XalanDOMString& theData,
67  XalanSourceTreeDocument* theOwnerDocument,
68  XalanNode* theParentNode = 0,
69  XalanNode* thePreviousSibling = 0,
70  XalanNode* theNextSibling = 0,
71  IndexType theIndex = 0);
72 
73  virtual
75 
76 
77  // These interfaces are inherited from XalanProcessingInstruction...
78 
79  virtual const XalanDOMString&
80  getNodeName() const;
81 
82  virtual const XalanDOMString&
83  getNodeValue() const;
84 
85  virtual NodeType
86  getNodeType() const;
87 
88  virtual XalanNode*
89  getParentNode() const;
90 
91  virtual const XalanNodeList*
92  getChildNodes() const;
93 
94  virtual XalanNode*
95  getFirstChild() const;
96 
97  virtual XalanNode*
98  getLastChild() const;
99 
100  virtual XalanNode*
102 
103  virtual XalanNode*
104  getNextSibling() const;
105 
106  virtual const XalanNamedNodeMap*
107  getAttributes() const;
108 
109  virtual XalanDocument*
111 
112  virtual const XalanDOMString&
114 
115  virtual const XalanDOMString&
116  getPrefix() const;
117 
118  virtual const XalanDOMString&
119  getLocalName() const;
120 
121  virtual bool
122  isIndexed() const;
123 
124  virtual IndexType
125  getIndex() const;
126 
127  virtual const XalanDOMString&
128  getTarget() const;
129 
130  virtual const XalanDOMString&
131  getData() const;
132 
133 
134  // public interfaces not inherited from XalanProcessingInstruction...
135 
136  void
138 
139  void
141 
142  void
144 
145  void
147 
148  void
150 
151  void
153 
154  void
156 
157  void
159 
160  void
162 
163  void
165 
166  void
167  setIndex(IndexType theIndex)
168  {
169  m_index = theIndex;
170  }
171 
172 private:
173 
174  // Not implemented...
176  const XalanSourceTreeProcessingInstruction& theSource);
177 
179  operator=(const XalanSourceTreeProcessingInstruction& theSource);
180 
181  bool
183 
184 
185  // Data members...
186  const XalanDOMString& m_target;
187 
188  const XalanDOMString& m_data;
189 
190  XalanSourceTreeDocument* m_ownerDocument;
191 
192  XalanNode* m_parentNode;
193 
194  XalanNode* m_previousSibling;
195 
196  XalanNode* m_nextSibling;
197 
198  IndexType m_index;
199 };
200 
201 
202 
203 }
204 
205 
206 
207 #endif // !defined(XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680)
#define XALAN_XALANSOURCETREE_EXPORT
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
unsigned long IndexType
Definition: XalanNode.hpp:64
void setPreviousSibling(XalanSourceTreeProcessingInstruction *thePreviousSibling)
void setPreviousSibling(XalanSourceTreeComment *thePreviousSibling)
void appendSiblingNode(XalanSourceTreeProcessingInstruction *theSibling)
virtual XalanNode * getNextSibling() const
Gets the node immediately following this node.
virtual XalanNode * getLastChild() const
Gets the last child of this node.
void setPreviousSibling(XalanSourceTreeText *thePreviousSibling)
virtual IndexType getIndex() const
Get the node's index.
virtual const XalanDOMString & getNodeValue() const
Gets the value of this node, depending on its type.
void appendSiblingNode(XalanSourceTreeComment *theSibling)
virtual XalanNode * getFirstChild() const
Gets the first child of this node.
virtual const XalanDOMString & getNodeName() const
Gets the name of this node, depending on its type.
virtual NodeType getNodeType() const
An enum value representing the type of the underlying object.
void appendSiblingNode(XalanSourceTreeText *theSibling)
virtual const XalanNamedNodeMap * getAttributes() const
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
virtual XalanDocument * getOwnerDocument() const
Gets the Document object associated with this node.
virtual const XalanDOMString & getNamespaceURI() const
Get the namespace URI of this node, or null if it is unspecified.
virtual const XalanDOMString & getData() const
The content of this processing instruction.
virtual const XalanDOMString & getTarget() const
The target of this processing instruction.
virtual XalanNode * getParentNode() const
Gets the parent of this node.
virtual const XalanDOMString & getPrefix() const
Get the namespace prefix of this node, or null if it is unspecified.
void setParent(XalanSourceTreeDocumentFragment *theParent)
void setPreviousSibling(XalanSourceTreeElement *thePreviousSibling)
void setParent(XalanSourceTreeElement *theParent)
XalanSourceTreeProcessingInstruction(const XalanDOMString &theTarget, const XalanDOMString &theData, XalanSourceTreeDocument *theOwnerDocument, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, IndexType theIndex=0)
Create an instance.
void appendSiblingNode(XalanSourceTreeElement *theSibling)
virtual bool isIndexed() const
Determine if the document is node-order indexed.
virtual const XalanNodeList * getChildNodes() const
Gets a NodeList that contains all children of this node.
virtual const XalanDOMString & getLocalName() const
Returns the local part of the qualified name of this node.
virtual XalanNode * getPreviousSibling() const
Gets the node immediately preceding this node.
bool operator==(const XalanVector< Type > &theLHS, const XalanVector< Type > &theRHS)